Fawkes API Fawkes Development Version

fawkes::LocalizerControlInterface Class Reference

LocalizerControlInterface Fawkes BlackBoard Interface. More...

#include <>>

Inheritance diagram for fawkes::LocalizerControlInterface:

List of all members.

Classes

struct  LocalizerControlInterface_data_t
 Internal data storage, do NOT modify!
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 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

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.)

Definition at line 33 of file LocalizerControlInterface.h.


Member Function Documentation

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

Copy values from other interface.

Parameters:
otherother interface to copy values from

Implements fawkes::Interface.

Definition at line 115 of file LocalizerControlInterface.cpp.

References 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.

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 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.

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 126 of file LocalizerControlInterface.cpp.

char * fawkes::LocalizerControlInterface::map_name ( ) const

Get map_name value.

The name of the current map

Returns:
map_name value

Definition at line 71 of file LocalizerControlInterface.cpp.

size_t fawkes::LocalizerControlInterface::maxlenof_map_name ( ) const

Get maximum length of map_name value.

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

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.

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

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

Parameters:
new_map_namenew map_name value

Definition at line 92 of file LocalizerControlInterface.cpp.

References fawkes::Interface::data_changed.


The documentation for this class was generated from the following files:
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends