Now you can download a copy of these docs so you can use them offline! Download now
Public Member Functions |
Protected Member Functions |
Protected Attributes |
Static Protected Attributes
SolenoidBase Class Reference
#include <SolenoidBase.h>
Inheritance diagram for SolenoidBase:

Collaboration diagram for SolenoidBase:

Public Member Functions | |
| virtual | ~SolenoidBase () |
| UINT8 | GetAll () |
Protected Member Functions | |
| SolenoidBase (UINT8 moduleNumber) | |
| void | Set (UINT8 value, UINT8 mask) |
| virtual void | InitSolenoid ()=0 |
Protected Attributes | |
| UINT32 | m_moduleNumber |
| Slot number where the module is plugged into the chassis. | |
Static Protected Attributes | |
| static Resource * | m_allocated = NULL |
Detailed Description
SolenoidBase class is the common base class for the Solenoid and DoubleSolenoid classes.
Definition at line 18 of file SolenoidBase.h.
Constructor & Destructor Documentation
| SolenoidBase::~SolenoidBase | ( | ) | [virtual] |
Destructor.
Definition at line 40 of file SolenoidBase.cpp.
| SolenoidBase::SolenoidBase | ( | UINT8 | moduleNumber | ) | [explicit, protected] |
Constructor
- Parameters:
-
moduleNumber The solenoid module (1 or 2).
Definition at line 23 of file SolenoidBase.cpp.
Member Function Documentation
| UINT8 SolenoidBase::GetAll | ( | ) |
Read all 8 solenoids as a single byte
- Returns:
- The current value of all 8 solenoids on the module.
Definition at line 81 of file SolenoidBase.cpp.
| void SolenoidBase::Set | ( | UINT8 | value, | |
| UINT8 | 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 61 of file SolenoidBase.cpp.
The documentation for this class was generated from the following files:
Generated on Thu Jan 12 2012 22:35:37 for WPILibC++ by
1.7.1