YARP
Yet Another Robot Platform
yarp::rosmsg::sensor_msgs::BatteryState Class Reference

#include <yarp/rosmsg/sensor_msgs/BatteryState.h>

+ Inheritance diagram for yarp::rosmsg::sensor_msgs::BatteryState:

Detailed Description

Definition at line 78 of file BatteryState.h.

Public Types

typedef yarp::os::idl::BareStyle< yarp::rosmsg::sensor_msgs::BatteryStaterosStyle
 
typedef yarp::os::idl::BottleStyle< yarp::rosmsg::sensor_msgs::BatteryStatebottleStyle
 

Public Member Functions

 BatteryState ()
 
void clear ()
 
bool readBare (yarp::os::ConnectionReader &connection) override
 
bool readBottle (yarp::os::ConnectionReader &connection) override
 
bool read (yarp::os::ConnectionReader &connection) override
 Read this object from a network connection. More...
 
bool writeBare (yarp::os::ConnectionWriter &connection) const override
 
bool writeBottle (yarp::os::ConnectionWriter &connection) const override
 
bool write (yarp::os::ConnectionWriter &connection) const override
 Write this object to a network connection. More...
 
std::string getTypeText () const
 
yarp::os::Type getType () const override
 
- Public Member Functions inherited from yarp::os::idl::WirePortable
virtual bool read (yarp::os::idl::WireReader &reader)
 
virtual bool write (const yarp::os::idl::WireWriter &writer) const
 
- Public Member Functions inherited from yarp::os::PortReader
virtual ~PortReader ()
 Destructor. More...
 
virtual Type getReadType () const
 
- Public Member Functions inherited from yarp::os::PortWriter
virtual ~PortWriter ()
 Destructor. More...
 
virtual void onCompletion () const
 This is called when the port has finished all writing operations. More...
 
virtual void onCommencement () const
 This is called when the port is about to begin writing operations. More...
 
virtual yarp::os::Type getWriteType () const
 

Static Public Member Functions

static std::string typeText ()
 
- Static Public Member Functions inherited from yarp::os::Portable
static bool copyPortable (PortWriter &writer, PortReader &reader)
 Copy one portable to another, via writing and reading. More...
 

Public Attributes

yarp::rosmsg::std_msgs::Header header
 
yarp::conf::float32_t voltage
 
yarp::conf::float32_t current
 
yarp::conf::float32_t charge
 
yarp::conf::float32_t capacity
 
yarp::conf::float32_t design_capacity
 
yarp::conf::float32_t percentage
 
std::uint8_t power_supply_status
 
std::uint8_t power_supply_health
 
std::uint8_t power_supply_technology
 
bool present
 
std::vector< yarp::conf::float32_tcell_voltage
 
std::string location
 
std::string serial_number
 

Static Public Attributes

static const std::uint8_t POWER_SUPPLY_STATUS_UNKNOWN = 0
 
static const std::uint8_t POWER_SUPPLY_STATUS_CHARGING = 1
 
static const std::uint8_t POWER_SUPPLY_STATUS_DISCHARGING = 2
 
static const std::uint8_t POWER_SUPPLY_STATUS_NOT_CHARGING = 3
 
static const std::uint8_t POWER_SUPPLY_STATUS_FULL = 4
 
static const std::uint8_t POWER_SUPPLY_HEALTH_UNKNOWN = 0
 
static const std::uint8_t POWER_SUPPLY_HEALTH_GOOD = 1
 
static const std::uint8_t POWER_SUPPLY_HEALTH_OVERHEAT = 2
 
static const std::uint8_t POWER_SUPPLY_HEALTH_DEAD = 3
 
static const std::uint8_t POWER_SUPPLY_HEALTH_OVERVOLTAGE = 4
 
static const std::uint8_t POWER_SUPPLY_HEALTH_UNSPEC_FAILURE = 5
 
static const std::uint8_t POWER_SUPPLY_HEALTH_COLD = 6
 
