#include <embObjBattery.h>

Inheritance diagram for yarp::dev::embObjBattery:

Public Member Functions
	embObjBattery ()

	embObjBattery (std::shared_ptr< yarp::dev::embObjDevPrivData > device)

	~embObjBattery ()

bool	open (yarp::os::Searchable &config)

bool	close ()

bool	initialised () override

eth::iethresType_t	type () override

bool	update (eOprotID32_t id32, double timestamp, void *rxdata) override

bool	getBatteryVoltage (double &voltage) override

bool	getBatteryCurrent (double &current) override

bool	getBatteryCharge (double &charge) override

bool	getBatteryStatus (Battery_status &status) override

bool	getBatteryTemperature (double &temperature) override

bool	getBatteryInfo (std::string &battery_info) override

virtual double	calculateBoardTime (eOabstime_t current)

Public Member Functions inherited from eth::IethResource
virtual	~IethResource ()

const char *	stringOfType ()

Protected Member Functions
bool	sendConfig2boards (ServiceParserCanBattery &parser, eth::AbstractEthResource *deviceRes)

bool	sendStart2boards (ServiceParserCanBattery &parser, eth::AbstractEthResource *deviceRes)

bool	initRegulars (ServiceParserCanBattery &parser, eth::AbstractEthResource *deviceRes)

void	cleanup (void)

bool	checkUpdateTimeout (eOprotID32_t id32, eOabstime_t current)

Protected Attributes
std::shared_ptr< yarp::dev::embObjDevPrivData >	device_

std::shared_mutex	mutex_

CanBatteryData	canBatteryData_

std::map< eOprotID32_t, eOabstime_t >	timeoutUpdate_

std::vector< yarp::dev::MAS_status >	masStatus_ {MAS_OK, MAS_OK, MAS_OK, MAS_OK}

double	firstYarpTimestamp_ {0}

eOabstime_t	firstCanTimestamp_ {0}

Static Protected Attributes
static constexpr eOabstime_t	updateTimeout_ {11000}

static constexpr bool	checkUpdateTimeoutFlag_ {false}

static constexpr bool	useBoardTimeFlag_ {true}

Detailed Description

Definition at line 46 of file embObjBattery.h.

Constructor & Destructor Documentation

◆ embObjBattery() [1/2]

embObjBattery::embObjBattery ( )

Definition at line 44 of file embObjBattery.cpp.

◆ embObjBattery() [2/2]

embObjBattery::embObjBattery ( std::shared_ptr< yarp::dev::embObjDevPrivData > device )

Definition at line 50 of file embObjBattery.cpp.

◆ ~embObjBattery()

embObjBattery::~embObjBattery ( )

Definition at line 54 of file embObjBattery.cpp.

Member Function Documentation

◆ calculateBoardTime()

double embObjBattery::calculateBoardTime ( eOabstime_t current )

virtual

Definition at line 291 of file embObjBattery.cpp.

◆ checkUpdateTimeout()

bool embObjBattery::checkUpdateTimeout	(	eOprotID32_t	id32,
		eOabstime_t	current
	)

protected

Definition at line 271 of file embObjBattery.cpp.

◆ cleanup()

void embObjBattery::cleanup ( void )

protected

Definition at line 266 of file embObjBattery.cpp.

◆ close()

bool embObjBattery::close ( void )

Definition at line 260 of file embObjBattery.cpp.

◆ getBatteryCharge()

bool embObjBattery::getBatteryCharge ( double & charge )

override

Definition at line 320 of file embObjBattery.cpp.

◆ getBatteryCurrent()

bool embObjBattery::getBatteryCurrent ( double & current )

override

Definition at line 314 of file embObjBattery.cpp.

◆ getBatteryInfo()

bool embObjBattery::getBatteryInfo ( std::string & battery_info )

override

Definition at line 338 of file embObjBattery.cpp.

◆ getBatteryStatus()

bool embObjBattery::getBatteryStatus ( Battery_status & status )

override

Definition at line 326 of file embObjBattery.cpp.

◆ getBatteryTemperature()

bool embObjBattery::getBatteryTemperature ( double & temperature )

override

Definition at line 332 of file embObjBattery.cpp.

◆ getBatteryVoltage()

bool embObjBattery::getBatteryVoltage ( double & voltage )

override

Definition at line 308 of file embObjBattery.cpp.

◆ initialised()

bool embObjBattery::initialised ( )

overridevirtual

Implements eth::IethResource.

Definition at line 59 of file embObjBattery.cpp.

◆ initRegulars()

bool embObjBattery::initRegulars	(	ServiceParserCanBattery &	parser,
		eth::AbstractEthResource *	deviceRes
	)

protected

Definition at line 187 of file embObjBattery.cpp.

◆ open()

bool embObjBattery::open ( yarp::os::Searchable & config )

Definition at line 64 of file embObjBattery.cpp.

◆ sendConfig2boards()

bool embObjBattery::sendConfig2boards	(	ServiceParserCanBattery &	parser,
		eth::AbstractEthResource *	deviceRes
	)

protected

Definition at line 142 of file embObjBattery.cpp.

◆ sendStart2boards()

bool embObjBattery::sendStart2boards	(	ServiceParserCanBattery &	parser,
		eth::AbstractEthResource *	deviceRes
	)

protected

Definition at line 164 of file embObjBattery.cpp.

◆ type()

eth::iethresType_t embObjBattery::type ( )

overridevirtual

Implements eth::IethResource.

Definition at line 219 of file embObjBattery.cpp.

◆ update()

bool embObjBattery::update	(	eOprotID32_t	id32,
		double	timestamp,
		void *	rxdata
	)

overridevirtual

Implements eth::IethResource.

Definition at line 224 of file embObjBattery.cpp.

Member Data Documentation

◆ canBatteryData_

CanBatteryData yarp::dev::embObjBattery::canBatteryData_

protected

Definition at line 74 of file embObjBattery.h.

◆ checkUpdateTimeoutFlag_

constexpr bool yarp::dev::embObjBattery::checkUpdateTimeoutFlag_ {false}

staticconstexprprotected

Definition at line 85 of file embObjBattery.h.

◆ device_

std::shared_ptr<yarp::dev::embObjDevPrivData> yarp::dev::embObjBattery::device_

protected

Definition at line 72 of file embObjBattery.h.

◆ firstCanTimestamp_

eOabstime_t yarp::dev::embObjBattery::firstCanTimestamp_ {0}

protected

Definition at line 89 of file embObjBattery.h.

◆ firstYarpTimestamp_

double yarp::dev::embObjBattery::firstYarpTimestamp_ {0}

protected

Definition at line 88 of file embObjBattery.h.

◆ masStatus_

std::vector<yarp::dev::MAS_status> yarp::dev::embObjBattery::masStatus_ {MAS_OK, MAS_OK, MAS_OK, MAS_OK}

protected

Definition at line 83 of file embObjBattery.h.

◆ mutex_

std::shared_mutex yarp::dev::embObjBattery::mutex_

mutableprotected

Definition at line 73 of file embObjBattery.h.

◆ timeoutUpdate_

std::map<eOprotID32_t, eOabstime_t> yarp::dev::embObjBattery::timeoutUpdate_

protected

Definition at line 75 of file embObjBattery.h.

◆ updateTimeout_

constexpr eOabstime_t yarp::dev::embObjBattery::updateTimeout_ {11000}

staticconstexprprotected

Definition at line 82 of file embObjBattery.h.

◆ useBoardTimeFlag_

constexpr bool yarp::dev::embObjBattery::useBoardTimeFlag_ {true}

staticconstexprprotected

Definition at line 86 of file embObjBattery.h.

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

icub-main/src/libraries/icubmod/embObjBattery/embObjBattery.h
icub-main/src/libraries/icubmod/embObjBattery/embObjBattery.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ embObjBattery() [1/2]

◆ embObjBattery() [2/2]

◆ ~embObjBattery()

Member Function Documentation

◆ calculateBoardTime()

◆ checkUpdateTimeout()

◆ cleanup()

◆ close()

◆ getBatteryCharge()

◆ getBatteryCurrent()

◆ getBatteryInfo()

◆ getBatteryStatus()

◆ getBatteryTemperature()

◆ getBatteryVoltage()

◆ initialised()

◆ initRegulars()

◆ open()

◆ sendConfig2boards()

◆ sendStart2boards()

◆ type()

◆ update()

Member Data Documentation

◆ canBatteryData_

◆ checkUpdateTimeoutFlag_

◆ device_

◆ firstCanTimestamp_

◆ firstYarpTimestamp_

◆ masStatus_

◆ mutex_

◆ timeoutUpdate_

◆ updateTimeout_

◆ useBoardTimeFlag_