Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-06-29 02:21:44 +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

6
wpilibc/src/main/native/cpp/Compressor.cpp
View File

@@ -43,6 +43,10 @@ void Compressor::Stop() {
}
bool Compressor::Enabled() const {
return IsEnabled();
}
bool Compressor::IsEnabled() const {
return m_module->GetCompressor();
}
@@ -87,7 +91,7 @@ CompressorConfigType Compressor::GetConfigType() const {
void Compressor::InitSendable(wpi::SendableBuilder& builder) {
builder.SetSmartDashboardType("Compressor");
builder.AddBooleanProperty(
"Enabled", [=] { return Enabled(); }, nullptr);
"Enabled", [=] { return IsEnabled(); }, nullptr);
builder.AddBooleanProperty(
"Pressure switch", [=]() { return GetPressureSwitchValue(); }, nullptr);
}

15
wpilibc/src/main/native/include/frc/Compressor.h
View File

@@ -78,11 +78,24 @@ class Compressor : public wpi::Sendable,
/**
* Check if compressor output is active.
* To (re)enable the compressor use EnableDigital() or EnableAnalog(...).
*
* @return true if the compressor is on
* @return true if the compressor is on.
* @deprecated To avoid confusion in thinking this (re)enables the compressor
* use IsEnabled().
*/
WPI_DEPRECATED(
"To avoid confusion in thinking this (re)enables the compressor use "
"IsEnabled()")
bool Enabled() const;
/**
* Returns whether the compressor is active or not.
*
* @return true if the compressor is on - otherwise false.
*/
bool IsEnabled() const;
/**
* Check if the pressure switch is triggered.
*