static const std::uint8_t POWER_SUPPLY_HEALTH_WATCHDOG_TIMER_EXPIRE = 7
 
static const std::uint8_t POWER_SUPPLY_HEALTH_SAFETY_TIMER_EXPIRE = 8
 
static const std::uint8_t POWER_SUPPLY_TECHNOLOGY_UNKNOWN = 0
 
static const std::uint8_t POWER_SUPPLY_TECHNOLOGY_NIMH = 1
 
static const std::uint8_t POWER_SUPPLY_TECHNOLOGY_LION = 2
 
static const std::uint8_t POWER_SUPPLY_TECHNOLOGY_LIPO = 3
 
static const std::uint8_t POWER_SUPPLY_TECHNOLOGY_LIFE = 4
 
static const std::uint8_t POWER_SUPPLY_TECHNOLOGY_NICD = 5
 
static const std::uint8_t POWER_SUPPLY_TECHNOLOGY_LIMN = 6
 

Member Typedef Documentation

◆ bottleStyle

◆ rosStyle

Constructor & Destructor Documentation

◆ BatteryState()

yarp::rosmsg::sensor_msgs::BatteryState::BatteryState ( )
inline

Definition at line 117 of file BatteryState.h.

Member Function Documentation

◆ clear()

void yarp::rosmsg::sensor_msgs::BatteryState::clear ( )
inline

Definition at line 135 of file BatteryState.h.

◆ getType()

yarp::os::Type yarp::rosmsg::sensor_msgs::BatteryState::getType ( ) const
inlineoverridevirtual

Reimplemented from yarp::os::Portable.

Definition at line 560 of file BatteryState.h.

◆ getTypeText()

std::string yarp::rosmsg::sensor_msgs::BatteryState::getTypeText ( ) const
inline

Definition at line 554 of file BatteryState.h.

◆ read()

bool yarp::rosmsg::sensor_msgs::BatteryState::read ( yarp::os::ConnectionReader reader)
inlineoverridevirtual

Read this object from a network connection.

Override this for your particular class.

Parameters
readeran interface to the network connection for reading
Returns
true iff the object is successfully read

Implements yarp::os::Portable.

Definition at line 352 of file BatteryState.h.

◆ readBare()

bool yarp::rosmsg::sensor_msgs::BatteryState::readBare ( yarp::os::ConnectionReader connection)
inlineoverridevirtual

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

Definition at line 222 of file BatteryState.h.

◆ readBottle()

bool yarp::rosmsg::sensor_msgs::BatteryState::readBottle ( yarp::os::ConnectionReader connection)
inlineoverridevirtual

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

Definition at line 285 of file BatteryState.h.

◆ typeText()

static std::string yarp::rosmsg::sensor_msgs::BatteryState::typeText ( )
inlinestatic

Definition at line 496 of file BatteryState.h.

◆ write()

bool yarp::rosmsg::sensor_msgs::BatteryState::write ( yarp::os::ConnectionWriter writer) const
inlineoverridevirtual

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
writeran interface to the network connection for writing
Returns
true iff the object is successfully written

Implements yarp::os::Portable.

Definition at line 484 of file BatteryState.h.

◆ writeBare()

bool yarp::rosmsg::sensor_msgs::BatteryState::writeBare ( yarp::os::ConnectionWriter connection) const
inlineoverridevirtual

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

Definition at line 358 of file BatteryState.h.

◆ writeBottle()

bool yarp::rosmsg::sensor_msgs::BatteryState::writeBottle ( yarp::os::ConnectionWriter connection) const
inlineoverridevirtual

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

Definition at line 412 of file BatteryState.h.

Member Data Documentation

◆ capacity

yarp::conf::float32_t yarp::rosmsg::sensor_msgs::BatteryState::capacity

Definition at line 106 of file BatteryState.h.

◆ cell_voltage

std::vector<yarp::conf::float32_t> yarp::rosmsg::sensor_msgs::BatteryState::cell_voltage

