WPILibC++  unspecified
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Pages
frc::Solenoid Class Reference

Solenoid class for running high voltage Digital Output (PCM). More...

#include <Solenoid.h>

Inheritance diagram for frc::Solenoid:
frc::SolenoidBase frc::LiveWindowSendable ITableListener frc::SensorBase frc::Sendable frc::ErrorBase

Public Member Functions

 Solenoid (int channel)
 Constructor using the default PCM ID (0). More...
 
 Solenoid (int moduleNumber, int channel)
 Constructor. More...
 
virtual ~Solenoid ()
 Destructor.
 
virtual void Set (bool on)
 Set the value of a solenoid. More...
 
virtual bool Get () const
 Read the current value of the solenoid. More...
 
bool IsBlackListed () const
 Check if solenoid is blacklisted. More...
 
void ValueChanged (ITable *source, llvm::StringRef key, std::shared_ptr< nt::Value > value, bool isNew)
 Called when a key-value pair is changed in a ITable. More...
 
void UpdateTable ()
 Update the table for this sendable object with the latest values.
 
void StartLiveWindowMode ()
 Start having this sendable object automatically respond to value changes reflect the value on the table.
 
void StopLiveWindowMode ()
 Stop having this sendable object automatically respond to value changes.
 
std::string GetSmartDashboardType () const
 
void InitTable (std::shared_ptr< ITable > subTable)
 Initializes a table for this sendable object. More...
 
std::shared_ptr< ITableGetTable () const
 
- Public Member Functions inherited from frc::SolenoidBase
int GetAll (int module=0) const
 Read all 8 solenoids as a single byte. More...
 
int GetPCMSolenoidBlackList (int module) const
 Reads complete solenoid blacklist for all 8 solenoids as a single byte. More...
 
bool GetPCMSolenoidVoltageStickyFault (int module) const
 
bool GetPCMSolenoidVoltageFault (int module) const
 
void ClearAllPCMStickyFaults (int module)
 Clear ALL sticky faults inside PCM that Compressor is wired to. 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 (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...
 
- Public Member Functions inherited from ITableListener
virtual void ValueChangedEx (ITable *source, llvm::StringRef key, std::shared_ptr< nt::Value > value, unsigned int flags)
 Extended version of ValueChanged. More...
 

Additional Inherited Members

- 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, 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 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::SolenoidBase
 SolenoidBase (int pcmID)
 Constructor. More...
 
- Protected Attributes inherited from frc::SolenoidBase
int m_moduleNumber
 Slot number where the module is plugged into the chassis. More...
 
- Protected Attributes inherited from frc::ErrorBase
Error m_error
 
- Static Protected Attributes inherited from frc::SolenoidBase
static const int m_maxModules = 63
 
static const int m_maxPorts = 8
 
- Static Protected Attributes inherited from frc::ErrorBase
static priority_mutex _globalErrorMutex
 
static Error _globalError
 

Detailed Description

Solenoid class for running high voltage Digital Output (PCM).

The Solenoid class is typically used for pneumatics solenoids, but could be used for any device within the current spec of the PCM.

Constructor & Destructor Documentation

Solenoid::Solenoid ( int  channel)
explicit

Constructor using the default PCM ID (0).

Parameters
channelThe channel on the PCM to control (0..7).
Solenoid::Solenoid ( int  moduleNumber,
int  channel 
)

Constructor.

Parameters
moduleNumberThe CAN ID of the PCM the solenoid is attached to
channelThe channel on the PCM to control (0..7).

Member Function Documentation

bool Solenoid::Get ( ) const
virtual

Read the current value of the solenoid.

Returns
The current value of the solenoid.
std::string Solenoid::GetSmartDashboardType ( ) const
virtual
Returns
the string representation of the named data type that will be used by the smart dashboard for this sendable

Implements frc::Sendable.

std::shared_ptr< ITable > Solenoid::GetTable ( ) const
virtual
Returns
the table that is currently associated with the sendable

Implements frc::Sendable.

void Solenoid::InitTable ( std::shared_ptr< ITable subtable)
virtual

Initializes a table for this sendable object.

Parameters
subtableThe table to put the values in.

Implements frc::Sendable.

bool Solenoid::IsBlackListed ( ) const

Check if solenoid is blacklisted.

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
If solenoid is disabled due to short.
void Solenoid::Set ( bool  on)
virtual

Set the value of a solenoid.

Parameters
onTurn the solenoid output off or on.
void Solenoid::ValueChanged ( ITable source,
llvm::StringRef  key,
std::shared_ptr< nt::Value value,
bool  isNew 
)
virtual

Called when a key-value pair is changed in a ITable.

Parameters
sourcethe table the key-value pair exists in
keythe key associated with the value that changed
valuethe new value
isNewtrue if the key did not previously exist in the table, otherwise it is false

Implements ITableListener.


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