Fawkes API
Fawkes Development Version
|
SetAlgorithmParameterMessage Fawkes BlackBoard Interface Message. More...
#include <>>
Public Member Functions | |
SetAlgorithmParameterMessage (const char *ini_param, const char *ini_value) | |
Constructor with initial values. More... | |
SetAlgorithmParameterMessage () | |
Constructor. More... | |
~SetAlgorithmParameterMessage () | |
Destructor. More... | |
SetAlgorithmParameterMessage (const SetAlgorithmParameterMessage *m) | |
Copy constructor. More... | |
char * | param () const |
Get param value. More... | |
void | set_param (const char *new_param) |
Set param value. More... | |
size_t | maxlenof_param () const |
Get maximum length of param value. More... | |
char * | value () const |
Get value value. More... | |
void | set_value (const char *new_value) |
Set value value. More... | |
size_t | maxlenof_value () const |
Get maximum length of value 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... | |
SetAlgorithmParameterMessage Fawkes BlackBoard Interface Message.
Definition at line 232 of file NavGraphGeneratorInterface.h.
fawkes::NavGraphGeneratorInterface::SetAlgorithmParameterMessage::SetAlgorithmParameterMessage | ( | const char * | ini_param, |
const char * | ini_value | ||
) |
Constructor with initial values.
ini_param | initial value for param |
ini_value | initial value for value |
Definition at line 577 of file NavGraphGeneratorInterface.cpp.
References fawkes::Message::add_fieldinfo(), fawkes::NavGraphGeneratorInterface::ALGORITHM_GRID, fawkes::NavGraphGeneratorInterface::ALGORITHM_VORONOI, 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_STRING, fawkes::NavGraphGeneratorInterface::NO_INTERSECTION, fawkes::NavGraphGeneratorInterface::NOT_CONNECTED, fawkes::NavGraphGeneratorInterface::SPLIT_INTERSECTION, and fawkes::NavGraphGeneratorInterface::UNCONNECTED.
fawkes::NavGraphGeneratorInterface::SetAlgorithmParameterMessage::SetAlgorithmParameterMessage | ( | ) |
Constructor.
Definition at line 605 of file NavGraphGeneratorInterface.cpp.
References fawkes::Message::add_fieldinfo(), fawkes::NavGraphGeneratorInterface::ALGORITHM_GRID, fawkes::NavGraphGeneratorInterface::ALGORITHM_VORONOI, 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_STRING, fawkes::NavGraphGeneratorInterface::NO_INTERSECTION, fawkes::NavGraphGeneratorInterface::NOT_CONNECTED, fawkes::NavGraphGeneratorInterface::SPLIT_INTERSECTION, and fawkes::NavGraphGeneratorInterface::UNCONNECTED.
fawkes::NavGraphGeneratorInterface::SetAlgorithmParameterMessage::~SetAlgorithmParameterMessage | ( | ) |
Destructor.
Definition at line 630 of file NavGraphGeneratorInterface.cpp.
References fawkes::Interface::data_ptr.
|
explicit |
Copy constructor.
m | message to copy from |
Definition at line 638 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 724 of file NavGraphGeneratorInterface.cpp.
size_t fawkes::NavGraphGeneratorInterface::SetAlgorithmParameterMessage::maxlenof_param | ( | ) | const |
Get maximum length of param value.
Definition at line 665 of file NavGraphGeneratorInterface.cpp.
size_t fawkes::NavGraphGeneratorInterface::SetAlgorithmParameterMessage::maxlenof_value | ( | ) | const |
Get maximum length of value value.
Definition at line 700 of file NavGraphGeneratorInterface.cpp.
char * fawkes::NavGraphGeneratorInterface::SetAlgorithmParameterMessage::param | ( | ) | const |
Get param value.
Parameter name, see Algorithm enum description for algorithm-specific parameters. Unknown parameters will be ignored.
Definition at line 655 of file NavGraphGeneratorInterface.cpp.
void fawkes::NavGraphGeneratorInterface::SetAlgorithmParameterMessage::set_param | ( | const char * | new_param | ) |
Set param value.
Parameter name, see Algorithm enum description for algorithm-specific parameters. Unknown parameters will be ignored.
new_param | new param value |
Definition at line 677 of file NavGraphGeneratorInterface.cpp.
References fawkes::change_field().
void fawkes::NavGraphGeneratorInterface::SetAlgorithmParameterMessage::set_value | ( | const char * | new_value | ) |
Set value value.
Value of parameter encoded as string. The algorithm will perform the conversion to the required data type (e.g., float). An error will make the generation fail.
new_value | new value value |
Definition at line 713 of file NavGraphGeneratorInterface.cpp.
References fawkes::change_field().
char * fawkes::NavGraphGeneratorInterface::SetAlgorithmParameterMessage::value | ( | ) | const |
Get value value.
Value of parameter encoded as string. The algorithm will perform the conversion to the required data type (e.g., float). An error will make the generation fail.
Definition at line 690 of file NavGraphGeneratorInterface.cpp.