WPILibC++  unspecified
frc::DoubleSolenoid Class Reference

DoubleSolenoid class for running 2 channels of high voltage Digital Output (PCM). More...

#include <DoubleSolenoid.h>

Inheritance diagram for frc::DoubleSolenoid:
Collaboration diagram for frc::DoubleSolenoid:

Public Types

enum  Value { kOff, kForward, kReverse }
 

Public Member Functions

 DoubleSolenoid (int forwardChannel, int reverseChannel)
 Constructor. More...
 
 DoubleSolenoid (int moduleNumber, int forwardChannel, int reverseChannel)
 Constructor. More...
 
virtual ~DoubleSolenoid ()
 Destructor.
 
virtual void Set (Value value)
 Set the value of a solenoid. More...
 
virtual Value Get () const
 Read the current value of the solenoid. More...
 
bool IsFwdSolenoidBlackListed () const
 Check if the forward solenoid is blacklisted. More...
 
bool IsRevSolenoidBlackListed () const
 Check if the reverse solenoid is blacklisted. 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< nt::NetworkTable > subTable)
 Initializes a table for this sendable object. More...
 
- Public Member Functions inherited from frc::SolenoidBase
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::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...
 

Additional Inherited Members

- Static Public Member Functions inherited from frc::SolenoidBase
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::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
 
- 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 std::mutex _globalErrorMutex
 
static Error _globalError
 

Detailed Description

DoubleSolenoid class for running 2 channels of high voltage Digital Output (PCM).

The DoubleSolenoid class is typically used for pneumatics solenoids that have two positions controlled by two separate channels.

Constructor & Destructor Documentation

DoubleSolenoid::DoubleSolenoid ( int  forwardChannel,
int  reverseChannel 
)
explicit

Constructor.

Uses the default PCM ID of 0.

Parameters
forwardChannelThe forward channel number on the PCM (0..7).
reverseChannelThe reverse channel number on the PCM (0..7).
DoubleSolenoid::DoubleSolenoid ( int  moduleNumber,
int  forwardChannel,
int  reverseChannel 
)

Constructor.

Parameters
moduleNumberThe CAN ID of the PCM.
forwardChannelThe forward channel on the PCM to control (0..7).
reverseChannelThe reverse channel on the PCM to control (0..7).

Member Function Documentation

DoubleSolenoid::Value DoubleSolenoid::Get ( ) const
virtual

Read the current value of the solenoid.

Returns
The current value of the solenoid.
std::string DoubleSolenoid::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.

void DoubleSolenoid::InitTable ( std::shared_ptr< nt::NetworkTable subtable)
virtual

Initializes a table for this sendable object.

Parameters
subtableThe table to put the values in.

Implements frc::Sendable.

bool DoubleSolenoid::IsFwdSolenoidBlackListed ( ) const

Check if the forward 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.
bool DoubleSolenoid::IsRevSolenoidBlackListed ( ) const

Check if the reverse 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 DoubleSolenoid::Set ( Value  value)
virtual

Set the value of a solenoid.

Parameters
valueThe value to set (Off, Forward or Reverse)

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