Now you can download a copy of these docs so you can use them offline! Download now

DoubleSolenoid Class Reference

#include <DoubleSolenoid.h>

Inheritance diagram for DoubleSolenoid:
Collaboration diagram for DoubleSolenoid:

List of all members.

Public Types

enum  Value { kOff, kForward, kReverse }

Public Member Functions

 DoubleSolenoid (UINT32 forwardChannel, UINT32 reverseChannel)
 DoubleSolenoid (UINT8 moduleNumber, UINT32 forwardChannel, UINT32 reverseChannel)
virtual ~DoubleSolenoid ()
virtual void Set (Value value)
virtual Value Get ()

Detailed Description

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

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

Definition at line 19 of file DoubleSolenoid.h.


Constructor & Destructor Documentation

DoubleSolenoid::DoubleSolenoid ( UINT32  forwardChannel,
UINT32  reverseChannel 
) [explicit]

Constructor.

Parameters:
forwardChannel The forward channel on the module to control.
reverseChannel The reverse channel on the module to control.

Definition at line 58 of file DoubleSolenoid.cpp.

DoubleSolenoid::DoubleSolenoid ( UINT8  moduleNumber,
UINT32  forwardChannel,
UINT32  reverseChannel 
)

Constructor.

Parameters:
moduleNumber The solenoid module (1 or 2).
forwardChannel The forward channel on the module to control.
reverseChannel The reverse channel on the module to control.

Definition at line 73 of file DoubleSolenoid.cpp.

DoubleSolenoid::~DoubleSolenoid (  )  [virtual]

Destructor.

Definition at line 84 of file DoubleSolenoid.cpp.


Member Function Documentation

DoubleSolenoid::Value DoubleSolenoid::Get (  )  [virtual]

Read the current value of the solenoid.

Returns:
The current value of the solenoid.

Definition at line 124 of file DoubleSolenoid.cpp.

void DoubleSolenoid::Set ( Value  value  )  [virtual]

Set the value of a solenoid.

Parameters:
value Move the solenoid to forward, reverse, or don't move it.

Definition at line 98 of file DoubleSolenoid.cpp.


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

Generated on Thu Jan 12 2012 22:35:30 for WPILibC++ by doxygen 1.7.1