fawkes::BatteryInterface Class Reference
[Fawkes Interfaces]

BatteryInterface Fawkes BlackBoard Interface. More...

#include <interfaces/BatteryInterface.h>

Inheritance diagram for fawkes::BatteryInterface:

Inheritance graph
[legend]

List of all members.


Classes

struct  BatteryInterface_data_t
 Internal data storage, do NOT modify!
class  PushButtonMessage
 PushButtonMessage Fawkes BlackBoard Interface Message. More...
class  SleepMessage
 SleepMessage Fawkes BlackBoard Interface Message. More...

Public Member Functions

virtual bool message_valid (const Message *message) const
 Check if message is valid and can be enqueued.
unsigned int current () const
 Get current value.
void set_current (const unsigned int new_current)
 Set current value.
size_t maxlenof_current () const
 Get maximum length of current value.
unsigned int voltage () const
 Get voltage value.
void set_voltage (const unsigned int new_voltage)
 Set voltage value.
size_t maxlenof_voltage () const
 Get maximum length of voltage value.
unsigned int temperature () const
 Get temperature value.
void set_temperature (const unsigned int new_temperature)
 Set temperature value.
size_t maxlenof_temperature () const
 Get maximum length of temperature value.
float absolute_soc () const
 Get absolute_soc value.
void set_absolute_soc (const float new_absolute_soc)
 Set absolute_soc value.
size_t maxlenof_absolute_soc () const
 Get maximum length of absolute_soc value.
float relative_soc () const
 Get relative_soc value.
void set_relative_soc (const float new_relative_soc)
 Set relative_soc value.
size_t maxlenof_relative_soc () const
 Get maximum length of relative_soc value.
virtual Message * create_message (const char *type) const
 Create message based on type name.
virtual void copy_values (const Interface *other)
 Copy values from other interface.

Detailed Description

BatteryInterface Fawkes BlackBoard Interface.

This interface contains status information about the battery. In addition to this it allows to send messages which turn the battery on/off

Definition at line 33 of file BatteryInterface.h.

Member Function Documentation

float fawkes::BatteryInterface::absolute_soc (  )  const

Get absolute_soc value.

Absolute state of charge [%]

Returns:
absolute_soc value

Definition at line 162 of file BatteryInterface.cpp.

void fawkes::BatteryInterface::copy_values ( const Interface *  other  )  [virtual]

Copy values from other interface.

Parameters:
other other interface to copy values from

Implements fawkes::Interface.

Definition at line 236 of file BatteryInterface.cpp.

References fawkes::Interface::type().

Message * fawkes::BatteryInterface::create_message ( const char *  type  )  const [virtual]

Create message based on type name.

This will create a new message of the given type. The type must be given without the InterfaceName:: prefix but just the plain class name of the message.

Parameters:
type message type
Returns:
message of the given type, empty
Exceptions:
UnknownTypeException thrown if this interface cannot create a message of the given type.

Implements fawkes::Interface.

Definition at line 219 of file BatteryInterface.cpp.

unsigned int fawkes::BatteryInterface::current (  )  const

Get current value.

Battery Current [mA]

Returns:
current value

Definition at line 72 of file BatteryInterface.cpp.

size_t fawkes::BatteryInterface::maxlenof_absolute_soc (  )  const

Get maximum length of absolute_soc value.

Returns:
length of absolute_soc value, can be length of the array or number of maximum number of characters for a string

Definition at line 172 of file BatteryInterface.cpp.

size_t fawkes::BatteryInterface::maxlenof_current (  )  const

Get maximum length of current value.

Returns:
length of current value, can be length of the array or number of maximum number of characters for a string

Definition at line 82 of file BatteryInterface.cpp.

size_t fawkes::BatteryInterface::maxlenof_relative_soc (  )  const

Get maximum length of relative_soc value.

Returns:
length of relative_soc value, can be length of the array or number of maximum number of characters for a string

Definition at line 202 of file BatteryInterface.cpp.

size_t fawkes::BatteryInterface::maxlenof_temperature (  )  const

Get maximum length of temperature value.

Returns:
length of temperature value, can be length of the array or number of maximum number of characters for a string

Definition at line 142 of file BatteryInterface.cpp.

size_t fawkes::BatteryInterface::maxlenof_voltage (  )  const

Get maximum length of voltage value.

Returns:
length of voltage value, can be length of the array or number of maximum number of characters for a string

Definition at line 112 of file BatteryInterface.cpp.

bool fawkes::BatteryInterface::message_valid ( const Message *  message  )  const [virtual]

Check if message is valid and can be enqueued.

Parameters:
message Message to check

Implements fawkes::Interface.

Definition at line 329 of file BatteryInterface.cpp.

float fawkes::BatteryInterface::relative_soc (  )  const

Get relative_soc value.

Relative state of charge [%]

Returns:
relative_soc value

Definition at line 192 of file BatteryInterface.cpp.

void fawkes::BatteryInterface::set_absolute_soc ( const float  new_absolute_soc  ) 

Set absolute_soc value.

Absolute state of charge [%]

Parameters:
new_absolute_soc new absolute_soc value

Definition at line 182 of file BatteryInterface.cpp.

void fawkes::BatteryInterface::set_current ( const unsigned int  new_current  ) 

Set current value.

Battery Current [mA]

Parameters:
new_current new current value

Definition at line 92 of file BatteryInterface.cpp.

void fawkes::BatteryInterface::set_relative_soc ( const float  new_relative_soc  ) 

Set relative_soc value.

Relative state of charge [%]

Parameters:
new_relative_soc new relative_soc value

Definition at line 212 of file BatteryInterface.cpp.

void fawkes::BatteryInterface::set_temperature ( const unsigned int  new_temperature  ) 

Set temperature value.

Battery Temperature [°C]

Parameters:
new_temperature new temperature value

Definition at line 152 of file BatteryInterface.cpp.

void fawkes::BatteryInterface::set_voltage ( const unsigned int  new_voltage  ) 

Set voltage value.

Battery Voltage [mV]

Parameters:
new_voltage new voltage value

Definition at line 122 of file BatteryInterface.cpp.

unsigned int fawkes::BatteryInterface::temperature (  )  const

Get temperature value.

Battery Temperature [°C]

Returns:
temperature value

Definition at line 132 of file BatteryInterface.cpp.

unsigned int fawkes::BatteryInterface::voltage (  )  const

Get voltage value.

Battery Voltage [mV]

Returns:
voltage value

Definition at line 102 of file BatteryInterface.cpp.

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