wpi::DigitalInput Class Reference

Class to read a digital input. More...

#include <wpi/hardware/discrete/DigitalInput.hpp>

Inheritance diagram for wpi::DigitalInput:

Public Member Functions
	DigitalInput (int channel)
	Create an instance of a Digital Input class.
	DigitalInput (DigitalInput &&)=default
DigitalInput &	operator= (DigitalInput &&)=default
	~DigitalInput () override=default
bool	Get () const
	Get the value from a digital input channel.
int	GetChannel () const
void	SetSimDevice (HAL_SimDeviceHandle device)
	Indicates this input is used by a simulated device.
void	InitSendable (wpi::util::SendableBuilder &builder) override
	Initializes this Sendable object.
Public Member Functions inherited from wpi::util::Sendable
virtual constexpr	~Sendable ()=default
Public Member Functions inherited from wpi::util::SendableHelper< DigitalInput >
constexpr	SendableHelper (const SendableHelper &rhs)=default
constexpr SendableHelper &	operator= (const SendableHelper &rhs)=default

Additional Inherited Members
Protected Member Functions inherited from wpi::util::SendableHelper< DigitalInput >
constexpr	~SendableHelper ()

Detailed Description

Class to read a digital input.

This class will read digital inputs and return the current value on the channel. Other devices such as encoders, gear tooth sensors, etc. that are implemented elsewhere will automatically allocate digital inputs and outputs as required. This class is only for devices like switches etc. that aren't implemented anywhere else.

Constructor & Destructor Documentation

DigitalInput() [1/2]

wpi::DigitalInput::DigitalInput ( int channel )

explicit

Create an instance of a Digital Input class.

Creates a digital input given a channel.

Parameters

channel

The DIO channel 0-9 are on-board, 10-25 are on the MXP port

DigitalInput() [2/2]

wpi::DigitalInput::DigitalInput ( DigitalInput && )

default

~DigitalInput()

wpi::DigitalInput::~DigitalInput ( )

overridedefault

Member Function Documentation

Get()

bool wpi::DigitalInput::Get

(

)

const

Get the value from a digital input channel.

Retrieve the value of a single digital input channel from the FPGA.

GetChannel()

int wpi::DigitalInput::GetChannel

(

)

const

Returns

The GPIO channel number that this object represents.

InitSendable()

void wpi::DigitalInput::InitSendable ( wpi::util::SendableBuilder & builder )

overridevirtual

Initializes this Sendable object.

Parameters

builder

sendable builder

Implements wpi::util::Sendable.

operator=()

DigitalInput & wpi::DigitalInput::operator= ( DigitalInput && )

default

SetSimDevice()

void wpi::DigitalInput::SetSimDevice

(

HAL_SimDeviceHandle

device

)

Indicates this input is used by a simulated device.

Parameters

device

simulated device handle

---

The documentation for this class was generated from the following file:

• wpi/hardware/discrete/DigitalInput.hpp