Fawkes API  Fawkes Development Version
fawkes::KatanaInterface::SetPlannerParamsMessage Class Reference

SetPlannerParamsMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::KatanaInterface::SetPlannerParamsMessage:

List of all members.

Classes

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

Public Member Functions

 SetPlannerParamsMessage (const char *ini_plannerparams, const bool ini_straight)
 Constructor with initial values.
 SetPlannerParamsMessage ()
 Constructor.
 ~SetPlannerParamsMessage ()
 Destructor.
 SetPlannerParamsMessage (const SetPlannerParamsMessage *m)
 Copy constructor.
char * plannerparams () const
 Get plannerparams value.
void set_plannerparams (const char *new_plannerparams)
 Set plannerparams value.
size_t maxlenof_plannerparams () const
 Get maximum length of plannerparams value.
bool is_straight () const
 Get straight value.
void set_straight (const bool new_straight)
 Set straight value.
size_t maxlenof_straight () const
 Get maximum length of straight value.
virtual Messageclone () const
 Clone this message.

Detailed Description


Constructor & Destructor Documentation

fawkes::KatanaInterface::SetPlannerParamsMessage::SetPlannerParamsMessage ( const char *  ini_plannerparams,
const bool  ini_straight 
)
fawkes::KatanaInterface::SetPlannerParamsMessage::~SetPlannerParamsMessage ( )

Destructor.

Definition at line 2127 of file KatanaInterface.cpp.

References fawkes::Interface::data_ptr.

fawkes::KatanaInterface::SetPlannerParamsMessage::SetPlannerParamsMessage ( const SetPlannerParamsMessage m)

Copy constructor.

Parameters:
mmessage to copy from

Definition at line 2135 of file KatanaInterface.cpp.

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


Member Function Documentation

Message * fawkes::KatanaInterface::SetPlannerParamsMessage::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 2211 of file KatanaInterface.cpp.

bool fawkes::KatanaInterface::SetPlannerParamsMessage::is_straight ( ) const

Get straight value.

Parameters for straight movement?

Returns:
straight value

Definition at line 2180 of file KatanaInterface.cpp.

size_t fawkes::KatanaInterface::SetPlannerParamsMessage::maxlenof_plannerparams ( ) const

Get maximum length of plannerparams value.

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

Definition at line 2160 of file KatanaInterface.cpp.

size_t fawkes::KatanaInterface::SetPlannerParamsMessage::maxlenof_straight ( ) const

Get maximum length of straight value.

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

Definition at line 2190 of file KatanaInterface.cpp.

char * fawkes::KatanaInterface::SetPlannerParamsMessage::plannerparams ( ) const

Get plannerparams value.

Planner parameters

Returns:
plannerparams value

Definition at line 2150 of file KatanaInterface.cpp.

Referenced by KatanaActThread::loop().

void fawkes::KatanaInterface::SetPlannerParamsMessage::set_plannerparams ( const char *  new_plannerparams)

Set plannerparams value.

Planner parameters

Parameters:
new_plannerparamsnew plannerparams value

Definition at line 2170 of file KatanaInterface.cpp.

void fawkes::KatanaInterface::SetPlannerParamsMessage::set_straight ( const bool  new_straight)

Set straight value.

Parameters for straight movement?

Parameters:
new_straightnew straight value

Definition at line 2200 of file KatanaInterface.cpp.


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