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

[docs] Add docs for features not supported on PDH (NFC) (#6436)

Browse Source
This commit is contained in:
sciencewhiz
2024-03-11 20:22:33 -07:00
committed by GitHub
parent 11c60df3e0
commit f74f6f1d42
4 changed files with 49 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
wpilibc/src/main/native/include/frc/PowerDistribution.h
View File

@@ -58,7 +58,10 @@ class PowerDistribution : public wpi::Sendable,
double GetVoltage() const;
/**
* Query the temperature of the PDP/PDH.
* Query the temperature of the PDP.
*
* Not supported on the Rev PDH and returns 0.
*
*
* @return The temperature in degrees Celsius
*/
@@ -80,21 +83,27 @@ class PowerDistribution : public wpi::Sendable,
double GetTotalCurrent() const;
/**
* Query the total power drawn from all monitored PDP/PDH channels.
* Query the total power drawn from all monitored PDP channels.
*
* Not supported on the Rev PDH and returns 0.
*
* @return The total power drawn in Watts
*/
double GetTotalPower() const;
/**
* Query the total energy drawn from the monitored PDP/PDH channels.
* Query the total energy drawn from the monitored PDP channels.
*
* Not supported on the Rev PDH and returns 0.
*
* @return The total energy drawn in Joules
*/
double GetTotalEnergy() const;
/**
* Reset the total energy drawn from the PDP/PDH.
* Reset the total energy drawn from the PDP.
*
* Not supported on the Rev PDH and does nothing.
*
* @see PowerDistribution#GetTotalEnergy
*/