Solenoid Class Reference

#include <Solenoid.h>

Inheritance diagram for Solenoid:

Collaboration diagram for Solenoid:

Public Member Functions
	Solenoid (UINT32 channel)
	Solenoid (UINT8 moduleNumber, UINT32 channel)
virtual	~Solenoid ()
virtual void	Set (bool on)
virtual bool	Get ()
void	ValueChanged (ITable *source, const std::string &key, EntryValue value, bool isNew)
void	UpdateTable ()
void	StartLiveWindowMode ()
void	StopLiveWindowMode ()
std::string	GetSmartDashboardType ()
void	InitTable (ITable *subTable)
ITable *	GetTable ()
Public Member Functions inherited from SolenoidBase
virtual	~SolenoidBase ()
UINT8	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 lineNumber) const
	Set error information associated with a C library call that set an error to the "errno" global variable.
virtual void	SetImaqError (int success, const char *contextMessage, const char *filename, const char *function, UINT32 lineNumber) const
	Set the current error information associated from the nivision Imaq API.
virtual void	SetError (Error::Code code, const char *contextMessage, const char *filename, const char *function, UINT32 lineNumber) const
	Set the current error information associated with this sensor.
virtual void	SetWPIError (const char *errorMessage, const char *contextMessage, const char *filename, const char *function, UINT32 lineNumber) const
	Set the current error information associated with this sensor.
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.

Additional Inherited Members
Static Public Member Functions inherited from SensorBase
static void	DeleteSingletons ()
static UINT32	GetDefaultAnalogModule ()
static UINT32	GetDefaultDigitalModule ()
static UINT32	GetDefaultSolenoidModule ()
static bool	CheckAnalogModule (UINT8 moduleNumber)
static bool	CheckDigitalModule (UINT8 moduleNumber)
static bool	CheckPWMModule (UINT8 moduleNumber)
static bool	CheckRelayModule (UINT8 moduleNumber)
static bool	CheckSolenoidModule (UINT8 moduleNumber)
static bool	CheckDigitalChannel (UINT32 channel)
static bool	CheckRelayChannel (UINT32 channel)
static bool	CheckPWMChannel (UINT32 channel)
static bool	CheckAnalogChannel (UINT32 channel)
static bool	CheckSolenoidChannel (UINT32 channel)
Static Public Attributes inherited from SensorBase
static const UINT32	kSystemClockTicksPerMicrosecond = 40
static const UINT32	kDigitalChannels = 14
static const UINT32	kAnalogChannels = 8
static const UINT32	kAnalogModules = 2
static const UINT32	kDigitalModules = 2
static const UINT32	kSolenoidChannels = 8
static const UINT32	kSolenoidModules = 2
static const UINT32	kPwmChannels = 10
static const UINT32	kRelayChannels = 8
static const UINT32	kChassisSlots = 8
Protected Member Functions inherited from SolenoidBase
	SolenoidBase (UINT8 moduleNumber)
void	Set (UINT8 value, UINT8 mask)
virtual void	InitSolenoid ()=0
Protected Attributes inherited from SolenoidBase
UINT32	m_moduleNumber
	Slot number where the module is plugged into the chassis.
Static Protected Attributes inherited from SolenoidBase
static Resource *	m_allocated = NULL

Detailed Description

Solenoid class for running high voltage Digital Output (9472 module).

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

Definition at line 21 of file Solenoid.h.

Constructor & Destructor Documentation

Solenoid::Solenoid ( UINT32  channel )

explicit

Constructor.

Parameters

channel

The channel on the solenoid module to control (1..8).

Definition at line 48 of file Solenoid.cpp.

Solenoid::Solenoid	(	UINT8	moduleNumber,
		UINT32	channel
	)

Constructor.

Parameters

moduleNumber	The solenoid module (1 or 2).
channel	The channel on the solenoid module to control (1..8).

Definition at line 61 of file Solenoid.cpp.

Solenoid::~Solenoid ( )

virtual

Destructor.

Definition at line 71 of file Solenoid.cpp.

Member Function Documentation

bool Solenoid::Get ( )

virtual

Read the current value of the solenoid.

Returns

The current value of the solenoid.

Definition at line 98 of file Solenoid.cpp.

std::string Solenoid::GetSmartDashboardType ( )

virtual

Returns

the string representation of the named data type that will be used by the smart dashboard for this sendable

Implements Sendable.

Definition at line 126 of file Solenoid.cpp.

ITable * Solenoid::GetTable ( )

virtual

Returns

the table that is currently associated with the sendable

Implements Sendable.

Definition at line 135 of file Solenoid.cpp.

void Solenoid::InitTable ( ITable *  subtable )

virtual

Initializes a table for this sendable object.

Parameters

subtable

The table to put the values in.

Implements Sendable.

Definition at line 130 of file Solenoid.cpp.

void Solenoid::Set ( bool  on )

virtual

Set the value of a solenoid.

Parameters

on	Turn the solenoid output off or on.

Definition at line 84 of file Solenoid.cpp.

void Solenoid::StartLiveWindowMode ( )

virtual

Start having this sendable object automatically respond to value changes reflect the value on the table.

Implements LiveWindowSendable.

Definition at line 116 of file Solenoid.cpp.

void Solenoid::StopLiveWindowMode ( )

virtual

Stop having this sendable object automatically respond to value changes.

Implements LiveWindowSendable.

Definition at line 121 of file Solenoid.cpp.

void Solenoid::UpdateTable ( )

virtual

Update the table for this sendable object with the latest values.

Implements LiveWindowSendable.

Definition at line 110 of file Solenoid.cpp.

void Solenoid::ValueChanged ( ITable *  source, const std::string &  key, EntryValue  value, bool  isNew  )

virtual

Called when a key-value pair is changed in a ITable WARNING: If a new key-value is put in this method value changed will immediatly be called which could lead to recursive code

Parameters

source	the table the key-value pair exists in
key	the key associated with the value that changed
value	the new value
isNew	true if the key did not previously exist in the table, otherwise it is false

Implements ITableListener.

Definition at line 106 of file Solenoid.cpp.

---

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

• Solenoid.h
• Solenoid.cpp