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

[wpilib] Compressor: Rename enabled to isEnabled (#4147)

Browse Source 
This is a less confusing name, as enabled() can imply it enables the compressor.
This commit is contained in:
Spud
2022-04-08 21:31:08 -07:00
committed by GitHub
parent 5bf46a9093
commit 975171609e
3 changed files with 33 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
wpilibj/src/main/java/edu/wpi/first/wpilibj/Compressor.java
View File

@@ -91,11 +91,23 @@ public class Compressor implements Sendable, AutoCloseable {
}
/**
* Get the status of the compressor.
* Get the status of the compressor. To (re)enable the compressor use enableDigital() or
* enableAnalog(...).
*
* @return true if the compressor is on
* @deprecated To avoid confusion in thinking this (re)enables the compressor use IsEnabled().
*/
@Deprecated(since = "2023", forRemoval = true)
public boolean enabled() {
return isEnabled();
}
/**
* Returns whether the compressor is active or not.
*
* @return true if the compressor is on - otherwise false.
*/
public boolean isEnabled() {
return m_module.getCompressor();
}
@@ -184,7 +196,7 @@ public class Compressor implements Sendable, AutoCloseable {
@Override
public void initSendable(SendableBuilder builder) {
builder.setSmartDashboardType("Compressor");
builder.addBooleanProperty("Enabled", this::enabled, null);
builder.addBooleanProperty("Enabled", this::isEnabled, null);
builder.addBooleanProperty("Pressure switch", this::getPressureSwitchValue, null);
}
}