Fawkes API
Fawkes Development Version
|
ObstacleMessage Fawkes BlackBoard Interface Message. More...
#include <>>
Public Member Functions | |
ObstacleMessage (const float ini_x, const float ini_y, const float ini_width) | |
Constructor with initial values. More... | |
ObstacleMessage () | |
Constructor. More... | |
~ObstacleMessage () | |
Destructor. More... | |
ObstacleMessage (const ObstacleMessage *m) | |
Copy constructor. More... | |
float | x () const |
Get x value. More... | |
void | set_x (const float new_x) |
Set x value. More... | |
size_t | maxlenof_x () const |
Get maximum length of x value. More... | |
float | y () const |
Get y value. More... | |
void | set_y (const float new_y) |
Set y value. More... | |
size_t | maxlenof_y () const |
Get maximum length of y value. More... | |
float | width () const |
Get width value. More... | |
void | set_width (const float new_width) |
Set width value. More... | |
size_t | maxlenof_width () const |
Get maximum length of width 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... | |
unsigned int | sender_id () const |
Get ID of sender. 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... | |
![]() | |
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... | |
ObstacleMessage Fawkes BlackBoard Interface Message.
Definition at line 291 of file NavigatorInterface.h.
fawkes::NavigatorInterface::ObstacleMessage::ObstacleMessage | ( | const float | ini_x, |
const float | ini_y, | ||
const float | ini_width | ||
) |
Constructor with initial values.
ini_x | initial value for x |
ini_y | initial value for y |
ini_width | initial value for width |
Definition at line 1602 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_FLOAT, fawkes::NavigatorInterface::MovingNotAllowed, fawkes::NavigatorInterface::OrientAtTarget, and fawkes::NavigatorInterface::OrientDuringTravel.
fawkes::NavigatorInterface::ObstacleMessage::ObstacleMessage | ( | ) |
Constructor.
Definition at line 1624 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_FLOAT, fawkes::NavigatorInterface::MovingNotAllowed, fawkes::NavigatorInterface::OrientAtTarget, and fawkes::NavigatorInterface::OrientDuringTravel.
fawkes::NavigatorInterface::ObstacleMessage::~ObstacleMessage | ( | ) |
Destructor.
Definition at line 1644 of file NavigatorInterface.cpp.
References fawkes::Message::data_ptr.
fawkes::NavigatorInterface::ObstacleMessage::ObstacleMessage | ( | const ObstacleMessage * | m | ) |
Copy constructor.
m | message to copy from |
Definition at line 1652 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 1758 of file NavigatorInterface.cpp.
size_t fawkes::NavigatorInterface::ObstacleMessage::maxlenof_width | ( | ) | const |
Get maximum length of width value.
Definition at line 1737 of file NavigatorInterface.cpp.
size_t fawkes::NavigatorInterface::ObstacleMessage::maxlenof_x | ( | ) | const |
Get maximum length of x value.
Definition at line 1677 of file NavigatorInterface.cpp.
size_t fawkes::NavigatorInterface::ObstacleMessage::maxlenof_y | ( | ) | const |
Get maximum length of y value.
Definition at line 1707 of file NavigatorInterface.cpp.
void fawkes::NavigatorInterface::ObstacleMessage::set_width | ( | const float | new_width | ) |
Set width value.
Width of the obstacle.
new_width | new width value |
Definition at line 1747 of file NavigatorInterface.cpp.
void fawkes::NavigatorInterface::ObstacleMessage::set_x | ( | const float | new_x | ) |
Set x value.
X-coordinate of the obstacle.
new_x | new x value |
Definition at line 1687 of file NavigatorInterface.cpp.
void fawkes::NavigatorInterface::ObstacleMessage::set_y | ( | const float | new_y | ) |
Set y value.
Y-coordinate of the obstacle.
new_y | new y value |
Definition at line 1717 of file NavigatorInterface.cpp.
float fawkes::NavigatorInterface::ObstacleMessage::width | ( | ) | const |
Get width value.
Width of the obstacle.
Definition at line 1727 of file NavigatorInterface.cpp.
float fawkes::NavigatorInterface::ObstacleMessage::x | ( | ) | const |
Get x value.
X-coordinate of the obstacle.
Definition at line 1667 of file NavigatorInterface.cpp.
float fawkes::NavigatorInterface::ObstacleMessage::y | ( | ) | const |
Get y value.
Y-coordinate of the obstacle.
Definition at line 1697 of file NavigatorInterface.cpp.