MIRA
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
PowerSupplyPort_v3 Class Referenceabstract

Function block for charger power supply ports, v3.0. More...

#include <functionblock/PowerSupplyPort.h>

Inheritance diagram for PowerSupplyPort_v3:
Inheritance graph
[legend]

Public Member Functions

 PowerSupplyPort_v3 ()
 Constructor. More...
 
virtual ~PowerSupplyPort_v3 ()
 Destructor. More...
 
template<typename Reflector >
void reflect (Reflector &r)
 Reflect for serialization. More...
 
float getMaxCurrent ()
 Return the maximum current. More...
 
void enable (bool enable)
 Enable the power supply. More...
 
bool isEnabled ()
 Is the power supply enabled. More...
 
float getMaxDissipatedPower ()
 Return the maximum dissipated power. More...
 
bool isCharging ()
 Is the power supply enabled. More...
 
float getVoltage ()
 Return the current voltage. More...
 
float getCurrent ()
 Return the current current. More...
 
Class const & getClass () const
 
Other functions
void checkFunctionBlockID ()
 

Static Public Member Functions

static PseudoClass const & CLASS ()
 

Public Attributes

uint32 functionBlockID
 ID of the function block. More...
 
uint8 nodeID
 ID of the can node. More...
 
uint16 index
 Index. More...
 
mira::can::CANOpenSDOClientPtr sdoClient
 

Protected Member Functions

virtual Class const & internalGetClass () const=0
 

Protected Attributes

uint8 subIndexMaxCurrent
 Subindex for retrieving the max-current. More...
 
uint8 subIndexEnable
 Subindex for enable-flag. More...
 
uint8 subIndexMaxDissipatedPower
 Subindex for max dissipated power. More...
 
uint8 subIndexIsCharging
 Subindex for charging flag. More...
 
uint8 subIndexVoltage
 Subindex for retrieving the voltage. More...
 
uint8 subIndexCurrent
 Subindex for retrieving the current. More...
 

Detailed Description

Function block for charger power supply ports, v3.0.

Constructor & Destructor Documentation

◆ PowerSupplyPort_v3()

PowerSupplyPort_v3 ( )
inline

Constructor.

◆ ~PowerSupplyPort_v3()

virtual ~PowerSupplyPort_v3 ( )
inlinevirtual

Destructor.

Member Function Documentation

◆ reflect()

void reflect ( Reflector &  r)
inline

Reflect for serialization.

◆ getMaxCurrent()

float getMaxCurrent ( )
inline

Return the maximum current.

◆ enable()

void enable ( bool  enable)
inline

Enable the power supply.

◆ isEnabled()

bool isEnabled ( )
inline

Is the power supply enabled.

◆ getMaxDissipatedPower()

float getMaxDissipatedPower ( )
inline

Return the maximum dissipated power.

◆ isCharging()

bool isCharging ( )
inlineinherited

Is the power supply enabled.

◆ getVoltage()

float getVoltage ( )
inlineinherited

Return the current voltage.

◆ getCurrent()

float getCurrent ( )
inlineinherited

Return the current current.

◆ checkFunctionBlockID()

void checkFunctionBlockID ( )
inherited

Member Data Documentation

◆ subIndexMaxCurrent

uint8 subIndexMaxCurrent
protected

Subindex for retrieving the max-current.

◆ subIndexEnable

uint8 subIndexEnable
protected

Subindex for enable-flag.

◆ subIndexMaxDissipatedPower

uint8 subIndexMaxDissipatedPower
protected

Subindex for max dissipated power.

◆ subIndexIsCharging

uint8 subIndexIsCharging
protectedinherited

Subindex for charging flag.

◆ subIndexVoltage

uint8 subIndexVoltage
protectedinherited

Subindex for retrieving the voltage.

◆ subIndexCurrent

uint8 subIndexCurrent
protectedinherited

Subindex for retrieving the current.

◆ functionBlockID

uint32 functionBlockID
inherited

ID of the function block.

◆ nodeID

uint8 nodeID
inherited

ID of the can node.

◆ index

uint16 index
inherited

Index.

Pointer to the SDO client

◆ sdoClient

mira::can::CANOpenSDOClientPtr sdoClient
inherited

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