Fawkes API
Fawkes Development Version
|
SetEscapingMessage Fawkes BlackBoard Interface Message. More...
#include <>>
Public Member Functions | |
SetEscapingMessage (const bool ini_escaping_enabled) | |
Constructor with initial values. More... | |
SetEscapingMessage () | |
Constructor. More... | |
~SetEscapingMessage () | |
Destructor. More... | |
SetEscapingMessage (const SetEscapingMessage *m) | |
Copy constructor. More... | |
bool | is_escaping_enabled () const |
Get escaping_enabled value. More... | |
void | set_escaping_enabled (const bool new_escaping_enabled) |
Set escaping_enabled value. More... | |
size_t | maxlenof_escaping_enabled () const |
Get maximum length of escaping_enabled value. More... | |
virtual Message * | clone () const |
Clone this message. More... | |
![]() | |
Message (const char *type) | |
Constructor. More... | |
Message (const Message *mesg) | |
Copy constructor. More... | |
Message (const Message &mesg) | |
Copy constructor. More... | |
virtual | ~Message () |
Destructor. More... | |
Message & | operator= (const Message &m) |
Assign this message to given message. More... | |
unsigned int | id () const |
Get message ID. More... | |
void | set_id (unsigned int message_id) |
Set message ID. More... | |
void | mark_enqueued () |
Mark message as being enqueued. More... | |
bool | enqueued () const |
Check is message has been enqueued. More... | |
const Time * | time_enqueued () const |
Get time when message was enqueued. More... | |
Uuid | sender_id () const |
Get ID of the immediate sender, not necessarily the creator of the message. More... | |
Uuid | source_id () const |
Get ID of the original source of the message. More... | |
void | set_sender_id (const Uuid &id) |
Set sender ID. More... | |
void | set_source_id (const Uuid &id) |
Set source ID. More... | |
const char * | sender_thread_name () const |
Get sender of message. More... | |
Interface * | interface () const |
Get transmitting interface. More... | |
const char * | type () const |
Get message type. More... | |
InterfaceFieldIterator | fields () |
Get iterator over all fields of this interface instance. More... | |
InterfaceFieldIterator | fields_end () |
Invalid iterator. More... | |
unsigned int | num_fields () const |
Get the number of fields in the message. More... | |
const void * | datachunk () const |
Get pointer to data. More... | |
unsigned int | datasize () const |
Get size of data. More... | |
unsigned int | hops () const |
Get number of hops. More... | |
void | set_hops (unsigned int hops) |
Set number of hops. More... | |
void | set_from_chunk (const void *chunk) |
Set from raw data chunk. More... | |
unsigned int | recipient () const |
Get recipient memory serial. More... | |
template<class MessageType > | |
bool | is_of_type () |
Check if message has desired type. More... | |
template<class MessageType > | |
MessageType * | as_type () |
Cast message to given type if possible. More... | |
![]() | |
RefCount () | |
Constructor. More... | |
virtual | ~RefCount () |
Destructor. More... | |
void | ref () |
Increment reference count. More... | |
void | unref () |
Decrement reference count and conditionally delete this instance. More... | |
unsigned int | refcount () |
Get reference count for this instance. More... | |
Additional Inherited Members | |
![]() | |
void | add_fieldinfo (interface_fieldtype_t type, const char *name, size_t length, void *value, const char *enumtype=0, const interface_enum_map_t *enum_map=0) |
Add an entry to the info list. More... | |
template<class FieldT , class DataT > | |
void | set_field (FieldT &field, DataT &data) |
Set a field. More... | |
template<class FieldT , class DataT > | |
void | set_field (FieldT &field, unsigned int index, DataT &data) |
Set an array field at a given index. More... | |
![]() | |
void * | data_ptr |
Pointer to memory that contains local data. More... | |
unsigned int | data_size |
Size of memory needed to hold all data. More... | |
message_data_ts_t * | data_ts |
data timestamp aliasing pointer More... | |
SetEscapingMessage Fawkes BlackBoard Interface Message.
Definition at line 545 of file NavigatorInterface.h.
fawkes::NavigatorInterface::SetEscapingMessage::SetEscapingMessage | ( | const bool | ini_escaping_enabled | ) |
Constructor with initial values.
ini_escaping_enabled | initial value for escaping_enabled |
Definition at line 2846 of file NavigatorInterface.cpp.
References fawkes::Message::add_fieldinfo(), fawkes::NavigatorInterface::AllowBackward, fawkes::NavigatorInterface::Backward, fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, fawkes::NavigatorInterface::ESCAPE, fawkes::NavigatorInterface::Forward, fawkes::IFT_BOOL, fawkes::NavigatorInterface::MovingNotAllowed, fawkes::NavigatorInterface::OrientAtTarget, and fawkes::NavigatorInterface::OrientDuringTravel.
fawkes::NavigatorInterface::SetEscapingMessage::SetEscapingMessage | ( | ) |
Constructor.
Definition at line 2864 of file NavigatorInterface.cpp.
References fawkes::Message::add_fieldinfo(), fawkes::NavigatorInterface::AllowBackward, fawkes::NavigatorInterface::Backward, fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, fawkes::NavigatorInterface::ESCAPE, fawkes::NavigatorInterface::Forward, fawkes::IFT_BOOL, fawkes::NavigatorInterface::MovingNotAllowed, fawkes::NavigatorInterface::OrientAtTarget, and fawkes::NavigatorInterface::OrientDuringTravel.
fawkes::NavigatorInterface::SetEscapingMessage::~SetEscapingMessage | ( | ) |
Destructor.
Definition at line 2882 of file NavigatorInterface.cpp.
References fawkes::Interface::data_ptr.
|
explicit |
Copy constructor.
m | message to copy from |
Definition at line 2890 of file NavigatorInterface.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 2938 of file NavigatorInterface.cpp.
bool fawkes::NavigatorInterface::SetEscapingMessage::is_escaping_enabled | ( | ) | const |
Get escaping_enabled value.
This is used for navigation components with integrated collision avoidance, to check whether the navigator should stop when an obstacle obstructs the path, or if it should escape.
Definition at line 2906 of file NavigatorInterface.cpp.
Referenced by ColliActThread::loop().
size_t fawkes::NavigatorInterface::SetEscapingMessage::maxlenof_escaping_enabled | ( | ) | const |
Get maximum length of escaping_enabled value.
Definition at line 2916 of file NavigatorInterface.cpp.
void fawkes::NavigatorInterface::SetEscapingMessage::set_escaping_enabled | ( | const bool | new_escaping_enabled | ) |
Set escaping_enabled value.
This is used for navigation components with integrated collision avoidance, to check whether the navigator should stop when an obstacle obstructs the path, or if it should escape.
new_escaping_enabled | new escaping_enabled value |
Definition at line 2927 of file NavigatorInterface.cpp.
References fawkes::Interface::set_field().