Fawkes API  Fawkes Development Version
fawkes::BatteryInterface Class Reference

BatteryInterface Fawkes BlackBoard Interface. More...

#include <>>

Inheritance diagram for fawkes::BatteryInterface:

List of all members.

Classes

struct  BatteryInterface_data_t
 Internal data storage, do NOT modify! More...
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.
uint32_t current () const
 Get current value.
void set_current (const uint32_t new_current)
 Set current value.
size_t maxlenof_current () const
 Get maximum length of current value.
uint32_t voltage () const
 Get voltage value.
void set_voltage (const uint32_t new_voltage)
 Set voltage value.
size_t maxlenof_voltage () const
 Get maximum length of voltage value.
uint32_t temperature () const
 Get temperature value.
void set_temperature (const uint32_t 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 Messagecreate_message (const char *type) const
 Create message based on type name.
virtual void copy_values (const Interface *other)
 Copy values from other interface.
virtual const char * enum_tostring (const char *enumtype, int val) const
 Convert arbitrary enum value to string.

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


Member Function Documentation

float fawkes::BatteryInterface::absolute_soc ( ) const

Get absolute_soc value.

Absolute state of charge [%]

Returns:
absolute_soc value

Definition at line 166 of file BatteryInterface.cpp.

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

Copy values from other interface.

Parameters:
otherother interface to copy values from

Implements fawkes::Interface.

Definition at line 242 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:
typemessage type
Returns:
message of the given type, empty
Exceptions:
UnknownTypeExceptionthrown if this interface cannot create a message of the given type.

Implements fawkes::Interface.

Definition at line 225 of file BatteryInterface.cpp.

uint32_t fawkes::BatteryInterface::current ( ) const

Get current value.

Battery Current [mA]

Returns:
current value

Definition at line 73 of file BatteryInterface.cpp.

const char * fawkes::BatteryInterface::enum_tostring ( const char *  enumtype,
int  val 
) const [virtual]

Convert arbitrary enum value to string.

Given the string representation of the enum type and the value this method returns the string representation of the specific value, or the string UNKNOWN if the value is not defined. An exception is thrown if the enum type is invalid.

Parameters:
enumtypeenum type as string
valvalue to convert
Returns:
string representation of value
Exceptions:
UnknownTypeExceptionthrown if enumtype is not specified for interface.

Implements fawkes::Interface.

Definition at line 253 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 176 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 83 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 207 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 145 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 114 of file BatteryInterface.cpp.

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

Check if message is valid and can be enqueued.

Parameters:
messageMessage to check
Returns:
true if the message is valid, false otherwise.

Implements fawkes::Interface.

Definition at line 356 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 197 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_socnew absolute_soc value

Definition at line 186 of file BatteryInterface.cpp.

void fawkes::BatteryInterface::set_current ( const uint32_t  new_current)

Set current value.

Battery Current [mA]

Parameters:
new_currentnew current value

Definition at line 93 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_socnew relative_soc value

Definition at line 217 of file BatteryInterface.cpp.

void fawkes::BatteryInterface::set_temperature ( const uint32_t  new_temperature)

Set temperature value.

Battery Temperature [°C]

Parameters:
new_temperaturenew temperature value

Definition at line 155 of file BatteryInterface.cpp.

void fawkes::BatteryInterface::set_voltage ( const uint32_t  new_voltage)

Set voltage value.

Battery Voltage [mV]

Parameters:
new_voltagenew voltage value

Definition at line 124 of file BatteryInterface.cpp.

uint32_t fawkes::BatteryInterface::temperature ( ) const

Get temperature value.

Battery Temperature [°C]

Returns:
temperature value

Definition at line 135 of file BatteryInterface.cpp.

uint32_t fawkes::BatteryInterface::voltage ( ) const

Get voltage value.

Battery Voltage [mV]

Returns:
voltage value

Definition at line 104 of file BatteryInterface.cpp.


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