WPILib 2012
WPILibRoboticsLibraryforFRC
Public Member Functions
Solenoid Class Reference

#include <Solenoid.h>

Inheritance diagram for Solenoid:
SolenoidBase SensorBase ErrorBase

List of all members.

Public Member Functions

 Solenoid (UINT32 channel)
 Solenoid (UINT8 moduleNumber, UINT32 channel)
virtual ~Solenoid ()
virtual void Set (bool on)
virtual bool Get ()

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 ( UINT32  channel) [explicit]

Constructor.

Parameters:
channelThe channel on the solenoid module to control (1..8).
Solenoid::Solenoid ( UINT8  moduleNumber,
UINT32  channel 
)

Constructor.

Parameters:
moduleNumberThe solenoid module (1 or 2).
channelThe channel on the solenoid module to control (1..8).
Solenoid::~Solenoid ( ) [virtual]

Destructor.


Member Function Documentation

bool Solenoid::Get ( ) [virtual]

Read the current value of the solenoid.

Returns:
The current value of the solenoid.
void Solenoid::Set ( bool  on) [virtual]

Set the value of a solenoid.

Parameters:
onTurn the solenoid output off or on.

The documentation for this class was generated from the following files:
 All Classes Functions Variables