Definition at line 113 of file BatteryState.h.

◆ charge

yarp::conf::float32_t yarp::rosmsg::sensor_msgs::BatteryState::charge

Definition at line 105 of file BatteryState.h.

◆ current

yarp::conf::float32_t yarp::rosmsg::sensor_msgs::BatteryState::current

Definition at line 104 of file BatteryState.h.

◆ design_capacity

yarp::conf::float32_t yarp::rosmsg::sensor_msgs::BatteryState::design_capacity

Definition at line 107 of file BatteryState.h.

◆ header

yarp::rosmsg::std_msgs::Header yarp::rosmsg::sensor_msgs::BatteryState::header

Definition at line 102 of file BatteryState.h.

◆ location

std::string yarp::rosmsg::sensor_msgs::BatteryState::location

Definition at line 114 of file BatteryState.h.

◆ percentage

yarp::conf::float32_t yarp::rosmsg::sensor_msgs::BatteryState::percentage

Definition at line 108 of file BatteryState.h.

◆ power_supply_health

std::uint8_t yarp::rosmsg::sensor_msgs::BatteryState::power_supply_health

Definition at line 110 of file BatteryState.h.

◆ POWER_SUPPLY_HEALTH_COLD

const std::uint8_t yarp::rosmsg::sensor_msgs::BatteryState::POWER_SUPPLY_HEALTH_COLD = 6
static

Definition at line 92 of file BatteryState.h.

◆ POWER_SUPPLY_HEALTH_DEAD

const std::uint8_t yarp::rosmsg::sensor_msgs::BatteryState::POWER_SUPPLY_HEALTH_DEAD = 3
static

Definition at line 89 of file BatteryState.h.

◆ POWER_SUPPLY_HEALTH_GOOD

const std::uint8_t yarp::rosmsg::sensor_msgs::BatteryState::POWER_SUPPLY_HEALTH_GOOD = 1
static

Definition at line 87 of file BatteryState.h.

◆ POWER_SUPPLY_HEALTH_OVERHEAT

const std::uint8_t yarp::rosmsg::sensor_msgs::BatteryState::POWER_SUPPLY_HEALTH_OVERHEAT = 2
static

Definition at line 88 of file BatteryState.h.

◆ POWER_SUPPLY_HEALTH_OVERVOLTAGE

const std::uint8_t yarp::rosmsg::sensor_msgs::BatteryState::POWER_SUPPLY_HEALTH_OVERVOLTAGE = 4
static

Definition at line 90 of file BatteryState.h.

◆ POWER_SUPPLY_HEALTH_SAFETY_TIMER_EXPIRE

const std::uint8_t yarp::rosmsg::sensor_msgs::BatteryState::POWER_SUPPLY_HEALTH_SAFETY_TIMER_EXPIRE = 8
static

Definition at line 94 of file BatteryState.h.

◆ POWER_SUPPLY_HEALTH_UNKNOWN

const std::uint8_t yarp::rosmsg::sensor_msgs::BatteryState::POWER_SUPPLY_HEALTH_UNKNOWN = 0
static

Definition at line 86 of file BatteryState.h.

◆ POWER_SUPPLY_HEALTH_UNSPEC_FAILURE

const std::uint8_t yarp::rosmsg::sensor_msgs::BatteryState::POWER_SUPPLY_HEALTH_UNSPEC_FAILURE = 5
static

Definition at line 91 of file BatteryState.h.

◆ POWER_SUPPLY_HEALTH_WATCHDOG_TIMER_EXPIRE

const std::uint8_t yarp::rosmsg::sensor_msgs::BatteryState::POWER_SUPPLY_HEALTH_WATCHDOG_TIMER_EXPIRE = 7
static

Definition at line 93 of file BatteryState.h.

◆ power_supply_status

std::uint8_t yarp::rosmsg::sensor_msgs::BatteryState::power_supply_status

Definition at line 109 of file BatteryState.h.

