Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-06-19 00:41:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

Don't force public variables to use Hungarian notation (#8774)

Browse Source 
People generally have expressed a dislike for the Hungarian notation
used in member variables, especially in examples/templates, and our
styleguide shouldn't be forced on downstream consumers, so this removes
all Hungarian notation from the examples/templates.

There are _some_ benefits to Hungarian for private member variables
(like knowing what's a member vs. local in a PR review) so we'll keep
private member variables the same for now, but public variables should
no longer use Hungarian notation, since it looks much worse. A new PMD
XPath rule has been added to accomplish this goal. Some other
non-compliant variables were fixed for the new rule.
This commit is contained in:
Gold856
2026-04-25 14:32:08 -04:00
committed by GitHub
parent e7e51c9c05
commit 35e8abedeb
443 changed files with 4584 additions and 4789 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
wpilibc/src/main/native/cpp/hardware/pneumatic/PneumaticHub.cpp
View File

@@ -329,37 +329,37 @@ PneumaticHub::StickyFaults PneumaticHub::GetStickyFaults() const {
bool PneumaticHub::Faults::GetChannelFault(int channel) const {
switch (channel) {
case 0:
return Channel0Fault != 0;
return channel0Fault != 0;
case 1:
return Channel1Fault != 0;
return channel1Fault != 0;
case 2:
return Channel2Fault != 0;
return channel2Fault != 0;
case 3:
return Channel3Fault != 0;
return channel3Fault != 0;
case 4:
return Channel4Fault != 0;
return channel4Fault != 0;
case 5:
return Channel5Fault != 0;
return channel5Fault != 0;
case 6:
return Channel6Fault != 0;
return channel6Fault != 0;
case 7:
return Channel7Fault != 0;
return channel7Fault != 0;
case 8:
return Channel8Fault != 0;
return channel8Fault != 0;
case 9:
return Channel9Fault != 0;
return channel9Fault != 0;
case 10:
return Channel10Fault != 0;
return channel10Fault != 0;
case 11:
return Channel11Fault != 0;
return channel11Fault != 0;
case 12:
return Channel12Fault != 0;
return channel12Fault != 0;
case 13:
return Channel13Fault != 0;
return channel13Fault != 0;
case 14:
return Channel14Fault != 0;
return channel14Fault != 0;
case 15:
return Channel15Fault != 0;
return channel15Fault != 0;
default:
throw WPILIB_MakeError(err::ChannelIndexOutOfRange,
"Pneumatics fault channel out of bounds!");

96
wpilibc/src/main/native/cpp/hardware/power/PowerDistribution.cpp
View File

@@ -196,53 +196,53 @@ PowerDistribution::Faults PowerDistribution::GetFaults() const {
bool PowerDistribution::Faults::GetBreakerFault(int channel) const {
switch (channel) {
case 0:
return Channel0BreakerFault != 0;
return channel0BreakerFault != 0;
case 1:
return Channel1BreakerFault != 0;
return channel1BreakerFault != 0;
case 2:
return Channel2BreakerFault != 0;
return channel2BreakerFault != 0;
case 3:
return Channel3BreakerFault != 0;
return channel3BreakerFault != 0;
case 4:
return Channel4BreakerFault != 0;
return channel4BreakerFault != 0;
case 5:
return Channel5BreakerFault != 0;
return channel5BreakerFault != 0;
case 6:
return Channel6BreakerFault != 0;
return channel6BreakerFault != 0;
case 7:
return Channel7BreakerFault != 0;
return channel7BreakerFault != 0;
case 8:
return Channel8BreakerFault != 0;
return channel8BreakerFault != 0;
case 9:
return Channel9BreakerFault != 0;
return channel9BreakerFault != 0;
case 10:
return Channel10BreakerFault != 0;
return channel10BreakerFault != 0;
case 11:
return Channel11BreakerFault != 0;
return channel11BreakerFault != 0;
case 12:
return Channel12BreakerFault != 0;
return channel12BreakerFault != 0;
case 13:
return Channel13BreakerFault != 0;
return channel13BreakerFault != 0;
case 14:
return Channel14BreakerFault != 0;
return channel14BreakerFault != 0;
case 15:
return Channel15BreakerFault != 0;
return channel15BreakerFault != 0;
case 16:
return Channel16BreakerFault != 0;
return channel16BreakerFault != 0;
case 17:
return Channel17BreakerFault != 0;
return channel17BreakerFault != 0;
case 18:
return Channel18BreakerFault != 0;
return channel18BreakerFault != 0;
case 19:
return Channel19BreakerFault != 0;
return channel19BreakerFault != 0;
case 20:
return Channel20BreakerFault != 0;
return channel20BreakerFault != 0;
case 21:
return Channel21BreakerFault != 0;
return channel21BreakerFault != 0;
case 22:
return Channel22BreakerFault != 0;
return channel22BreakerFault != 0;
case 23:
return Channel23BreakerFault != 0;
return channel23BreakerFault != 0;
default:
throw WPILIB_MakeError(err::ChannelIndexOutOfRange,
"Power distribution fault channel out of bounds!");
@@ -252,53 +252,53 @@ bool PowerDistribution::Faults::GetBreakerFault(int channel) const {
bool PowerDistribution::StickyFaults::GetBreakerFault(int channel) const {
switch (channel) {
case 0:
return Channel0BreakerFault != 0;
return channel0BreakerFault != 0;
case 1:
return Channel1BreakerFault != 0;
return channel1BreakerFault != 0;
case 2:
return Channel2BreakerFault != 0;
return channel2BreakerFault != 0;
case 3:
return Channel3BreakerFault != 0;
return channel3BreakerFault != 0;
case 4:
return Channel4BreakerFault != 0;
return channel4BreakerFault != 0;
case 5:
return Channel5BreakerFault != 0;
return channel5BreakerFault != 0;
case 6:
return Channel6BreakerFault != 0;
return channel6BreakerFault != 0;
case 7:
return Channel7BreakerFault != 0;
return channel7BreakerFault != 0;
case 8:
return Channel8BreakerFault != 0;
return channel8BreakerFault != 0;
case 9:
return Channel9BreakerFault != 0;
return channel9BreakerFault != 0;
case 10:
return Channel10BreakerFault != 0;
return channel10BreakerFault != 0;
case 11:
return Channel11BreakerFault != 0;
return channel11BreakerFault != 0;
case 12:
return Channel12BreakerFault != 0;
return channel12BreakerFault != 0;
case 13:
return Channel13BreakerFault != 0;
return channel13BreakerFault != 0;
case 14:
return Channel14BreakerFault != 0;
return channel14BreakerFault != 0;
case 15:
return Channel15BreakerFault != 0;
return channel15BreakerFault != 0;
case 16:
return Channel16BreakerFault != 0;
return channel16BreakerFault != 0;
case 17:
return Channel17BreakerFault != 0;
return channel17BreakerFault != 0;
case 18:
return Channel18BreakerFault != 0;
return channel18BreakerFault != 0;
case 19:
return Channel19BreakerFault != 0;
return channel19BreakerFault != 0;
case 20:
return Channel20BreakerFault != 0;
return channel20BreakerFault != 0;
case 21:
return Channel21BreakerFault != 0;
return channel21BreakerFault != 0;
case 22:
return Channel22BreakerFault != 0;
return channel22BreakerFault != 0;
case 23:
return Channel23BreakerFault != 0;
return channel23BreakerFault != 0;
default:
throw WPILIB_MakeError(err::ChannelIndexOutOfRange,
"Power distribution fault channel out of bounds!");

62
wpilibc/src/main/native/include/wpi/hardware/pneumatic/PneumaticHub.hpp
View File

@@ -154,49 +154,49 @@ class PneumaticHub : public PneumaticsBase {
*/
struct Faults {
/** Fault on channel 0. */
uint32_t Channel0Fault : 1;
uint32_t channel0Fault : 1;
/** Fault on channel 1. */
uint32_t Channel1Fault : 1;
uint32_t channel1Fault : 1;
/** Fault on channel 2. */
uint32_t Channel2Fault : 1;
uint32_t channel2Fault : 1;
/** Fault on channel 3. */
uint32_t Channel3Fault : 1;
uint32_t channel3Fault : 1;
/** Fault on channel 4. */
uint32_t Channel4Fault : 1;
uint32_t channel4Fault : 1;
/** Fault on channel 5. */
uint32_t Channel5Fault : 1;
uint32_t channel5Fault : 1;
/** Fault on channel 6. */
uint32_t Channel6Fault : 1;
uint32_t channel6Fault : 1;
/** Fault on channel 7. */
uint32_t Channel7Fault : 1;
uint32_t channel7Fault : 1;
/** Fault on channel 8. */
uint32_t Channel8Fault : 1;
uint32_t channel8Fault : 1;
/** Fault on channel 9. */
uint32_t Channel9Fault : 1;
uint32_t channel9Fault : 1;
/** Fault on channel 10. */
uint32_t Channel10Fault : 1;
uint32_t channel10Fault : 1;
/** Fault on channel 11. */
uint32_t Channel11Fault : 1;
uint32_t channel11Fault : 1;
/** Fault on channel 12. */
uint32_t Channel12Fault : 1;
uint32_t channel12Fault : 1;
/** Fault on channel 13. */
uint32_t Channel13Fault : 1;
uint32_t channel13Fault : 1;
/** Fault on channel 14. */
uint32_t Channel14Fault : 1;
uint32_t channel14Fault : 1;
/** Fault on channel 15. */
uint32_t Channel15Fault : 1;
uint32_t channel15Fault : 1;
/** An overcurrent event occurred on the compressor output. */
uint32_t CompressorOverCurrent : 1;
uint32_t compressorOverCurrent : 1;
/** The compressor output has an open circuit. */
uint32_t CompressorOpen : 1;
uint32_t compressorOpen : 1;
/** An overcurrent event occurred on a solenoid output. */
uint32_t SolenoidOverCurrent : 1;
uint32_t solenoidOverCurrent : 1;
/** The input voltage is below the minimum voltage. */
uint32_t Brownout : 1;
uint32_t brownout : 1;
/** A warning was raised by the device's CAN controller. */
uint32_t CanWarning : 1;
uint32_t canWarning : 1;
/** The hardware on the device has malfunctioned. */
uint32_t HardwareFault : 1;
uint32_t hardwareFault : 1;
/**
* Gets whether there is a fault at the specified channel.
@@ -221,23 +221,23 @@ class PneumaticHub : public PneumaticsBase {
*/
struct StickyFaults {
/** An overcurrent event occurred on the compressor output. */
uint32_t CompressorOverCurrent : 1;
uint32_t compressorOverCurrent : 1;
/** The compressor output has an open circuit. */
uint32_t CompressorOpen : 1;
uint32_t compressorOpen : 1;
/** An overcurrent event occurred on a solenoid output. */
uint32_t SolenoidOverCurrent : 1;
uint32_t solenoidOverCurrent : 1;
/** The input voltage is below the minimum voltage. */
uint32_t Brownout : 1;
uint32_t brownout : 1;
/** A warning was raised by the device's CAN controller. */
uint32_t CanWarning : 1;
uint32_t canWarning : 1;
/** The device's CAN controller experienced a "Bus Off" event. */
uint32_t CanBusOff : 1;
uint32_t canBusOff : 1;
/** The hardware on the device has malfunctioned. */
uint32_t HardwareFault : 1;
uint32_t hardwareFault : 1;
/** The firmware on the device has malfunctioned. */
uint32_t FirmwareFault : 1;
uint32_t firmwareFault : 1;
/** The device has rebooted. */
uint32_t HasReset : 1;
uint32_t hasReset : 1;
};
/**

114
wpilibc/src/main/native/include/wpi/hardware/power/PowerDistribution.hpp
View File

@@ -184,59 +184,59 @@ class PowerDistribution : public wpi::util::Sendable,
*/
struct Faults {
/** Breaker fault on channel 0. */
uint32_t Channel0BreakerFault : 1;
uint32_t channel0BreakerFault : 1;
/** Breaker fault on channel 1. */
uint32_t Channel1BreakerFault : 1;
uint32_t channel1BreakerFault : 1;
/** Breaker fault on channel 2. */
uint32_t Channel2BreakerFault : 1;
uint32_t channel2BreakerFault : 1;
/** Breaker fault on channel 3. */
uint32_t Channel3BreakerFault : 1;
uint32_t channel3BreakerFault : 1;
/** Breaker fault on channel 4. */
uint32_t Channel4BreakerFault : 1;
uint32_t channel4BreakerFault : 1;
/** Breaker fault on channel 5. */
uint32_t Channel5BreakerFault : 1;
uint32_t channel5BreakerFault : 1;
/** Breaker fault on channel 6. */
uint32_t Channel6BreakerFault : 1;
uint32_t channel6BreakerFault : 1;
/** Breaker fault on channel 7. */
uint32_t Channel7BreakerFault : 1;
uint32_t channel7BreakerFault : 1;
/** Breaker fault on channel 8. */
uint32_t Channel8BreakerFault : 1;
uint32_t channel8BreakerFault : 1;
/** Breaker fault on channel 9. */
uint32_t Channel9BreakerFault : 1;
uint32_t channel9BreakerFault : 1;
/** Breaker fault on channel 10. */
uint32_t Channel10BreakerFault : 1;
uint32_t channel10BreakerFault : 1;
/** Breaker fault on channel 12. */
uint32_t Channel11BreakerFault : 1;
uint32_t channel11BreakerFault : 1;
/** Breaker fault on channel 13. */
uint32_t Channel12BreakerFault : 1;
uint32_t channel12BreakerFault : 1;
/** Breaker fault on channel 14. */
uint32_t Channel13BreakerFault : 1;
uint32_t channel13BreakerFault : 1;
/** Breaker fault on channel 15. */
uint32_t Channel14BreakerFault : 1;
uint32_t channel14BreakerFault : 1;
/** Breaker fault on channel 16. */
uint32_t Channel15BreakerFault : 1;
uint32_t channel15BreakerFault : 1;
/** Breaker fault on channel 17. */
uint32_t Channel16BreakerFault : 1;
uint32_t channel16BreakerFault : 1;
/** Breaker fault on channel 18. */
uint32_t Channel17BreakerFault : 1;
uint32_t channel17BreakerFault : 1;
/** Breaker fault on channel 19. */
uint32_t Channel18BreakerFault : 1;
uint32_t channel18BreakerFault : 1;
/** Breaker fault on channel 20. */
uint32_t Channel19BreakerFault : 1;
uint32_t channel19BreakerFault : 1;
/** Breaker fault on channel 21. */
uint32_t Channel20BreakerFault : 1;
uint32_t channel20BreakerFault : 1;
/** Breaker fault on channel 22. */
uint32_t Channel21BreakerFault : 1;
uint32_t channel21BreakerFault : 1;
/** Breaker fault on channel 23. */
uint32_t Channel22BreakerFault : 1;
uint32_t channel22BreakerFault : 1;
/** Breaker fault on channel 24. */
uint32_t Channel23BreakerFault : 1;
uint32_t channel23BreakerFault : 1;
/** The input voltage is below the minimum voltage. */
uint32_t Brownout : 1;
uint32_t brownout : 1;
/** A warning was raised by the device's CAN controller. */
uint32_t CanWarning : 1;
uint32_t canWarning : 1;
/** The hardware on the device has malfunctioned. */
uint32_t HardwareFault : 1;
uint32_t hardwareFault : 1;
/**
* Gets whether there is a breaker fault at a specified channel.
@@ -263,65 +263,65 @@ class PowerDistribution : public wpi::util::Sendable,
*/
struct StickyFaults {
/** Breaker fault on channel 0. */
uint32_t Channel0BreakerFault : 1;
uint32_t channel0BreakerFault : 1;
/** Breaker fault on channel 1. */
uint32_t Channel1BreakerFault : 1;
uint32_t channel1BreakerFault : 1;
/** Breaker fault on channel 2. */
uint32_t Channel2BreakerFault : 1;
uint32_t channel2BreakerFault : 1;
/** Breaker fault on channel 3. */
uint32_t Channel3BreakerFault : 1;
uint32_t channel3BreakerFault : 1;
/** Breaker fault on channel 4. */
uint32_t Channel4BreakerFault : 1;
uint32_t channel4BreakerFault : 1;
/** Breaker fault on channel 5. */
uint32_t Channel5BreakerFault : 1;
uint32_t channel5BreakerFault : 1;
/** Breaker fault on channel 6. */
uint32_t Channel6BreakerFault : 1;
uint32_t channel6BreakerFault : 1;
/** Breaker fault on channel 7. */
uint32_t Channel7BreakerFault : 1;
uint32_t channel7BreakerFault : 1;
/** Breaker fault on channel 8. */
uint32_t Channel8BreakerFault : 1;
uint32_t channel8BreakerFault : 1;
/** Breaker fault on channel 9. */
uint32_t Channel9BreakerFault : 1;
uint32_t channel9BreakerFault : 1;
/** Breaker fault on channel 10. */
uint32_t Channel10BreakerFault : 1;
uint32_t channel10BreakerFault : 1;
/** Breaker fault on channel 12. */
uint32_t Channel11BreakerFault : 1;
uint32_t channel11BreakerFault : 1;
/** Breaker fault on channel 13. */
uint32_t Channel12BreakerFault : 1;
uint32_t channel12BreakerFault : 1;
/** Breaker fault on channel 14. */
uint32_t Channel13BreakerFault : 1;
uint32_t channel13BreakerFault : 1;
/** Breaker fault on channel 15. */
uint32_t Channel14BreakerFault : 1;
uint32_t channel14BreakerFault : 1;
/** Breaker fault on channel 16. */
uint32_t Channel15BreakerFault : 1;
uint32_t channel15BreakerFault : 1;
/** Breaker fault on channel 17. */
uint32_t Channel16BreakerFault : 1;
uint32_t channel16BreakerFault : 1;
/** Breaker fault on channel 18. */
uint32_t Channel17BreakerFault : 1;
uint32_t channel17BreakerFault : 1;
/** Breaker fault on channel 19. */
uint32_t Channel18BreakerFault : 1;
uint32_t channel18BreakerFault : 1;
/** Breaker fault on channel 20. */
uint32_t Channel19BreakerFault : 1;
uint32_t channel19BreakerFault : 1;
/** Breaker fault on channel 21. */
uint32_t Channel20BreakerFault : 1;
uint32_t channel20BreakerFault : 1;
/** Breaker fault on channel 22. */
uint32_t Channel21BreakerFault : 1;
uint32_t channel21BreakerFault : 1;
/** Breaker fault on channel 23. */
uint32_t Channel22BreakerFault : 1;
uint32_t channel22BreakerFault : 1;
/** Breaker fault on channel 24. */
uint32_t Channel23BreakerFault : 1;
uint32_t channel23BreakerFault : 1;
/** The input voltage is below the minimum voltage. */
uint32_t Brownout : 1;
uint32_t brownout : 1;
/** A warning was raised by the device's CAN controller. */
uint32_t CanWarning : 1;
uint32_t canWarning : 1;
/** The device's CAN controller experienced a "Bus Off" event. */
uint32_t CanBusOff : 1;
uint32_t canBusOff : 1;
/** The hardware on the device has malfunctioned. */
uint32_t HardwareFault : 1;
uint32_t hardwareFault : 1;
/** The firmware on the device has malfunctioned. */
uint32_t FirmwareFault : 1;
uint32_t firmwareFault : 1;
/** The device has rebooted. */
uint32_t HasReset : 1;
uint32_t hasReset : 1;
/**
* Gets whether there is a sticky breaker fault at the specified channel.

62
wpilibc/src/main/python/semiwrap/PneumaticHub.yml
View File

@@ -54,38 +54,38 @@ classes:
UniqueId:
wpi::PneumaticHub::Faults:
attributes:
Channel0Fault:
Channel1Fault:
Channel2Fault:
Channel3Fault:
Channel4Fault:
Channel5Fault:
Channel6Fault:
Channel7Fault:
Channel8Fault:
Channel9Fault:
Channel10Fault:
Channel11Fault:
Channel12Fault:
Channel13Fault:
Channel14Fault:
Channel15Fault:
CompressorOverCurrent:
CompressorOpen:
SolenoidOverCurrent:
Brownout:
CanWarning:
HardwareFault:
channel0Fault:
channel1Fault:
channel2Fault:
channel3Fault:
channel4Fault:
channel5Fault:
channel6Fault:
channel7Fault:
channel8Fault:
channel9Fault:
channel10Fault:
channel11Fault:
channel12Fault:
channel13Fault:
channel14Fault:
channel15Fault:
compressorOverCurrent:
compressorOpen:
solenoidOverCurrent:
brownout:
canWarning:
hardwareFault:
methods:
GetChannelFault:
wpi::PneumaticHub::StickyFaults:
attributes:
CompressorOverCurrent:
CompressorOpen:
SolenoidOverCurrent:
Brownout:
CanWarning:
CanBusOff:
HasReset:
HardwareFault:
FirmwareFault:
compressorOverCurrent:
compressorOpen:
solenoidOverCurrent:
brownout:
canWarning:
canBusOff:
hasReset:
hardwareFault:
firmwareFault:

114
wpilibc/src/main/python/semiwrap/PowerDistribution.yml
View File

@@ -42,66 +42,66 @@ classes:
UniqueId:
wpi::PowerDistribution::Faults:
attributes:
Channel0BreakerFault:
Channel1BreakerFault:
Channel2BreakerFault:
Channel3BreakerFault:
Channel4BreakerFault:
Channel5BreakerFault:
Channel6BreakerFault:
Channel7BreakerFault:
Channel8BreakerFault:
Channel9BreakerFault:
Channel10BreakerFault:
Channel11BreakerFault:
Channel12BreakerFault:
Channel13BreakerFault:
Channel14BreakerFault:
Channel15BreakerFault:
Channel16BreakerFault:
Channel17BreakerFault:
Channel18BreakerFault:
Channel19BreakerFault:
Channel20BreakerFault:
Channel21BreakerFault:
Channel22BreakerFault:
Channel23BreakerFault:
Brownout:
CanWarning:
HardwareFault:
channel0BreakerFault:
channel1BreakerFault:
channel2BreakerFault:
channel3BreakerFault:
channel4BreakerFault:
channel5BreakerFault:
channel6BreakerFault:
channel7BreakerFault:
channel8BreakerFault:
channel9BreakerFault:
channel10BreakerFault:
channel11BreakerFault:
channel12BreakerFault:
channel13BreakerFault:
channel14BreakerFault:
channel15BreakerFault:
channel16BreakerFault:
channel17BreakerFault:
channel18BreakerFault:
channel19BreakerFault:
channel20BreakerFault:
channel21BreakerFault:
channel22BreakerFault:
channel23BreakerFault:
brownout:
canWarning:
hardwareFault:
methods:
GetBreakerFault:
wpi::PowerDistribution::StickyFaults:
attributes:
Channel0BreakerFault:
Channel1BreakerFault:
Channel2BreakerFault:
Channel3BreakerFault:
Channel4BreakerFault:
Channel5BreakerFault:
Channel6BreakerFault:
Channel7BreakerFault:
Channel8BreakerFault:
Channel9BreakerFault:
Channel10BreakerFault:
Channel11BreakerFault:
Channel12BreakerFault:
Channel13BreakerFault:
Channel14BreakerFault:
Channel15BreakerFault:
Channel16BreakerFault:
Channel17BreakerFault:
Channel18BreakerFault:
Channel19BreakerFault:
Channel20BreakerFault:
Channel21BreakerFault:
Channel22BreakerFault:
Channel23BreakerFault:
Brownout:
CanWarning:
CanBusOff:
HasReset:
HardwareFault:
FirmwareFault:
channel0BreakerFault:
channel1BreakerFault:
channel2BreakerFault:
channel3BreakerFault:
channel4BreakerFault:
channel5BreakerFault:
channel6BreakerFault:
channel7BreakerFault:
channel8BreakerFault:
channel9BreakerFault:
channel10BreakerFault:
channel11BreakerFault:
channel12BreakerFault:
channel13BreakerFault:
channel14BreakerFault:
channel15BreakerFault:
channel16BreakerFault:
channel17BreakerFault:
channel18BreakerFault:
channel19BreakerFault:
channel20BreakerFault:
channel21BreakerFault:
channel22BreakerFault:
channel23BreakerFault:
brownout:
canWarning:
canBusOff:
hasReset:
hardwareFault:
firmwareFault:
methods:
GetBreakerFault: