Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-07-04 03:11:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

[wpilib] Improve bitmap function documentation in PneumaticsBase (NFC) (#6884)

Browse Source
This commit is contained in:
Ryan Blue
2024-07-28 17:28:42 -04:00
committed by GitHub
parent 143876dfa3
commit ea7c935bcb
2 changed files with 24 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
wpilibc/src/main/native/include/frc/PneumaticsBase.h
View File

@@ -121,15 +121,18 @@ class PneumaticsBase {
/**
* Sets solenoids on a pneumatics module.
*
* @param mask bitmask to set
* @param values solenoid values
* @param mask Bitmask indicating which solenoids to set. The LSB represents
* solenoid 0.
* @param values Bitmask indicating the desired states of the solenoids. The
* LSB represents solenoid 0.
*/
virtual void SetSolenoids(int mask, int values) = 0;
/**
* Gets a bitmask of solenoid values.
*
* @return solenoid values
* @return Bitmask containing the state of the solenoids. The LSB represents
* solenoid 0.
*/
virtual int GetSolenoids() const = 0;
@@ -143,7 +146,8 @@ class PneumaticsBase {
/**
* Get a bitmask of disabled solenoids.
*
* @return bitmask of disabled solenoids
* @return Bitmask indicating disabled solenoids. The LSB represents solenoid
* 0.
*/
virtual int GetSolenoidDisabledList() const = 0;
@@ -171,19 +175,21 @@ class PneumaticsBase {
virtual bool CheckSolenoidChannel(int channel) const = 0;
/**
* Check to see if the masked solenoids can be reserved, and if not reserve
* them.
* Check to see if the solenoids marked in the bitmask can be reserved, and if
* so, reserve them.
*
* @param mask The bitmask of solenoids to reserve
* @param mask The bitmask of solenoids to reserve. The LSB represents
* solenoid 0.
* @return 0 if successful; mask of solenoids that couldn't be allocated
* otherwise
*/
virtual int CheckAndReserveSolenoids(int mask) = 0;
/**
* Unreserve the masked solenoids.
* Unreserve the solenoids marked in the bitmask.
*
* @param mask The bitmask of solenoids to unreserve
* @param mask The bitmask of solenoids to unreserve. The LSB represents
* solenoid 0.
*/
virtual void UnreserveSolenoids(int mask) = 0;

17
wpilibj/src/main/java/edu/wpi/first/wpilibj/PneumaticsBase.java
View File

@@ -36,15 +36,16 @@ public interface PneumaticsBase extends AutoCloseable {
/**
* Sets solenoids on a pneumatics module.
*
* @param mask mask
* @param values values
* @param mask Bitmask indicating which solenoids to set. The LSB represents solenoid 0.
* @param values Bitmask indicating the desired states of the solenoids. The LSB represents
* solenoid 0.
*/
void setSolenoids(int mask, int values);
/**
* Gets a bitmask of solenoid values.
*
* @return values
* @return Bitmask containing the state of the solenoids. The LSB represents solenoid 0.
*/
int getSolenoids();
@@ -58,7 +59,7 @@ public interface PneumaticsBase extends AutoCloseable {
/**
* Get a bitmask of disabled solenoids.
*
* @return bitmask of disabled solenoids
* @return Bitmask indicating disabled solenoids. The LSB represents solenoid 0.
*/
int getSolenoidDisabledList();
@@ -194,17 +195,17 @@ public interface PneumaticsBase extends AutoCloseable {
boolean checkSolenoidChannel(int channel);
/**
* Check to see if the masked solenoids can be reserved, and if not reserve them.
* Check to see if the solenoids marked in the bitmask can be reserved, and if so, reserve them.
*
* @param mask The bitmask of solenoids to reserve
* @param mask The bitmask of solenoids to reserve. The LSB represents solenoid 0.
* @return 0 if successful; mask of solenoids that couldn't be allocated otherwise
*/
int checkAndReserveSolenoids(int mask);
/**
* Unreserve the masked solenoids.
* Unreserve the solenoids marked in the bitmask.
*
* @param mask The bitmask of solenoids to unreserve
* @param mask The bitmask of solenoids to unreserve. The LSB represents solenoid 0.
*/
void unreserveSolenoids(int mask);