Fawkes API
Fawkes Development Version
|
LocalizerControlInterface Fawkes BlackBoard Interface. More...
#include <>>
Classes | |
struct | LocalizerControlInterface_data_t |
Internal data storage, do NOT modify! More... | |
class | ResetMessage |
ResetMessage 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. | |
char * | map_name () const |
Get map_name value. | |
void | set_map_name (const char *new_map_name) |
Set map_name value. | |
size_t | maxlenof_map_name () const |
Get maximum length of map_name 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. | |
virtual const char * | enum_tostring (const char *enumtype, int val) const |
Convert arbitrary enum value to string. |
LocalizerControlInterface Fawkes BlackBoard Interface.
This interface allows observe the current status of the a localizer as well as sending it commands (eg., reset, re-position, etc.)
void fawkes::LocalizerControlInterface::copy_values | ( | const Interface * | other | ) | [virtual] |
Copy values from other interface.
other | other interface to copy values from |
Implements fawkes::Interface.
Definition at line 115 of file LocalizerControlInterface.cpp.
References fawkes::Message::type(), and fawkes::Interface::type().
Message * fawkes::LocalizerControlInterface::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.
type | message type |
UnknownTypeException | thrown if this interface cannot create a message of the given type. |
Implements fawkes::Interface.
Definition at line 100 of file LocalizerControlInterface.cpp.
const char * fawkes::LocalizerControlInterface::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.
enumtype | enum type as string |
val | value to convert |
UnknownTypeException | thrown if enumtype is not specified for interface. |
Implements fawkes::Interface.
Definition at line 126 of file LocalizerControlInterface.cpp.
char * fawkes::LocalizerControlInterface::map_name | ( | ) | const |
Get map_name value.
The name of the current map
Definition at line 71 of file LocalizerControlInterface.cpp.
size_t fawkes::LocalizerControlInterface::maxlenof_map_name | ( | ) | const |
Get maximum length of map_name value.
Definition at line 81 of file LocalizerControlInterface.cpp.
bool fawkes::LocalizerControlInterface::message_valid | ( | const Message * | message | ) | const [virtual] |
Check if message is valid and can be enqueued.
message | Message to check |
Implements fawkes::Interface.
Definition at line 329 of file LocalizerControlInterface.cpp.
void fawkes::LocalizerControlInterface::set_map_name | ( | const char * | new_map_name | ) |
Set map_name value.
The name of the current map
new_map_name | new map_name value |
Definition at line 92 of file LocalizerControlInterface.cpp.
References fawkes::Interface::data_changed.