Fawkes API
Fawkes Development Version
|
SetPlannerParamsMessage Fawkes BlackBoard Interface Message. More...
#include <>>
Classes | |
struct | SetPlannerParamsMessage_data_t |
Internal data storage, do NOT modify! |
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 Message * | clone () const |
Clone this message. | |
![]() | |
Message (const char *type) | |
Constructor. | |
Message (const Message *mesg) | |
Copy constructor. | |
Message (const Message &mesg) | |
Copy constructor. | |
virtual | ~Message () |
Destructor. | |
Message & | operator= (const Message &m) |
Assign this message to given message. | |
unsigned int | id () const |
Get message ID. | |
void | set_id (unsigned int message_id) |
Set message ID. | |
void | mark_enqueued () |
Mark message as being enqueued. | |
bool | enqueued () const |
Check is message has been enqueued. | |
const Time * | time_enqueued () const |
Get time when message was enqueued. | |
unsigned int | sender_id () const |
Get ID of sender. | |
const char * | sender_thread_name () const |
Get sender of message. | |
Interface * | interface () const |
Get transmitting interface. | |
const char * | type () const |
Get message type. | |
InterfaceFieldIterator | fields () |
Get iterator over all fields of this interface instance. | |
InterfaceFieldIterator | fields_end () |
Invalid iterator. | |
unsigned int | num_fields () const |
Get the number of fields in the message. | |
const void * | datachunk () const |
Get pointer to data. | |
unsigned int | datasize () const |
Get size of data. | |
unsigned int | hops () const |
Get number of hops. | |
void | set_hops (unsigned int hops) |
Set number of hops. | |
void | set_from_chunk (const void *chunk) |
Set from raw data chunk. | |
unsigned int | recipient () const |
Get recipient memory serial. | |
template<class MessageType > | |
bool | is_of_type () |
Check if message has desired type. | |
![]() | |
RefCount () | |
Constructor. | |
virtual | ~RefCount () |
Destructor. | |
void | ref () |
Increment reference count. | |
void | unref () |
Decrement reference count and conditionally delete this instance. | |
unsigned int | refcount () |
Get reference count for this instance. |
Additional Inherited Members | |
![]() | |
void | add_fieldinfo (interface_fieldtype_t type, const char *name, size_t length, void *value, const char *enumtype=0) |
Add an entry to the info list. | |
![]() | |
void * | data_ptr |
Pointer to memory that contains local data. | |
unsigned int | data_size |
Size of memory needed to hold all data. | |
message_data_ts_t * | data_ts |
data timestamp aliasing pointer |
SetPlannerParamsMessage Fawkes BlackBoard Interface Message.
Definition at line 440 of file KatanaInterface.h.
fawkes::KatanaInterface::SetPlannerParamsMessage::SetPlannerParamsMessage | ( | const char * | ini_plannerparams, |
const bool | ini_straight | ||
) |
Constructor with initial values.
ini_plannerparams | initial value for plannerparams |
ini_straight | initial value for straight |
Definition at line 2102 of file KatanaInterface.cpp.
References fawkes::Message::add_fieldinfo(), fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, fawkes::IFT_BOOL, and fawkes::IFT_STRING.
fawkes::KatanaInterface::SetPlannerParamsMessage::SetPlannerParamsMessage | ( | ) |
Constructor.
Definition at line 2115 of file KatanaInterface.cpp.
References fawkes::Message::add_fieldinfo(), fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, fawkes::IFT_BOOL, and fawkes::IFT_STRING.
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.
m | message to copy from |
Definition at line 2135 of file KatanaInterface.cpp.
References fawkes::Message::data_ptr, fawkes::Message::data_size, and fawkes::Message::data_ts.
|
virtual |
Clone this message.
Produces a message of the same type as this message and copies the data to the new 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?
Definition at line 2180 of file KatanaInterface.cpp.
size_t fawkes::KatanaInterface::SetPlannerParamsMessage::maxlenof_plannerparams | ( | ) | const |
Get maximum length of plannerparams value.
Definition at line 2160 of file KatanaInterface.cpp.
size_t fawkes::KatanaInterface::SetPlannerParamsMessage::maxlenof_straight | ( | ) | const |
Get maximum length of straight value.
Definition at line 2190 of file KatanaInterface.cpp.
char * fawkes::KatanaInterface::SetPlannerParamsMessage::plannerparams | ( | ) | const |
Get plannerparams value.
Planner parameters
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
new_plannerparams | new 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?
new_straight | new straight value |
Definition at line 2200 of file KatanaInterface.cpp.