◆ POWER_SUPPLY_STATUS_CHARGING

const std::uint8_t yarp::rosmsg::sensor_msgs::BatteryState::POWER_SUPPLY_STATUS_CHARGING = 1
static

Definition at line 82 of file BatteryState.h.

◆ POWER_SUPPLY_STATUS_DISCHARGING

const std::uint8_t yarp::rosmsg::sensor_msgs::BatteryState::POWER_SUPPLY_STATUS_DISCHARGING = 2
static

Definition at line 83 of file BatteryState.h.

◆ POWER_SUPPLY_STATUS_FULL

const std::uint8_t yarp::rosmsg::sensor_msgs::BatteryState::POWER_SUPPLY_STATUS_FULL = 4
static

Definition at line 85 of file BatteryState.h.

◆ POWER_SUPPLY_STATUS_NOT_CHARGING

const std::uint8_t yarp::rosmsg::sensor_msgs::BatteryState::POWER_SUPPLY_STATUS_NOT_CHARGING = 3
static

Definition at line 84 of file BatteryState.h.

◆ POWER_SUPPLY_STATUS_UNKNOWN

const std::uint8_t yarp::rosmsg::sensor_msgs::BatteryState::POWER_SUPPLY_STATUS_UNKNOWN = 0
static

Definition at line 81 of file BatteryState.h.

◆ power_supply_technology

std::uint8_t yarp::rosmsg::sensor_msgs::BatteryState::power_supply_technology

Definition at line 111 of file BatteryState.h.

◆ POWER_SUPPLY_TECHNOLOGY_LIFE

const std::uint8_t yarp::rosmsg::sensor_msgs::BatteryState::POWER_SUPPLY_TECHNOLOGY_LIFE = 4
static

Definition at line 99 of file BatteryState.h.

◆ POWER_SUPPLY_TECHNOLOGY_LIMN

const std::uint8_t yarp::rosmsg::sensor_msgs::BatteryState::POWER_SUPPLY_TECHNOLOGY_LIMN = 6
static

Definition at line 101 of file BatteryState.h.

◆ POWER_SUPPLY_TECHNOLOGY_LION

const std::uint8_t yarp::rosmsg::sensor_msgs::BatteryState::POWER_SUPPLY_TECHNOLOGY_LION = 2
static

Definition at line 97 of file BatteryState.h.

◆ POWER_SUPPLY_TECHNOLOGY_LIPO

const std::uint8_t yarp::rosmsg::sensor_msgs::BatteryState::POWER_SUPPLY_TECHNOLOGY_LIPO = 3
static

Definition at line 98 of file BatteryState.h.

◆ POWER_SUPPLY_TECHNOLOGY_NICD

const std::uint8_t yarp::rosmsg::sensor_msgs::BatteryState::POWER_SUPPLY_TECHNOLOGY_NICD = 5
static

Definition at line 100 of file BatteryState.h.

◆ POWER_SUPPLY_TECHNOLOGY_NIMH

const std::uint8_t yarp::rosmsg::sensor_msgs::BatteryState::POWER_SUPPLY_TECHNOLOGY_NIMH = 1
static

Definition at line 96 of file BatteryState.h.

◆ POWER_SUPPLY_TECHNOLOGY_UNKNOWN

const std::uint8_t yarp::rosmsg::sensor_msgs::BatteryState::POWER_SUPPLY_TECHNOLOGY_UNKNOWN = 0
static

Definition at line 95 of file BatteryState.h.

◆ present

bool yarp::rosmsg::sensor_msgs::BatteryState::present

Definition at line 112 of file BatteryState.h.

◆ serial_number

std::string yarp::rosmsg::sensor_msgs::BatteryState::serial_number

Definition at line 115 of file BatteryState.h.

◆ voltage

yarp::conf::float32_t yarp::rosmsg::sensor_msgs::BatteryState::voltage

Definition at line 103 of file BatteryState.h.


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