fawkes::NavigatorInterface::PlaceGotoMessage Class Reference

PlaceGotoMessage Fawkes BlackBoard Interface Message. More...

#include <interfaces/NavigatorInterface.h>

Inheritance diagram for fawkes::NavigatorInterface::PlaceGotoMessage:
Inheritance graph
[legend]

List of all members.

Classes

struct  PlaceGotoMessage_data_t
 Internal data storage, do NOT modify!

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

PlaceGotoMessage Fawkes BlackBoard Interface Message.

Definition at line 211 of file NavigatorInterface.h.


Constructor & Destructor Documentation

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

Constructor with initial values.

Parameters:
ini_place initial value for place

Definition at line 1087 of file NavigatorInterface.cpp.

References fawkes::Message::add_fieldinfo(), fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, and fawkes::IFT_STRING.

fawkes::NavigatorInterface::PlaceGotoMessage::PlaceGotoMessage (  ) 
fawkes::NavigatorInterface::PlaceGotoMessage::~PlaceGotoMessage (  ) 

Destructor.

Definition at line 1109 of file NavigatorInterface.cpp.

References fawkes::Message::data_ptr.

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

Copy constructor.

Parameters:
m message to copy from

Definition at line 1117 of file NavigatorInterface.cpp.

References fawkes::Message::data_ptr, fawkes::Message::data_size, 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.

References PlaceGotoMessage().

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_place new place value

Definition at line 1152 of file NavigatorInterface.cpp.


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

Generated on 1 Mar 2011 for Fawkes API by  doxygen 1.6.1