Solenoid Class Reference

#include <Solenoid.h>

Inheritance diagram for Solenoid:

Inheritance graph
[legend]
Collaboration diagram for Solenoid:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 Solenoid (unsigned channel)
 Solenoid (unsigned slot, unsigned channel)
 ~Solenoid ()
void Set (bool on)
bool Get (void)

Protected Member Functions

unsigned SlotToIndex (unsigned slot)


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.


Constructor & Destructor Documentation

Solenoid::Solenoid ( unsigned  channel  ) 

Constructor.

Parameters:
channel The channel on the module to control.

Solenoid::Solenoid ( unsigned  slot,
unsigned  channel 
)

Constructor.

Parameters:
slot The slot that the 9472 module is plugged into.
channel The channel on the module to control.

Solenoid::~Solenoid (  ) 

Destructor.


Member Function Documentation

void Solenoid::Set ( bool  on  ) 

Set the value of a solenoid.

Parameters:
on Turn the solenoid output off or on.

bool Solenoid::Get ( void   ) 

Read the current value of the solenoid.

Returns:
The current value of the solenoid.

unsigned Solenoid::SlotToIndex ( unsigned  slot  )  [protected]

Convert slot number to index.

Parameters:
slot The slot in the chassis where the module is plugged in.
Returns:
An index to represent the module internally.


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

Generated on Thu Oct 2 14:01:33 2008 for WPI Robotics Library by  doxygen 1.5.5