WPILibC++  unspecified
frc::DigitalInput Class Reference

Class to read a digital input. More...

#include <DigitalInput.h>

Inheritance diagram for frc::DigitalInput:
Collaboration diagram for frc::DigitalInput:

Public Member Functions

 DigitalInput (int channel)
 Create an instance of a Digital Input class. More...
 
 ~DigitalInput () override
 Free resources associated with the Digital Input class.
 
bool Get () const
 Get the value from a digital input channel. More...
 
int GetChannel () const override
 
HAL_Handle GetPortHandleForRouting () const override
 
AnalogTriggerType GetAnalogTriggerTypeForRouting () const override
 
bool IsAnalogTrigger () const override
 Is source an AnalogTrigger.
 
void InitSendable (SendableBuilder &builder) override
 Initializes this Sendable object. More...
 
- Public Member Functions inherited from frc::InterruptableSensorBase
virtual void RequestInterrupts (HAL_InterruptHandlerFunction handler, void *param)
 Request one of the 8 interrupts asynchronously on this digital input. More...
 
virtual void RequestInterrupts ()
 Request one of the 8 interrupts synchronously on this digital input. More...
 
virtual void CancelInterrupts ()
 Cancel interrupts on this device. More...
 
virtual WaitResult WaitForInterrupt (double timeout, bool ignorePrevious=true)
 In synchronous mode, wait for the defined interrupt to occur. More...
 
virtual void EnableInterrupts ()
 Enable interrupts to occur on this input. More...
 
virtual void DisableInterrupts ()
 Disable Interrupts without without deallocating structures.
 
virtual double ReadRisingTimestamp ()
 Return the timestamp for the rising interrupt that occurred most recently. More...
 
virtual double ReadFallingTimestamp ()
 Return the timestamp for the falling interrupt that occurred most recently. More...
 
virtual void SetUpSourceEdge (bool risingEdge, bool fallingEdge)
 Set which edge to trigger interrupts on. More...
 
- Public Member Functions inherited from frc::SensorBase
 SensorBase (const SensorBase &)=delete
 
SensorBaseoperator= (const SensorBase &)=delete
 
- Public Member Functions inherited from frc::ErrorBase
 ErrorBase (const ErrorBase &)=delete
 
ErrorBaseoperator= (const ErrorBase &)=delete
 
virtual ErrorGetError ()
 Retrieve the current error. More...
 
virtual const ErrorGetError () const
 
virtual void SetErrnoError (const llvm::Twine &contextMessage, llvm::StringRef filename, llvm::StringRef function, int lineNumber) const
 Set error information associated with a C library call that set an error to the "errno" global variable. More...
 
virtual void SetImaqError (int success, const llvm::Twine &contextMessage, llvm::StringRef filename, llvm::StringRef function, int lineNumber) const
 Set the current error information associated from the nivision Imaq API. More...
 
virtual void SetError (Error::Code code, const llvm::Twine &contextMessage, llvm::StringRef filename, llvm::StringRef function, int lineNumber) const
 Set the current error information associated with this sensor. More...
 
virtual void SetErrorRange (Error::Code code, int32_t minRange, int32_t maxRange, int32_t requestedValue, const llvm::Twine &contextMessage, llvm::StringRef filename, llvm::StringRef function, int lineNumber) const
 Set the current error information associated with this sensor. More...
 
virtual void SetWPIError (const llvm::Twine &errorMessage, Error::Code code, const llvm::Twine &contextMessage, llvm::StringRef filename, llvm::StringRef function, int lineNumber) const
 Set the current error information associated with this sensor. More...
 
virtual void CloneError (const ErrorBase &rhs) const
 
virtual void ClearError () const
 Clear the current error information associated with this sensor.
 
virtual bool StatusIsFatal () const
 Check if the current error code represents a fatal error. More...
 
- Public Member Functions inherited from frc::SendableBase
 SendableBase (bool addLiveWindow=true)
 Creates an instance of the sensor base. More...
 
 ~SendableBase () override
 Free the resources used by this object.
 
std::string GetName () const final
 Gets the name of this Sendable object. More...
 
void SetName (const llvm::Twine &name) final
 Sets the name of this Sendable object. More...
 
std::string GetSubsystem () const final
 Gets the subsystem name of this Sendable object. More...
 
void SetSubsystem (const llvm::Twine &subsystem) final
 Sets the subsystem name of this Sendable object. More...
 
