Fawkes API
Fawkes Development Version
|
#include <>>
Classes | |
class | PushButtonMessage |
class | SleepMessage |
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 Message * | create_message (const char *type) const |
virtual void | copy_values (const Interface *other) |
Copy values from other interface. More... | |
virtual const char * | enum_tostring (const char *enumtype, int val) const |
![]() | |
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 Time * | timestamp () 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... | |
Message * | msgq_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 void | parse_uid (const char *uid, std::string &type, std::string &id) |
Parse UID to type and ID strings. More... | |
![]() | |
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... | |
![]() | |
void * | data_ptr |
unsigned int | data_size |
bool | data_changed |
interface_data_ts_t * | data_ts |
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 37 of file BatteryInterface.h.
float fawkes::BatteryInterface::absolute_soc | ( | ) | const |
Get absolute_soc value.
Absolute state of charge [%]
Definition at line 172 of file BatteryInterface.cpp.
Referenced by Roomba500Thread::write_blackboard().
|
virtual |
Copy values from other interface.
other | other interface to copy values from |
Implements fawkes::Interface.
Definition at line 248 of file BatteryInterface.cpp.
|
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.
type | message type |
UnknownTypeException | thrown if this interface cannot create a message of the given type. |
Implements fawkes::Interface.
Definition at line 231 of file BatteryInterface.cpp.
uint32_t fawkes::BatteryInterface::current | ( | ) | const |
Get current value.
Battery Current [mA]
Definition at line 79 of file BatteryInterface.cpp.
|
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.
enumtype | enum type as string |
val | value to convert |
UnknownTypeException | thrown if enumtype is not specified for interface. |
Implements fawkes::Interface.
Definition at line 259 of file BatteryInterface.cpp.
References fawkes::Interface::data_ptr, and fawkes::Interface::data_size.
size_t fawkes::BatteryInterface::maxlenof_absolute_soc | ( | ) | const |
Get maximum length of absolute_soc value.
Definition at line 182 of file BatteryInterface.cpp.
References fawkes::Interface::data_changed.
size_t fawkes::BatteryInterface::maxlenof_current | ( | ) | const |
Get maximum length of current value.
Definition at line 89 of file BatteryInterface.cpp.
References fawkes::Interface::data_changed.
size_t fawkes::BatteryInterface::maxlenof_relative_soc | ( | ) | const |
Get maximum length of relative_soc value.
Definition at line 213 of file BatteryInterface.cpp.
References fawkes::Interface::data_changed.
size_t fawkes::BatteryInterface::maxlenof_temperature | ( | ) | const |
Get maximum length of temperature value.
Definition at line 151 of file BatteryInterface.cpp.
References fawkes::Interface::data_changed.
size_t fawkes::BatteryInterface::maxlenof_voltage | ( | ) | const |
Get maximum length of voltage value.
Definition at line 120 of file BatteryInterface.cpp.
References fawkes::Interface::data_changed.
|
virtual |
Check if message is valid and can be enqueued.
message | Message to check |
Implements fawkes::Interface.
Definition at line 362 of file BatteryInterface.cpp.
float fawkes::BatteryInterface::relative_soc | ( | ) | const |
Get relative_soc value.
Relative state of charge [%]
Definition at line 203 of file BatteryInterface.cpp.
void fawkes::BatteryInterface::set_absolute_soc | ( | const float | new_absolute_soc | ) |
Set absolute_soc value.
Absolute state of charge [%]
new_absolute_soc | new absolute_soc value |
Definition at line 192 of file BatteryInterface.cpp.
Referenced by RobotinoSensorThread::loop(), and Roomba500Thread::write_blackboard().
void fawkes::BatteryInterface::set_current | ( | const uint32_t | new_current | ) |
Set current value.
Battery Current [mA]
new_current | new current value |
Definition at line 99 of file BatteryInterface.cpp.
Referenced by RobotinoSensorThread::loop(), and Roomba500Thread::write_blackboard().
void fawkes::BatteryInterface::set_relative_soc | ( | const float | new_relative_soc | ) |
Set relative_soc value.
Relative state of charge [%]
new_relative_soc | new relative_soc value |
Definition at line 223 of file BatteryInterface.cpp.
Referenced by Roomba500Thread::write_blackboard().
void fawkes::BatteryInterface::set_temperature | ( | const uint32_t | new_temperature | ) |
Set temperature value.
Battery Temperature [°C]
new_temperature | new temperature value |
Definition at line 161 of file BatteryInterface.cpp.
Referenced by Roomba500Thread::write_blackboard().
void fawkes::BatteryInterface::set_voltage | ( | const uint32_t | new_voltage | ) |
Set voltage value.
Battery Voltage [mV]
new_voltage | new voltage value |
Definition at line 130 of file BatteryInterface.cpp.
Referenced by RobotinoSensorThread::loop(), and Roomba500Thread::write_blackboard().
uint32_t fawkes::BatteryInterface::temperature | ( | ) | const |
Get temperature value.
Battery Temperature [°C]
Definition at line 141 of file BatteryInterface.cpp.
uint32_t fawkes::BatteryInterface::voltage | ( | ) | const |
Get voltage value.
Battery Voltage [mV]
Definition at line 110 of file BatteryInterface.cpp.