Fawkes API
Fawkes Development Version
|
AddPointOfInterestMessage Fawkes BlackBoard Interface Message. More...
#include <>>
Public Member Functions | |
AddPointOfInterestMessage (const char *ini_name, const float ini_x, const float ini_y, const ConnectionMode ini_mode) | |
Constructor with initial values. More... | |
AddPointOfInterestMessage () | |
Constructor. More... | |
~AddPointOfInterestMessage () | |
Destructor. More... | |
AddPointOfInterestMessage (const AddPointOfInterestMessage *m) | |
Copy constructor. More... | |
char * | name () const |
Get name value. More... | |
void | set_name (const char *new_name) |
Set name value. More... | |
size_t | maxlenof_name () const |
Get maximum length of name value. 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... | |
ConnectionMode | mode () const |
Get mode value. More... | |
void | set_mode (const ConnectionMode new_mode) |
Set mode value. More... | |
size_t | maxlenof_mode () const |
Get maximum length of mode 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... | |
AddPointOfInterestMessage Fawkes BlackBoard Interface Message.
Definition at line 383 of file NavGraphGeneratorInterface.h.
fawkes::NavGraphGeneratorInterface::AddPointOfInterestMessage::AddPointOfInterestMessage | ( | const char * | ini_name, |
const float | ini_x, | ||
const float | ini_y, | ||
const ConnectionMode | ini_mode | ||
) |
Constructor with initial values.
ini_name | initial value for name |
ini_x | initial value for x |
ini_y | initial value for y |
ini_mode | initial value for mode |
Definition at line 1333 of file NavGraphGeneratorInterface.cpp.
References fawkes::Message::add_fieldinfo(), fawkes::NavGraphGeneratorInterface::CLOSEST_EDGE, fawkes::NavGraphGeneratorInterface::CLOSEST_EDGE_OR_NODE, fawkes::NavGraphGeneratorInterface::CLOSEST_NODE, fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, fawkes::NavGraphGeneratorInterface::FILTER_EDGES_BY_MAP, fawkes::NavGraphGeneratorInterface::FILTER_MULTI_GRAPH, fawkes::NavGraphGeneratorInterface::FILTER_ORPHAN_NODES, fawkes::NavGraphGeneratorInterface::FORCE, fawkes::IFT_ENUM, fawkes::IFT_FLOAT, fawkes::IFT_STRING, fawkes::NavGraphGeneratorInterface::NO_INTERSECTION, fawkes::NavGraphGeneratorInterface::NOT_CONNECTED, fawkes::NavGraphGeneratorInterface::SPLIT_INTERSECTION, and fawkes::NavGraphGeneratorInterface::UNCONNECTED.
fawkes::NavGraphGeneratorInterface::AddPointOfInterestMessage::AddPointOfInterestMessage | ( | ) |
Constructor.
Definition at line 1361 of file NavGraphGeneratorInterface.cpp.
References fawkes::Message::add_fieldinfo(), fawkes::NavGraphGeneratorInterface::CLOSEST_EDGE, fawkes::NavGraphGeneratorInterface::CLOSEST_EDGE_OR_NODE, fawkes::NavGraphGeneratorInterface::CLOSEST_NODE, fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, fawkes::NavGraphGeneratorInterface::FILTER_EDGES_BY_MAP, fawkes::NavGraphGeneratorInterface::FILTER_MULTI_GRAPH, fawkes::NavGraphGeneratorInterface::FILTER_ORPHAN_NODES, fawkes::NavGraphGeneratorInterface::FORCE, fawkes::IFT_ENUM, fawkes::IFT_FLOAT, fawkes::IFT_STRING, fawkes::NavGraphGeneratorInterface::NO_INTERSECTION, fawkes::NavGraphGeneratorInterface::NOT_CONNECTED, fawkes::NavGraphGeneratorInterface::SPLIT_INTERSECTION, and fawkes::NavGraphGeneratorInterface::UNCONNECTED.
fawkes::NavGraphGeneratorInterface::AddPointOfInterestMessage::~AddPointOfInterestMessage | ( | ) |
Destructor.
Definition at line 1386 of file NavGraphGeneratorInterface.cpp.
References fawkes::Message::data_ptr.
fawkes::NavGraphGeneratorInterface::AddPointOfInterestMessage::AddPointOfInterestMessage | ( | const AddPointOfInterestMessage * | m | ) |
Copy constructor.
m | message to copy from |
Definition at line 1394 of file NavGraphGeneratorInterface.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 1538 of file NavGraphGeneratorInterface.cpp.
size_t fawkes::NavGraphGeneratorInterface::AddPointOfInterestMessage::maxlenof_mode | ( | ) | const |
Get maximum length of mode value.
Definition at line 1515 of file NavGraphGeneratorInterface.cpp.
size_t fawkes::NavGraphGeneratorInterface::AddPointOfInterestMessage::maxlenof_name | ( | ) | const |
Get maximum length of name value.
Definition at line 1421 of file NavGraphGeneratorInterface.cpp.
size_t fawkes::NavGraphGeneratorInterface::AddPointOfInterestMessage::maxlenof_x | ( | ) | const |
Get maximum length of x value.
Definition at line 1453 of file NavGraphGeneratorInterface.cpp.
size_t fawkes::NavGraphGeneratorInterface::AddPointOfInterestMessage::maxlenof_y | ( | ) | const |
Get maximum length of y value.
Definition at line 1483 of file NavGraphGeneratorInterface.cpp.
NavGraphGeneratorInterface::ConnectionMode fawkes::NavGraphGeneratorInterface::AddPointOfInterestMessage::mode | ( | ) | const |
Get mode value.
The connection mode to use to connect the POI with the graph.
Definition at line 1505 of file NavGraphGeneratorInterface.cpp.
Referenced by NavGraphGeneratorThread::loop().
char * fawkes::NavGraphGeneratorInterface::AddPointOfInterestMessage::name | ( | ) | const |
Get name value.
ID of the obstacle. Can later be used to remove it again.
Definition at line 1411 of file NavGraphGeneratorInterface.cpp.
Referenced by NavGraphGeneratorThread::loop().
void fawkes::NavGraphGeneratorInterface::AddPointOfInterestMessage::set_mode | ( | const ConnectionMode | new_mode | ) |
Set mode value.
The connection mode to use to connect the POI with the graph.
new_mode | new mode value |
Definition at line 1527 of file NavGraphGeneratorInterface.cpp.
void fawkes::NavGraphGeneratorInterface::AddPointOfInterestMessage::set_name | ( | const char * | new_name | ) |
Set name value.
ID of the obstacle. Can later be used to remove it again.
new_name | new name value |
Definition at line 1433 of file NavGraphGeneratorInterface.cpp.
void fawkes::NavGraphGeneratorInterface::AddPointOfInterestMessage::set_x | ( | const float | new_x | ) |
Set x value.
X coordinate of obstacle in global frame.
new_x | new x value |
Definition at line 1463 of file NavGraphGeneratorInterface.cpp.
void fawkes::NavGraphGeneratorInterface::AddPointOfInterestMessage::set_y | ( | const float | new_y | ) |
Set y value.
Y coordinate of obstacle in global frame.
new_y | new y value |
Definition at line 1493 of file NavGraphGeneratorInterface.cpp.
float fawkes::NavGraphGeneratorInterface::AddPointOfInterestMessage::x | ( | ) | const |
Get x value.
X coordinate of obstacle in global frame.
Definition at line 1443 of file NavGraphGeneratorInterface.cpp.
Referenced by NavGraphGeneratorThread::loop().
float fawkes::NavGraphGeneratorInterface::AddPointOfInterestMessage::y | ( | ) | const |
Get y value.
Y coordinate of obstacle in global frame.
Definition at line 1473 of file NavGraphGeneratorInterface.cpp.
Referenced by NavGraphGeneratorThread::loop().