Fawkes API  Fawkes Development Version
fawkes::BatteryInterface Class Reference

BatteryInterface Fawkes BlackBoard Interface. More...

#include <>>

Inheritance diagram for fawkes::BatteryInterface:

Classes

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. More...
 
uint32_t current () const
 Get current value. More...
 
void set_current (const uint32_t new_current)
 Set current value. More...
 
size_t maxlenof_current () const
 Get maximum length of current value. More...
 
uint32_t voltage () const
 Get voltage value. More...
 
void set_voltage (const uint32_t new_voltage)
 Set voltage value. More...
 
size_t maxlenof_voltage () const
 Get maximum length of voltage value. More...
 
uint32_t temperature () const
 Get temperature value. More...
 
void set_temperature (const uint32_t new_temperature)
 Set temperature value. More...
 
size_t maxlenof_temperature () const
 Get maximum length of temperature value. More...
 
float absolute_soc () const
 Get absolute_soc value. More...
 
void set_absolute_soc (const float new_absolute_soc)
 Set absolute_soc value. More...
 
size_t maxlenof_absolute_soc () const
 Get maximum length of absolute_soc value. More...
 
float relative_soc () const
 Get relative_soc value. More...
 
void set_relative_soc (const float new_relative_soc)
 Set relative_soc value. More...
 
size_t maxlenof_relative_soc () const
 Get maximum length of relative_soc value. More...
 
virtual Messagecreate_message (const char *type) const
 Create message based on type name. More...
 
virtual void copy_values (const Interface *other)
 Copy values from other interface. More...
 
virtual const char * enum_tostring (const char *enumtype, int val) const
 Convert arbitrary enum value to string. More...
 
- Public Member Functions inherited from fawkes::Interface
virtual ~Interface ()
 Destructor. More...
 
bool oftype (const char *interface_type) const
 Check if interface is of given type. More...
 
const void * datachunk () const
 Get data chunk. More...
 
unsigned int datasize () const
 Get data size. More...
 
const char * type () const
 Get type of interface. More...
 
const char * id () const
 Get identifier of interface. More...
 
const char * uid () const
 Get unique identifier of interface. More...
 
unsigned short serial () const
 Get instance serial of interface. More...
 
unsigned int mem_serial () const
 Get memory serial of interface. More...
 
bool operator== (Interface &comp) const
 Check equality of two interfaces. More...
 
const unsigned char * hash () const
 Get interface hash. More...
 
size_t hash_size () const
 Get size of interface hash. More...
 
const char * hash_printable () const
 Get printable interface hash. More...
 
bool is_writer () const
 Check if this is a writing instance. More...
 
void set_validity (bool valid)
 Mark this interface invalid. More...
 
bool is_valid () const
 Check validity of interface. More...
 
const char * owner () const
 Get owner of interface. More...
 
void set_from_chunk (void *chunk)
 Set from a raw data chunk. More...
 
void resize_buffers (unsigned int num_buffers)
 Resize buffer array. More...
 
unsigned int num_buffers () const
 Get number of buffers. More...
 
void copy_shared_to_buffer (unsigned int buffer)
 Copy data from private memory to buffer. More...
 
void copy_private_to_buffer (unsigned int buffer)
 Copy data from private memory to buffer. More...
 
void read_from_buffer (unsigned int buffer)
 Copy data from buffer to private memory. More...
 
int compare_buffers (unsigned int buffer)
 Compare buffer to private memory. More...
 
Time buffer_timestamp (unsigned int buffer)
 Get time of a buffer. More...
 
void buffer_timestamp (unsigned int buffer, Time *timestamp)
 Get time of a buffer. More...
 
void read ()
 Read from BlackBoard into local copy. More...
 
void write ()
 Write from local copy into BlackBoard memory. More...
 
bool has_writer () const
 Check if there is a writer for the interface. More...
 
unsigned int num_readers () const
 Get the number of readers. More...
 
std::string writer () const
 Get owner name of writing interface instance. More...
 
std::list< std::string > readers () const
 Get owner names of reading interface instances. More...
 
bool changed () const
 Check if data has been changed. More...
 
const Timetimestamp () const
 Get timestamp of last write. More...
 
void set_auto_timestamping (bool enabled)
 Enable or disable automated timestamping. More...
 
void set_timestamp (const Time *t=NULL)
 Set timestamp. More...
 
void set_clock (Clock *clock)
 Set clock to use for timestamping. More...
 
void mark_data_changed ()
 Mark data as changed. More...
 
std::list< const char * > get_message_types ()
 Obtain a list of textual representations of the message types available for this interface. More...
 
unsigned int msgq_enqueue (Message *message)
 Enqueue message at end of queue. More...
 
unsigned int msgq_enqueue_copy (Message *message)
 Enqueue copy of message at end of queue. More...
 
void msgq_remove (Message *message)
 Remove message from queue. More...
 
void msgq_remove (unsigned int message_id)
 Remove message from queue. More...
 
unsigned int msgq_size ()
 Get size of message queue. More...
 
void msgq_flush ()
 Flush all messages. More...
 
void msgq_lock ()
 Lock message queue. More...
 
bool msgq_try_lock ()
 Try to lock message queue. More...
 
void msgq_unlock ()
 Unlock message queue. More...
 