- Public Member Functions inherited from frc::Sendable
void SetName (const llvm::Twine &subsystem, const llvm::Twine &name)
 Sets both the subsystem name and device name of this Sendable object. More...
 

Friends

class DigitalGlitchFilter
 

Additional Inherited Members

- Public Types inherited from frc::InterruptableSensorBase
enum  WaitResult { kTimeout = 0x0, kRisingEdge = 0x1, kFallingEdge = 0x100, kBoth = 0x101 }
 
- Static Public Member Functions inherited from frc::SensorBase
static int GetDefaultSolenoidModule ()
 
static bool CheckSolenoidModule (int moduleNumber)
 Check that the solenoid module number is valid. More...
 
static bool CheckDigitalChannel (int channel)
 Check that the digital channel number is valid. More...
 
static bool CheckRelayChannel (int channel)
 Check that the relay channel number is valid. More...
 
static bool CheckPWMChannel (int channel)
 Check that the digital channel number is valid. More...
 
static bool CheckAnalogInputChannel (int channel)
 Check that the analog input number is value. More...
 
static bool CheckAnalogOutputChannel (int channel)
 Check that the analog output number is valid. More...
 
static bool CheckSolenoidChannel (int channel)
 Verify that the solenoid channel number is within limits. More...
 
static bool CheckPDPChannel (int channel)
 Verify that the power distribution channel number is within limits. More...
 
- Static Public Member Functions inherited from frc::ErrorBase
static void SetGlobalError (Error::Code code, const llvm::Twine &contextMessage, llvm::StringRef filename, llvm::StringRef function, int lineNumber)
 
static void SetGlobalWPIError (const llvm::Twine &errorMessage, const llvm::Twine &contextMessage, llvm::StringRef filename, llvm::StringRef function, int lineNumber)
 
static ErrorGetGlobalError ()
 Retrieve the current global error.
 
- Static Public Attributes inherited from frc::SensorBase
static const int kDigitalChannels = HAL_GetNumDigitalChannels()
 
static const int kAnalogInputs = HAL_GetNumAnalogInputs()
 
static const int kAnalogOutputs
 
static const int kSolenoidChannels = HAL_GetNumSolenoidChannels()
 
static const int kSolenoidModules = HAL_GetNumPCMModules()
 
static const int kPwmChannels = HAL_GetNumPWMChannels()
 
static const int kRelayChannels = HAL_GetNumRelayHeaders()
 
static const int kPDPChannels = HAL_GetNumPDPChannels()
 
- Protected Member Functions inherited from frc::InterruptableSensorBase
void AllocateInterrupts (bool watcher)
 
- Protected Member Functions inherited from frc::SendableBase
void AddChild (std::shared_ptr< Sendable > child)
 Add a child component. More...
 
void AddChild (void *child)
 Add a child component. More...
 
void SetName (const llvm::Twine &moduleType, int channel)
 Sets the name of the sensor with a channel number. More...
 
void SetName (const llvm::Twine &moduleType, int moduleNumber, int channel)
 Sets the name of the sensor with a module and channel number. More...
 
- Protected Attributes inherited from frc::InterruptableSensorBase
HAL_InterruptHandle m_interrupt = HAL_kInvalidHandle
 
- Protected Attributes inherited from frc::ErrorBase
Error m_error
 
- Static Protected Attributes inherited from frc::ErrorBase
static wpi::mutex _globalErrorMutex
 
static Error _globalError
 

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::DigitalInput ( int  channel)
explicit

Create an instance of a Digital Input class.

Creates a digital input given a channel.

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

Member Function Documentation

bool DigitalInput::Get ( ) const

Get the value from a digital input channel.

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

AnalogTriggerType DigitalInput::GetAnalogTriggerTypeForRouting ( ) const
overridevirtual
Returns
The type of analog trigger output to be used. 0 for Digitals

Implements frc::DigitalSource.

int DigitalInput::GetChannel ( ) const
overridevirtual
Returns
The GPIO channel number that this object represents.

Implements frc::DigitalSource.

HAL_Handle DigitalInput::GetPortHandleForRouting ( ) const
overridevirtual
Returns
The HAL Handle to the specified source.

Implements frc::DigitalSource.

void DigitalInput::InitSendable ( SendableBuilder builder)
overridevirtual

Initializes this Sendable object.

Parameters
buildersendable builder

Implements frc::Sendable.


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