CANPowerSupply Class Reference

Base class for SCITOS modules that act as power supply. More...

#include <CANPowerSupply.h>

Public Member Functions
Constructor, destructor and reflect
	CANPowerSupply ()
	Constructor. More...
virtual	~CANPowerSupply ()
	Destructor. More...
template<typename Reflector >
void	reflect (Reflector &r)
	Reflect for serialization. More...
Setters and getters
void	setMaxCurrent (float current)
	Set the maximum current. More...
float	getMaxCurrent ()
	Return the maximum value for current. More...
void	enable (bool enable)
	Enable the power supply. More...
bool	isEnabled ()
	Is the power supply enabled. More...
float	getCurrent ()
	Return the current current. More...
float	getVoltage ()
	Return the current voltage. More...
virtual std::string	getStatus ()
	Return the status [(on,off)|error] of the power supply. More...

Public Attributes
uint8	nodeID
	Id of the can node. More...
uint16	index
	Index. More...
uint8	subIndexEnable
	Subindex for enabling the power supply. More...
uint8	subIndexMaxCurrent
	Subindex for setting/retrieving max current. More...
uint8	subIndexCurrent
	Subindex for retrieving the current. More...
uint8	subIndexVoltage
	Subindex for retrieving the voltage. More...
uint8	subIndexStatus
	Subindex for retrieving the status. More...
mira::can::CANOpenSDOClientPtr	sdoClient
bool	hasVoltage
	Does this supply support reading voltage information. More...

Detailed Description

Base class for SCITOS modules that act as power supply.

Constructor & Destructor Documentation

CANPowerSupply()

CANPowerSupply ( )

inline

Constructor.

~CANPowerSupply()

virtual ~CANPowerSupply ( )

inlinevirtual

Destructor.

Member Function Documentation

reflect()

void reflect ( Reflector &  r )

inline

Reflect for serialization.

setMaxCurrent()

void setMaxCurrent ( float  current )

inline

Set the maximum current.

getMaxCurrent()

float getMaxCurrent ( )

inline

Return the maximum value for current.

enable()

void enable ( bool  enable )

inline

Enable the power supply.

isEnabled()

bool isEnabled ( )

inline

Is the power supply enabled.

getCurrent()

float getCurrent ( )

inline

Return the current current.

getVoltage()

float getVoltage ( )

inline

Return the current voltage.

getStatus()

virtual std::string getStatus ( )

inlinevirtual

Return the status [(on,off)|error] of the power supply.

Member Data Documentation

nodeID

uint8 nodeID

Id of the can node.

index

uint16 index

Index.

subIndexEnable

uint8 subIndexEnable

Subindex for enabling the power supply.

subIndexMaxCurrent

uint8 subIndexMaxCurrent

Subindex for setting/retrieving max current.

subIndexCurrent

uint8 subIndexCurrent

Subindex for retrieving the current.

subIndexVoltage

uint8 subIndexVoltage

Subindex for retrieving the voltage.

subIndexStatus

uint8 subIndexStatus

Subindex for retrieving the status.

Pointer to the SDO client

sdoClient

mira::can::CANOpenSDOClientPtr sdoClient

hasVoltage

bool hasVoltage

Does this supply support reading voltage information.

---

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

• manager/include/CANPowerSupply.h