WPILibC++  2019.3.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
frc::SolenoidBase Class Reference

SolenoidBase class is the common base class for the Solenoid and DoubleSolenoid classes. More...

#include <SolenoidBase.h>

Inheritance diagram for frc::SolenoidBase:
frc::ErrorBase frc::SendableBase frc::Sendable frc::DoubleSolenoid frc::Solenoid

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...
 
- Public Member Functions inherited from frc::ErrorBase
 ErrorBase (ErrorBase &&)=default
 
ErrorBaseoperator= (ErrorBase &&)=default
 
virtual ErrorGetError ()
 Retrieve the current error. More...
 
virtual const ErrorGetError () 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...
 
- Public Member Functions inherited from frc::SendableBase
 SendableBase (bool addLiveWindow=true)
 Creates an instance of the sensor base. More...
 
 SendableBase (SendableBase &&rhs)
 
SendableBaseoperator= (SendableBase &&rhs)
 
std::string GetName () const final
 Gets the name of this Sendable object. More...
 
void SetName (const wpi::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 wpi::Twine &subsystem) final
 Sets the subsystem name of this Sendable object. More...
 
- Public Member Functions inherited from frc::Sendable
 Sendable (Sendable &&)=default
 
Sendableoperator= (Sendable &&)=default
 
void SetName (const wpi::Twine &subsystem, const wpi::Twine &name)
 Sets both the subsystem name and device name of this Sendable object. More...
 
virtual void InitSendable (SendableBuilder &builder)=0
 Initializes this Sendable object. 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 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 const ErrorGetGlobalError ()
 Retrieve the current global error.
 

Protected Member Functions

 SolenoidBase (int pcmID)
 Constructor. More...
 
 SolenoidBase (SolenoidBase &&)=default
 
SolenoidBaseoperator= (SolenoidBase &&)=default
 
- 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 wpi::Twine &moduleType, int channel)
 Sets the name of the sensor with a channel number. More...
 
void SetName (const wpi::Twine &moduleType, int moduleNumber, int channel)
 Sets the name of the sensor with a module and channel number. More...
 

Protected Attributes

int m_moduleNumber
 
- Protected Attributes inherited from frc::ErrorBase
Error m_error
 

Static Protected Attributes

static constexpr int m_maxModules = 63
 
static constexpr int m_maxPorts = 8
 

Detailed Description

SolenoidBase class is the common base class for the Solenoid and DoubleSolenoid classes.

Constructor & Destructor Documentation

frc::SolenoidBase::SolenoidBase ( int  pcmID)
explicitprotected

Constructor.

Parameters
moduleNumberThe CAN PCM ID.

Member Function Documentation

static void frc::SolenoidBase::ClearAllPCMStickyFaults ( int  module)
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.

Parameters
modulethe module to read from
void frc::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 int frc::SolenoidBase::GetAll ( int  module)
static

Read all 8 solenoids as a single byte.

Parameters
modulethe module to read from
Returns
The current value of all 8 solenoids on the module.
int frc::SolenoidBase::GetAll ( ) const

Read all 8 solenoids as a single byte.

Returns
The current value of all 8 solenoids on the module.
static int frc::SolenoidBase::GetPCMSolenoidBlackList ( int  module)
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.

See also
ClearAllPCMStickyFaults()
Parameters
modulethe module to read from
Returns
The solenoid blacklist of all 8 solenoids on the module.
int frc::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.

See also
ClearAllPCMStickyFaults()
Returns
The solenoid blacklist of all 8 solenoids on the module.
static bool frc::SolenoidBase::GetPCMSolenoidVoltageFault ( int  module)
static
Parameters
modulethe module to read from
Returns
true if PCM is in fault state : The common highside solenoid voltage rail is too low, most likely a solenoid channel is shorted.
bool frc::SolenoidBase::GetPCMSolenoidVoltageFault ( ) const
Returns
true if PCM is in fault state : The common highside solenoid voltage rail is too low, most likely a solenoid channel is shorted.
static bool frc::SolenoidBase::GetPCMSolenoidVoltageStickyFault ( int  module)
static
Parameters
modulethe module to read from
Returns
true if PCM sticky fault is set : The common highside solenoid voltage rail is too low, most likely a solenoid channel is shorted.
bool frc::SolenoidBase::GetPCMSolenoidVoltageStickyFault ( ) const
Returns
true if PCM sticky fault is set : The common highside solenoid voltage rail is too low, most likely a solenoid channel is shorted.

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