void msgq_pop ()
 Erase first message from queue. More...
 
Messagemsgq_first ()
 Get the first message from the message queue. More...
 
bool msgq_empty ()
 Check if queue is empty. More...
 
void msgq_append (Message *message)
 Enqueue message. More...
 
template<class MessageType >
bool msgq_first_is ()
 Check if first message has desired type. More...
 
template<class MessageType >
MessageType * msgq_first ()
 Get first message casted to the desired type. More...
 
template<class MessageType >
MessageType * msgq_first (MessageType *&msg)
 Get first message casted to the desired type. More...
 
template<class MessageType >
MessageType * msgq_first_safe (MessageType *&msg) throw ()
 Get first message casted to the desired type without exceptions. More...
 
MessageQueue::MessageIterator msgq_begin ()
 Get start iterator for message queue. More...
 
MessageQueue::MessageIterator msgq_end ()
 Get end iterator for message queue. More...
 
InterfaceFieldIterator fields ()
 Get iterator over all fields of this interface instance. More...
 
InterfaceFieldIterator fields_end ()
 Invalid iterator. More...
 
unsigned int num_fields ()
 Get the number of fields in the interface. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from fawkes::Interface
static void parse_uid (const char *uid, std::string &type, std::string &id)
 Parse UID to type and ID strings. More...
 
- Protected Member Functions inherited from fawkes::Interface
 Interface ()
 Constructor. More...
 
void set_hash (unsigned char *ihash)
 Set hash. More...
 
void add_fieldinfo (interface_fieldtype_t type, const char *name, size_t length, void *value, const char *enumtype=0, const interface_enum_map_t *enum_map=0)
 Add an entry to the field info list. More...
 
void add_messageinfo (const char *name)
 Add an entry to the message info list. More...
 
- Protected Attributes inherited from fawkes::Interface
void * data_ptr
 Pointer to local memory storage. More...
 
unsigned int data_size
 Minimal data size to hold data storage. More...
 
bool data_changed
 Indicator if data has changed. More...
 
interface_data_ts_tdata_ts
 Pointer to data casted to timestamp struct. More...
 

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

◆ absolute_soc()

float fawkes::BatteryInterface::absolute_soc ( ) const

Get absolute_soc value.

Absolute state of charge [%]

Returns
absolute_soc value

Definition at line 168 of file BatteryInterface.cpp.

Referenced by BatteryMonitorTreeView::rem_host(), and Roomba500Thread::write_blackboard().

◆ copy_values()

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 244 of file BatteryInterface.cpp.

References fawkes::Interface::type().

◆ create_message()

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 227 of file BatteryInterface.cpp.

◆ current()

uint32_t fawkes::BatteryInterface::current ( ) const

Get current value.

Battery Current [mA]

Returns
current value

Definition at line 75 of file BatteryInterface.cpp.

Referenced by BatteryMonitorTreeView::rem_host().

◆ enum_tostring()

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 255 of file BatteryInterface.cpp.

◆ maxlenof_absolute_soc()

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 178 of file BatteryInterface.cpp.

◆ maxlenof_current()

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 85 of file BatteryInterface.cpp.

◆ maxlenof_relative_soc()

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 209 of file BatteryInterface.cpp.

◆ maxlenof_temperature()

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 147 of file BatteryInterface.cpp.

◆ maxlenof_voltage()

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 116 of file BatteryInterface.cpp.

◆ message_valid()

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 358 of file BatteryInterface.cpp.

◆ relative_soc()

float fawkes::BatteryInterface::relative_soc ( ) const

Get relative_soc value.

Relative state of charge [%]

Returns
relative_soc value

Definition at line 199 of file BatteryInterface.cpp.

Referenced by BatteryMonitorTreeView::rem_host().

◆ set_absolute_soc()

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 188 of file BatteryInterface.cpp.

Referenced by RobotinoSensorThread::loop(), and Roomba500Thread::write_blackboard().

◆ set_current()

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

Set current value.

Battery Current [mA]

Parameters
new_currentnew current value

Definition at line 95 of file BatteryInterface.cpp.

Referenced by RobotinoSensorThread::loop(), and Roomba500Thread::write_blackboard().

◆ set_relative_soc()

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 219 of file BatteryInterface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_temperature()

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

Set temperature value.

Battery Temperature [°C]

Parameters
new_temperaturenew temperature value

Definition at line 157 of file BatteryInterface.cpp.

Referenced by Roomba500Thread::write_blackboard().

◆ set_voltage()

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

Set voltage value.

Battery Voltage [mV]

Parameters
new_voltagenew voltage value

Definition at line 126 of file BatteryInterface.cpp.

Referenced by RobotinoSensorThread::loop(), and Roomba500Thread::write_blackboard().

◆ temperature()

uint32_t fawkes::BatteryInterface::temperature ( ) const

Get temperature value.

Battery Temperature [°C]

Returns
temperature value

Definition at line 137 of file BatteryInterface.cpp.

◆ voltage()

uint32_t fawkes::BatteryInterface::voltage ( ) const

Get voltage value.

Battery Voltage [mV]

Returns
voltage value

Definition at line 106 of file BatteryInterface.cpp.

Referenced by BatteryMonitorTreeView::rem_host().


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