Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-06-23 01:21:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve C++ Compressor documentation based on Java's docs. (#607)

Browse Source
This commit is contained in:
sciencewhiz
2017-08-23 21:58:21 -07:00
committed by Peter Johnson
parent f7016b359f
commit 848280d1f1
1 changed files with 11 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
wpilibc/src/main/native/include/Compressor.h
View File

@@ -18,7 +18,17 @@
namespace frc {
/**
* PCM compressor
* Class for operating a compressor connected to a %PCM (Pneumatic Control
* Module). The %PCM will automatically run in closed loop mode by default
* whenever a Solenoid object is created. For most cases, a Compressor object
* does not need to be instantiated or used in a robot program. This class is
* only required in cases where the robot program needs a more detailed status
* of the compressor or to enable/disable closed loop control.
*
* Note: you cannot operate the compressor directly from this class as doing so
* would circumvent the safety provided by using the pressure switch and closed
* loop control. You can only turn off closed loop control, thereby stopping
* the compressor from operating.
*/
class Compressor : public SensorBase,
public LiveWindowSendable,