|
WPILibC++
2020.3.2
|
DigitalSource Interface. More...
#include <DigitalSource.h>
Public Member Functions | |
| DigitalSource (DigitalSource &&)=default | |
| DigitalSource & | operator= (DigitalSource &&)=default |
| virtual HAL_Handle | GetPortHandleForRouting () const =0 |
| virtual AnalogTriggerType | GetAnalogTriggerTypeForRouting () const =0 |
| virtual bool | IsAnalogTrigger () const =0 |
| virtual int | GetChannel () const =0 |
Public Member Functions inherited from frc::InterruptableSensorBase | |
| virtual | ~InterruptableSensorBase () |
| Free the resources for an interrupt event. | |
| InterruptableSensorBase (InterruptableSensorBase &&)=default | |
| InterruptableSensorBase & | operator= (InterruptableSensorBase &&)=default |
| virtual void | RequestInterrupts (HAL_InterruptHandlerFunction handler, void *param) |
| Request one of the 8 interrupts asynchronously on this digital input. More... | |
| virtual void | RequestInterrupts (InterruptEventHandler handler) |
| 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::ErrorBase | |
| ErrorBase (const ErrorBase &)=default | |
| ErrorBase & | operator= (const ErrorBase &)=default |
| ErrorBase (ErrorBase &&)=default | |
| ErrorBase & | operator= (ErrorBase &&)=default |
| virtual Error & | GetError () |
| Retrieve the current error. More... | |
| virtual const Error & | GetError () const |
| Retrieve the current error. More... | |
| virtual void | ClearError () const |
| Clear the current error information associated with this sensor. | |
| virtual void | SetErrnoError (const wpi::Twine &contextMessage, wpi::StringRef filename, wpi::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 wpi::Twine &contextMessage, wpi::StringRef filename, wpi::StringRef function, int lineNumber) const |
| Set the current error information associated from the nivision Imaq API. More... | |
| virtual void | SetError (Error::Code code, const wpi::Twine &contextMessage, wpi::StringRef filename, wpi::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 wpi::Twine &contextMessage, wpi::StringRef filename, wpi::StringRef function, int lineNumber) const |
| Set the current error information associated with this sensor. More... | |
| virtual void | SetWPIError (const wpi::Twine &errorMessage, Error::Code code, const wpi::Twine &contextMessage, wpi::StringRef filename, wpi::StringRef function, int lineNumber) const |
| Set the current error information associated with this sensor. More... | |
| virtual void | CloneError (const ErrorBase &rhs) const |
| virtual bool | StatusIsFatal () const |
| Check if the current error code represents a fatal error. More... | |
| void | ClearGlobalErrors () |
| Clear global errors. | |
Additional Inherited Members | |
Public Types inherited from frc::InterruptableSensorBase | |
| enum | WaitResult { kTimeout = 0x0, kRisingEdge = 0x1, kFallingEdge = 0x100, kBoth = 0x101 } |
| using | InterruptEventHandler = std::function< void(WaitResult)> |
| Handler for interrupts. More... | |
Static Public Member Functions inherited from frc::ErrorBase | |
| static void | SetGlobalError (Error::Code code, const wpi::Twine &contextMessage, wpi::StringRef filename, wpi::StringRef function, int lineNumber) |
| static void | SetGlobalWPIError (const wpi::Twine &errorMessage, const wpi::Twine &contextMessage, wpi::StringRef filename, wpi::StringRef function, int lineNumber) |
| static Error | GetGlobalError () |
| Retrieve the last global error. | |
| static std::vector< Error > | GetGlobalErrors () |
| Retrieve all global errors. | |
Protected Member Functions inherited from frc::InterruptableSensorBase | |
| void | AllocateInterrupts (bool watcher) |
Protected Attributes inherited from frc::InterruptableSensorBase | |
| hal::Handle< HAL_InterruptHandle > | m_interrupt |
| std::unique_ptr< InterruptEventHandler > | m_interruptHandler {nullptr} |
Protected Attributes inherited from frc::ErrorBase | |
| Error | m_error |
DigitalSource Interface.
The DigitalSource represents all the possible inputs for a counter or a quadrature encoder. The source may be either a digital input or an analog input. If the caller just provides a channel, then a digital input will be constructed and freed when finished for the source. The source can either be a digital input or analog trigger but not both.