WPILibC++  unspecified
frc::SensorBase Class Reference

Base class for all sensors. More...

#include <SensorBase.h>

Inheritance diagram for frc::SensorBase:
Collaboration diagram for frc::SensorBase:

Public Member Functions

 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 (llvm::StringRef 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, llvm::StringRef 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, llvm::StringRef 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, llvm::StringRef contextMessage, llvm::StringRef filename, llvm::StringRef function, int lineNumber) const
 Set the current error information associated with this sensor. More...
 
virtual void SetWPIError (llvm::StringRef errorMessage, Error::Code code, llvm::StringRef 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...
 

Static Public Member Functions

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, llvm::StringRef contextMessage, llvm::StringRef filename, llvm::StringRef function, int lineNumber)
 
static void SetGlobalWPIError (llvm::StringRef errorMessage, llvm::StringRef contextMessage, llvm::StringRef filename, llvm::StringRef function, int lineNumber)
 
static ErrorGetGlobalError ()
 Retrieve the current global error.
 

Static Public Attributes

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()
 

Additional Inherited Members

- Protected Attributes inherited from frc::ErrorBase
Error m_error
 
- Static Protected Attributes inherited from frc::ErrorBase
static std::mutex _globalErrorMutex
 
static Error _globalError
 

Detailed Description

Base class for all sensors.

Stores most recent status information as well as containing utility functions for checking channels and error processing.

Member Function Documentation

bool SensorBase::CheckAnalogInputChannel ( int  channel)
static

Check that the analog input number is value.

Verify that the analog input number is one of the legal channel numbers. Channel numbers are 0-based.

Returns
Analog channel is valid
bool SensorBase::CheckAnalogOutputChannel ( int  channel)
static

Check that the analog output number is valid.

Verify that the analog output number is one of the legal channel numbers. Channel numbers are 0-based.

Returns
Analog channel is valid
bool SensorBase::CheckDigitalChannel ( int  channel)
static

Check that the digital channel number is valid.

Verify that the channel number is one of the legal channel numbers. Channel numbers are 1-based.

Returns
Digital channel is valid
bool SensorBase::CheckPDPChannel ( int  channel)
static

Verify that the power distribution channel number is within limits.

Returns
PDP channel is valid
bool SensorBase::CheckPWMChannel ( int  channel)
static

Check that the digital channel number is valid.

Verify that the channel number is one of the legal channel numbers. Channel numbers are 1-based.

Returns
PWM channel is valid
bool SensorBase::CheckRelayChannel ( int  channel)
static

Check that the relay channel number is valid.

Verify that the channel number is one of the legal channel numbers. Channel numbers are 0-based.

Returns
Relay channel is valid
bool SensorBase::CheckSolenoidChannel ( int  channel)
static

Verify that the solenoid channel number is within limits.

Returns
Solenoid channel is valid
bool SensorBase::CheckSolenoidModule ( int  moduleNumber)
static

Check that the solenoid module number is valid.

Returns
Solenoid module is valid and present

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