Fawkes API  Fawkes Development Version
fawkes::NavigatorInterface::PlaceGotoMessage Class Reference

PlaceGotoMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::NavigatorInterface::PlaceGotoMessage:

List of all members.

Classes

struct  PlaceGotoMessage_data_t
 Internal data storage, do NOT modify! More...

Public Member Functions

 PlaceGotoMessage (const char *ini_place)
 Constructor with initial values.
 PlaceGotoMessage ()
 Constructor.
 ~PlaceGotoMessage ()
 Destructor.
 PlaceGotoMessage (const PlaceGotoMessage *m)
 Copy constructor.
char * place () const
 Get place value.
void set_place (const char *new_place)
 Set place value.
size_t maxlenof_place () const
 Get maximum length of place value.
virtual Messageclone () const
 Clone this message.

Detailed Description


Constructor & Destructor Documentation

fawkes::NavigatorInterface::PlaceGotoMessage::PlaceGotoMessage ( const char *  ini_place)
fawkes::NavigatorInterface::PlaceGotoMessage::~PlaceGotoMessage ( )

Destructor.

Definition at line 1109 of file NavigatorInterface.cpp.

References fawkes::Interface::data_ptr.

fawkes::NavigatorInterface::PlaceGotoMessage::PlaceGotoMessage ( const PlaceGotoMessage m)

Copy constructor.

Parameters:
mmessage to copy from

Definition at line 1117 of file NavigatorInterface.cpp.

References fawkes::Message::data_size, fawkes::Message::data_ptr, and fawkes::Message::data_ts.


Member Function Documentation

Message * fawkes::NavigatorInterface::PlaceGotoMessage::clone ( ) const [virtual]

Clone this message.

Produces a message of the same type as this message and copies the data to the new message.

Returns:
clone of this message

Reimplemented from fawkes::Message.

Definition at line 1163 of file NavigatorInterface.cpp.

size_t fawkes::NavigatorInterface::PlaceGotoMessage::maxlenof_place ( ) const

Get maximum length of place value.

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

Definition at line 1142 of file NavigatorInterface.cpp.

char * fawkes::NavigatorInterface::PlaceGotoMessage::place ( ) const

Get place value.

Place to go to.

Returns:
place value

Definition at line 1132 of file NavigatorInterface.cpp.

void fawkes::NavigatorInterface::PlaceGotoMessage::set_place ( const char *  new_place)

Set place value.

Place to go to.

Parameters:
new_placenew place value

Definition at line 1152 of file NavigatorInterface.cpp.


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