yarp::dev::BatteryData Class Reference

#include <yarp/dev/BatteryData.h>

Inheritance diagram for yarp::dev::BatteryData:

Public Types
typedef yarp::os::idl::Unwrapped< BatteryData >	unwrapped

Public Member Functions
	BatteryData ()=default
	BatteryData (const double charge, const double voltage, const double current, const double temperature, const std::int32_t status)
bool	read (yarp::os::idl::WireReader &reader) override
bool	read (yarp::os::ConnectionReader &connection) override
	Read this object from a network connection.
bool	write (const yarp::os::idl::WireWriter &writer) const override
bool	write (yarp::os::ConnectionWriter &connection) const override
	Write this object to a network connection.
std::string	toString () const
Public Member Functions inherited from yarp::os::idl::WirePortable
virtual bool	readBare (yarp::os::ConnectionReader &reader)
virtual bool	writeBare (yarp::os::ConnectionWriter &writer) const
virtual bool	readBottle (yarp::os::ConnectionReader &reader)
virtual bool	writeBottle (yarp::os::ConnectionWriter &writer) const
Public Member Functions inherited from yarp::os::Portable
virtual Type	getType () const
Public Member Functions inherited from yarp::os::PortReader
virtual	~PortReader ()
	Destructor.
virtual Type	getReadType () const
Public Member Functions inherited from yarp::os::PortWriter
virtual	~PortWriter ()
	Destructor.
virtual void	onCompletion () const
	This is called when the port has finished all writing operations.
virtual void	onCommencement () const
	This is called when the port is about to begin writing operations.
virtual yarp::os::Type	getWriteType () const

Public Attributes
double	charge {0.0}
	Battery charge percentage [%].
double	voltage {0.0}
	Battery Voltage [V].
double	current {0.0}
	Battery Current [A].
double	temperature {0.0}
	Battery Temperature [degC].
std::int32_t	status {3}
	the status of the device.

Additional Inherited Members
Static Public Member Functions inherited from yarp::os::Portable
static bool	copyPortable (const PortWriter &writer, PortReader &reader)
	Copy one portable to another, via writing and reading.

Detailed Description

Definition at line 21 of file BatteryData.h.

Member Typedef Documentation

unwrapped

typedef yarp::os::idl::Unwrapped<BatteryData> yarp::dev::BatteryData::unwrapped

Definition at line 73 of file BatteryData.h.

Constructor & Destructor Documentation

BatteryData() [1/2]

yarp::dev::BatteryData::BatteryData ( )

default

BatteryData() [2/2]

yarp::dev::BatteryData::BatteryData	(	const double	charge,
		const double	voltage,
		const double	current,
		const double	temperature,
		const std::int32_t	status
	)

Definition at line 16 of file BatteryData.cpp.

Member Function Documentation

read() [1/2]

bool yarp::dev::BatteryData::read ( yarp::os::ConnectionReader &  reader )

overridevirtual

Read this object from a network connection.

Override this for your particular class.

Parameters

reader

an interface to the network connection for reading

Returns

true iff the object is successfully read

Implements yarp::os::Portable.

Definition at line 55 of file BatteryData.cpp.

read() [2/2]

bool yarp::dev::BatteryData::read ( yarp::os::idl::WireReader &  reader )

overridevirtual

Reimplemented from yarp::os::idl::WirePortable.

Definition at line 31 of file BatteryData.cpp.

toString()

std::string yarp::dev::BatteryData::toString

(

)

const

Definition at line 105 of file BatteryData.cpp.

write() [1/2]

bool yarp::dev::BatteryData::write ( const yarp::os::idl::WireWriter &  writer ) const

overridevirtual

Reimplemented from yarp::os::idl::WirePortable.

Definition at line 68 of file BatteryData.cpp.

write() [2/2]

bool yarp::dev::BatteryData::write ( yarp::os::ConnectionWriter &  writer ) const

overridevirtual

Write this object to a network connection.

Override this for your particular class. Be aware that depending on the nature of the connections a port has, and what protocol they use, and how efficient the YARP implementation is, this method may be called once, twice, or many times, as the result of a single call to Port::write

Parameters

writer

an interface to the network connection for writing

Returns

true iff the object is successfully written

Implements yarp::os::Portable.

Definition at line 92 of file BatteryData.cpp.

Member Data Documentation

charge

double yarp::dev::BatteryData::charge {0.0}

Battery charge percentage [%].

Definition at line 29 of file BatteryData.h.

current

double yarp::dev::BatteryData::current {0.0}

Battery Current [A].

Definition at line 37 of file BatteryData.h.

status

std::int32_t yarp::dev::BatteryData::status {3}

the status of the device.

See yarp::dev::IRangefinder2D::Device_status. The default value is DEVICE_TIMEOUT.

Definition at line 45 of file BatteryData.h.

temperature

double yarp::dev::BatteryData::temperature {0.0}

Battery Temperature [degC].

Definition at line 41 of file BatteryData.h.

voltage

double yarp::dev::BatteryData::voltage {0.0}

Battery Voltage [V].

Definition at line 33 of file BatteryData.h.

---

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

• src/libYARP_dev/src/idl_generated_code/yarp/dev/BatteryData.h
• src/libYARP_dev/src/idl_generated_code/yarp/dev/BatteryData.cpp