WPILibC++  unspecified
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Pages
PowerDistributionPanel Class Reference

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

#include <PowerDistributionPanel.h>

Inheritance diagram for PowerDistributionPanel:
SensorBase LiveWindowSendable ErrorBase Sendable

Public Member Functions

 PowerDistributionPanel (uint8_t module)
 Initialize the PDP.
 
double GetVoltage () const
 Query the input voltage of the PDP. More...
 
double GetTemperature () const
 Query the temperature of the PDP. More...
 
double GetCurrent (uint8_t 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 UpdateTable () override
 Update the table for this sendable object with the latest values.
 
void StartLiveWindowMode () override
 Start having this sendable object automatically respond to value changes reflect the value on the table.
 
void StopLiveWindowMode () override
 Stop having this sendable object automatically respond to value changes.
 
std::string GetSmartDashboardType () const override
 
void InitTable (std::shared_ptr< ITable > subTable) override
 Initializes a table for this sendable object. More...
 
std::shared_ptr< ITableGetTable () const override
 
- Public Member Functions inherited from SensorBase
 SensorBase ()
 Creates an instance of the sensor base and gets an FPGA handle.
 
 SensorBase (const SensorBase &)=delete
 
SensorBaseoperator= (const SensorBase &)=delete
 
- Public Member Functions inherited from ErrorBase
 ErrorBase (const ErrorBase &)=delete
 
ErrorBaseoperator= (const ErrorBase &)=delete
 
virtual ErrorGetError ()
 Retrieve the current error. More...
 
virtual const ErrorGetError () const
 
virtual void SetErrnoError (llvm::StringRef contextMessage, llvm::StringRef filename, llvm::StringRef function, uint32_t 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, llvm::StringRef contextMessage, llvm::StringRef filename, llvm::StringRef function, uint32_t lineNumber) const
 Set the current error information associated from the nivision Imaq API. More...
 
virtual void SetError (Error::Code code, llvm::StringRef contextMessage, llvm::StringRef filename, llvm::StringRef function, uint32_t lineNumber) const
 Set the current error information associated with this sensor. More...
 
virtual void SetWPIError (llvm::StringRef errorMessage, Error::Code code, llvm::StringRef contextMessage, llvm::StringRef filename, llvm::StringRef function, uint32_t lineNumber) const
 Set the current error information associated with this sensor. More...
 
virtual void CloneError (const ErrorBase &rhs) const
 
virtual void ClearError () const
 Clear the current error information associated with this sensor.
 
virtual bool StatusIsFatal () const
 Check if the current error code represents a fatal error. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from SensorBase
static void DeleteSingletons ()
 Delete all the singleton classes on the list. More...
 
static uint32_t GetDefaultSolenoidModule ()
 
static bool CheckSolenoidModule (uint8_t moduleNumber)
 Check that the solenoid module number is valid. More...
 
static bool CheckDigitalChannel (uint32_t channel)
 Check that the digital channel number is valid. More...
 
static bool CheckRelayChannel (uint32_t channel)
 Check that the digital channel number is valid. More...
 
static bool CheckPWMChannel (uint32_t channel)
 Check that the digital channel number is valid. More...
 
static bool CheckAnalogInput (uint32_t channel)
 Check that the analog input number is value. More...
 
static bool CheckAnalogOutput (uint32_t channel)
 Check that the analog output number is valid. More...
 
static bool CheckSolenoidChannel (uint32_t channel)
 Verify that the solenoid channel number is within limits. More...
 
static bool CheckPDPChannel (uint32_t channel)
 Verify that the power distribution channel number is within limits. More...
 
- Static Public Member Functions inherited from ErrorBase
static void SetGlobalError (Error::Code code, llvm::StringRef contextMessage, llvm::StringRef filename, llvm::StringRef function, uint32_t lineNumber)
 
static void SetGlobalWPIError (llvm::StringRef errorMessage, llvm::StringRef contextMessage, llvm::StringRef filename, llvm::StringRef function, uint32_t lineNumber)
 
static ErrorGetGlobalError ()
 Retrieve the current global error.
 
- Static Public Attributes inherited from SensorBase
static const uint32_t kDigitalChannels = 26
 
static const uint32_t kAnalogInputs = 8
 
static const uint32_t kAnalogOutputs = 2
 
static const uint32_t kSolenoidChannels = 8
 
static const uint32_t kSolenoidModules = 2
 
static const uint32_t kPwmChannels = 20
 
static const uint32_t kRelayChannels = 8
 
static const uint32_t kPDPChannels = 16
 
static const uint32_t kChassisSlots = 8
 
- Protected Member Functions inherited from SensorBase
void AddToSingletonList ()
 Add sensor to the singleton list. More...
 
- Protected Attributes inherited from ErrorBase
Error m_error
 
- Static Protected Attributes inherited from SensorBase
static void * m_digital_ports [kDigitalChannels]
 
static void * m_relay_ports [kRelayChannels]
 
static void * m_pwm_ports [kPwmChannels]
 
- Static Protected Attributes inherited from ErrorBase
static priority_mutex _globalErrorMutex
 
static Error _globalError
 

Detailed Description

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

Author
Thomas Clark

Member Function Documentation

double PowerDistributionPanel::GetCurrent ( uint8_t  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
std::string PowerDistributionPanel::GetSmartDashboardType ( ) const
overridevirtual
Returns
the string representation of the named data type that will be used by the smart dashboard for this sendable

Implements Sendable.

std::shared_ptr< ITable > PowerDistributionPanel::GetTable ( ) const
overridevirtual
Returns
the table that is currently associated with the sendable

Implements Sendable.

double PowerDistributionPanel::GetTemperature ( ) const

Query the temperature of the PDP.

Returns
The temperature of the PDP in degrees Celsius
double 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
double 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
double 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
double PowerDistributionPanel::GetVoltage ( ) const

Query the input voltage of the PDP.

Returns
The voltage of the PDP in volts
void PowerDistributionPanel::InitTable ( std::shared_ptr< ITable subtable)
overridevirtual

Initializes a table for this sendable object.

Parameters
subtableThe table to put the values in.

Implements Sendable.

void PowerDistributionPanel::ResetTotalEnergy ( )

Reset the total energy drawn from the PDP.

See Also
PowerDistributionPanel::GetTotalEnergy

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