WPILibC++
unspecified
|
SolenoidBase class is the common base class for the Solenoid and DoubleSolenoid classes. More...
#include <SolenoidBase.h>
Public Member Functions | |
int | GetAll () const |
Read all 8 solenoids as a single byte. More... | |
int | GetPCMSolenoidBlackList () const |
Reads complete solenoid blacklist for all 8 solenoids as a single byte. More... | |
bool | GetPCMSolenoidVoltageStickyFault () const |
bool | GetPCMSolenoidVoltageFault () const |
void | ClearAllPCMStickyFaults () |
Clear ALL sticky faults inside PCM that Compressor is wired to. More... | |
![]() | |
SensorBase (const SensorBase &)=delete | |
SensorBase & | operator= (const SensorBase &)=delete |
![]() | |
ErrorBase (const ErrorBase &)=delete | |
ErrorBase & | operator= (const ErrorBase &)=delete |
virtual Error & | GetError () |
Retrieve the current error. More... | |
virtual const Error & | GetError () 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 | GetAll (int module) |
Read all 8 solenoids as a single byte. More... | |
static int | GetPCMSolenoidBlackList (int module) |
Reads complete solenoid blacklist for all 8 solenoids as a single byte. More... | |
static bool | GetPCMSolenoidVoltageStickyFault (int module) |
static bool | GetPCMSolenoidVoltageFault (int module) |
static void | ClearAllPCMStickyFaults (int module) |
Clear ALL sticky faults inside PCM that Compressor is wired to. More... | |
![]() | |
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 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 Error & | GetGlobalError () |
Retrieve the current global error. | |
Protected Member Functions | |
SolenoidBase (int pcmID) | |
Constructor. More... | |
Protected Attributes | |
int | m_moduleNumber |
![]() | |
Error | m_error |
Static Protected Attributes | |
static const int | m_maxModules = 63 |
static const int | m_maxPorts = 8 |
![]() | |
static hal::priority_mutex | _globalErrorMutex |
static Error | _globalError |
Additional Inherited Members | |
![]() | |
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() |
SolenoidBase class is the common base class for the Solenoid and DoubleSolenoid classes.
|
explicitprotected |
Constructor.
moduleNumber | The CAN PCM ID. |
|
static |
Clear ALL sticky faults inside PCM that Compressor is wired to.
If a sticky fault is set, then it will be persistently cleared. Compressor drive maybe momentarily disable while flags are being cleared. Care should be taken to not call this too frequently, otherwise normal compressor functionality may be prevented.
If no sticky faults are set then this call will have no effect.
module | the module to read from |
void SolenoidBase::ClearAllPCMStickyFaults | ( | ) |
Clear ALL sticky faults inside PCM that Compressor is wired to.
If a sticky fault is set, then it will be persistently cleared. Compressor drive maybe momentarily disable while flags are being cleared. Care should be taken to not call this too frequently, otherwise normal compressor functionality may be prevented.
If no sticky faults are set then this call will have no effect.
|
static |
Read all 8 solenoids as a single byte.
module | the module to read from |
int SolenoidBase::GetAll | ( | ) | const |
Read all 8 solenoids as a single byte.
|
static |
Reads complete solenoid blacklist for all 8 solenoids as a single byte.
If a solenoid is shorted, it is added to the blacklist and disabled until power cycle, or until faults are cleared.
module | the module to read from |
int SolenoidBase::GetPCMSolenoidBlackList | ( | ) | const |
Reads complete solenoid blacklist for all 8 solenoids as a single byte.
If a solenoid is shorted, it is added to the blacklist and disabled until power cycle, or until faults are cleared.
|
static |
module | the module to read from |
bool SolenoidBase::GetPCMSolenoidVoltageFault | ( | ) | const |
|
static |
module | the module to read from |
bool SolenoidBase::GetPCMSolenoidVoltageStickyFault | ( | ) | const |