WPILibC++  2020.3.2-60-g3011ebe
frc::PowerDistributionPanel Class Reference

Class for getting voltage, current, temperature, power and energy from the CAN PDP. More...

#include <PowerDistributionPanel.h>

Inheritance diagram for frc::PowerDistributionPanel:
frc::ErrorBase frc::Sendable frc::SendableHelper< PowerDistributionPanel >

Public Member Functions

 PowerDistributionPanel (int module)
 
 PowerDistributionPanel (PowerDistributionPanel &&)=default
 
PowerDistributionPaneloperator= (PowerDistributionPanel &&)=default
 
double GetVoltage () const
 Query the input voltage of the PDP. More...
 
double GetTemperature () const
 Query the temperature of the PDP. More...
 
double GetCurrent (int channel) const
 Query the current of a single channel of the PDP. More...
 
double GetTotalCurrent () const
 Query the total current of all monitored PDP channels (0-15). More...
 
double GetTotalPower () const
 Query the total power drawn from the monitored PDP channels. More...
 
double GetTotalEnergy () const
 Query the total energy drawn from the monitored PDP channels. More...
 
void ResetTotalEnergy ()
 Reset the total energy drawn from the PDP. More...
 
void ClearStickyFaults ()
 Remove all of the fault flags on the PDP.
 
void InitSendable (SendableBuilder &builder) override
 Initializes this Sendable object. More...
 
- Public Member Functions inherited from frc::ErrorBase
 ErrorBase (const ErrorBase &)=default
 
ErrorBaseoperator= (const ErrorBase &)=default
 
 ErrorBase (ErrorBase &&)=default
 
ErrorBaseoperator= (ErrorBase &&)=default
 
virtual ErrorGetError ()
 Retrieve the current error. More...
 
virtual const ErrorGetError () const
 Retrieve the current error. More...
 
virtual void ClearError () const
 Clear the current error information associated with this sensor.
 
virtual void SetErrnoError (const wpi::Twine &contextMessage, wpi::StringRef filename, wpi::StringRef function, int lineNumber) const
 Set error information associated with a C library call that set an error to the "errno" global variable. More...
 
virtual void SetImaqError (int success, const wpi::Twine &contextMessage, wpi::StringRef filename, wpi::StringRef function, int lineNumber) const
 Set the current error information associated from the nivision Imaq API. More...
 
virtual void SetError (Error::Code code, const wpi::Twine &contextMessage, wpi::StringRef filename, wpi::StringRef function, int lineNumber) const
 Set the current error information associated with this sensor. More...
 
virtual void SetErrorRange (Error::Code code, int32_t minRange, int32_t maxRange, int32_t requestedValue, const wpi::Twine &contextMessage, wpi::StringRef filename, wpi::StringRef function, int lineNumber) const
 Set the current error information associated with this sensor. More...
 
virtual void SetWPIError (const wpi::Twine &errorMessage, Error::Code code, const wpi::Twine &contextMessage, wpi::StringRef filename, wpi::StringRef function, int lineNumber) const
 Set the current error information associated with this sensor. More...
 
virtual void CloneError (const ErrorBase &rhs) const
 
virtual bool StatusIsFatal () const
 Check if the current error code represents a fatal error. More...
 
void ClearGlobalErrors ()
 Clear global errors.
 
- Public Member Functions inherited from frc::SendableHelper< PowerDistributionPanel >
 SendableHelper (const SendableHelper &rhs)=default
 
 SendableHelper (SendableHelper &&rhs)
 
SendableHelperoperator= (const SendableHelper &rhs)=default
 
SendableHelperoperator= (SendableHelper &&rhs)
 
std::string GetName () const
 Gets the name of this Sendable object. More...
 
void SetName (const wpi::Twine &name)
 Sets the name of this Sendable object. More...
 
void SetName (const wpi::Twine &subsystem, const wpi::Twine &name)
 Sets both the subsystem name and device name of this Sendable object. More...
 
std::string GetSubsystem () const
 Gets the subsystem name of this Sendable object. More...
 
void SetSubsystem (const wpi::Twine &subsystem)
 Sets the subsystem name of this Sendable object. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from frc::ErrorBase
static void SetGlobalError (Error::Code code, const wpi::Twine &contextMessage, wpi::StringRef filename, wpi::StringRef function, int lineNumber)
 
static void SetGlobalWPIError (const wpi::Twine &errorMessage, const wpi::Twine &contextMessage, wpi::StringRef filename, wpi::StringRef function, int lineNumber)
 
static Error GetGlobalError ()
 Retrieve the last global error.
 
static std::vector< ErrorGetGlobalErrors ()
 Retrieve all global errors.
 
- Protected Member Functions inherited from frc::SendableHelper< PowerDistributionPanel >
void SetName (const wpi::Twine &moduleType, int channel)
 Sets the name of the sensor with a channel number. More...
 
void SetName (const wpi::Twine &moduleType, int moduleNumber, int channel)
 Sets the name of the sensor with a module and channel number. More...
 
void AddChild (std::shared_ptr< Sendable > child)
 Add a child component. More...
 
void AddChild (void *child)
 Add a child component. More...
 
- Protected Attributes inherited from frc::ErrorBase
Error m_error
 

Detailed Description

Class for getting voltage, current, temperature, power and energy from the CAN PDP.

Member Function Documentation

◆ GetCurrent()

double frc::PowerDistributionPanel::GetCurrent ( int  channel) const

Query the current of a single channel of the PDP.

Returns
The current of one of the PDP channels (channels 0-15) in Amperes

◆ GetTemperature()

double frc::PowerDistributionPanel::GetTemperature ( ) const

Query the temperature of the PDP.

Returns
The temperature of the PDP in degrees Celsius

◆ GetTotalCurrent()

double frc::PowerDistributionPanel::GetTotalCurrent ( ) const

Query the total current of all monitored PDP channels (0-15).

Returns
The the total current drawn from the PDP channels in Amperes

◆ GetTotalEnergy()

double frc::PowerDistributionPanel::GetTotalEnergy ( ) const

Query the total energy drawn from the monitored PDP channels.

Returns
The the total energy drawn from the PDP channels in Joules

◆ GetTotalPower()

double frc::PowerDistributionPanel::GetTotalPower ( ) const

Query the total power drawn from the monitored PDP channels.

Returns
The the total power drawn from the PDP channels in Watts

◆ GetVoltage()

double frc::PowerDistributionPanel::GetVoltage ( ) const

Query the input voltage of the PDP.

Returns
The voltage of the PDP in volts

◆ InitSendable()

void frc::PowerDistributionPanel::InitSendable ( SendableBuilder builder)
overridevirtual

Initializes this Sendable object.

Parameters
buildersendable builder

Implements frc::Sendable.

◆ ResetTotalEnergy()

void frc::PowerDistributionPanel::ResetTotalEnergy ( )

Reset the total energy drawn from the PDP.

See also
PowerDistributionPanel::GetTotalEnergy

The documentation for this class was generated from the following file: