SolenoidBase Class Reference

#include <SolenoidBase.h>

Inheritance diagram for SolenoidBase:

Collaboration diagram for SolenoidBase:

Public Member Functions
virtual	~SolenoidBase ()
uint8_t	GetAll ()
Public Member Functions inherited from SensorBase
	SensorBase ()
virtual	~SensorBase ()
Public Member Functions inherited from ErrorBase
virtual Error &	GetError ()
	Retrieve the current error. Get the current error information associated with this sensor.
virtual const Error &	GetError () const
virtual void	SetErrnoError (const char *contextMessage, const char *filename, const char *function, uint32_t 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 char *contextMessage, const char *filename, const char *function, uint32_t lineNumber) const
	Set the current error information associated from the nivision Imaq API. More...
virtual void	SetError (Error::Code code, const char *contextMessage, const char *filename, const char *function, uint32_t lineNumber) const
	Set the current error information associated with this sensor. More...
virtual void	SetWPIError (const char *errorMessage, const char *contextMessage, const char *filename, const char *function, uint32_t lineNumber) const
	Set the current error information associated with this sensor. More...
virtual void	CloneError (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...

Protected Member Functions
	SolenoidBase (uint8_t moduleNumber)
void	Set (uint8_t value, uint8_t mask)
virtual void	InitSolenoid ()=0
Protected Member Functions inherited from SensorBase
void	AddToSingletonList ()
Protected Member Functions inherited from ErrorBase
	ErrorBase ()
	Initialize the instance status to 0 for now.

Protected Attributes
uint32_t	m_moduleNumber
	Slot number where the module is plugged into the chassis.
Protected Attributes inherited from ErrorBase
Error	m_error

Static Protected Attributes
static Resource *	m_allocated = NULL
Static Protected Attributes inherited from ErrorBase
static SEM_ID	_globalErrorMutex = semMCreate(SEM_Q_PRIORITY | SEM_DELETE_SAFE | SEM_INVERSION_SAFE)
static Error	_globalError

Additional Inherited Members
Static Public Member Functions inherited from SensorBase
static void	DeleteSingletons ()
static uint32_t	GetDefaultAnalogModule ()
static uint32_t	GetDefaultDigitalModule ()
static uint32_t	GetDefaultSolenoidModule ()
static bool	CheckAnalogModule (uint8_t moduleNumber)
static bool	CheckDigitalModule (uint8_t moduleNumber)
static bool	CheckPWMModule (uint8_t moduleNumber)
static bool	CheckRelayModule (uint8_t moduleNumber)
static bool	CheckSolenoidModule (uint8_t moduleNumber)
static bool	CheckDigitalChannel (uint32_t channel)
static bool	CheckRelayChannel (uint32_t channel)
static bool	CheckPWMChannel (uint32_t channel)
static bool	CheckAnalogChannel (uint32_t channel)
static bool	CheckSolenoidChannel (uint32_t channel)
Static Public Member Functions inherited from ErrorBase
static void	SetGlobalError (Error::Code code, const char *contextMessage, const char *filename, const char *function, uint32_t lineNumber)
static void	SetGlobalWPIError (const char *errorMessage, const char *contextMessage, const char *filename, const char *function, uint32_t lineNumber)
static Error &	GetGlobalError ()
Static Public Attributes inherited from SensorBase
static const uint32_t	kSystemClockTicksPerMicrosecond = 40
static const uint32_t	kDigitalChannels = 14
static const uint32_t	kAnalogChannels = 8
static const uint32_t	kAnalogModules = 2
static const uint32_t	kDigitalModules = 2
static const uint32_t	kSolenoidChannels = 8
static const uint32_t	kSolenoidModules = 2
static const uint32_t	kPwmChannels = 10
static const uint32_t	kRelayChannels = 8
static const uint32_t	kChassisSlots = 8

Detailed Description

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

Definition at line 19 of file SolenoidBase.h.

Constructor & Destructor Documentation

SolenoidBase::~SolenoidBase ( )

virtual

Destructor.

Definition at line 38 of file SolenoidBase.cpp.

SolenoidBase::SolenoidBase ( uint8_t  moduleNumber )

explicitprotected

Constructor

Parameters

moduleNumber

The solenoid module (1 or 2).

Definition at line 22 of file SolenoidBase.cpp.

Member Function Documentation

uint8_t SolenoidBase::GetAll

(

)

Read all 8 solenoids as a single byte

Returns

The current value of all 8 solenoids on the module.

Definition at line 78 of file SolenoidBase.cpp.

void SolenoidBase::Set ( uint8_t  value, uint8_t  mask  )

protected

Set the value of a solenoid.

Parameters

value	The value you want to set on the module.
mask	The channels you want to be affected.

Definition at line 58 of file SolenoidBase.cpp.

---

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

• SolenoidBase.h
• SolenoidBase.cpp