fawkes::NavGraphGeneratorInterface::SetAlgorithmMessage Class Reference

SetAlgorithmMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::NavGraphGeneratorInterface::SetAlgorithmMessage:

Public Member Functions
	SetAlgorithmMessage (const Algorithm ini_algorithm)
	Constructor with initial values. More...
	SetAlgorithmMessage ()
	Constructor. More...
	~SetAlgorithmMessage ()
	Destructor. More...
	SetAlgorithmMessage (const SetAlgorithmMessage *m)
	Copy constructor. More...
Algorithm	algorithm () const
	Get algorithm value. More...
void	set_algorithm (const Algorithm new_algorithm)
	Set algorithm value. More...
size_t	maxlenof_algorithm () const
	Get maximum length of algorithm value. More...
virtual Message *	clone () const
	Clone this message. More...
Public Member Functions inherited from fawkes::Message
	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...
Public Member Functions inherited from fawkes::RefCount
	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
Protected Member Functions inherited from fawkes::Message
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...
Protected Attributes inherited from fawkes::Message
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...

Detailed Description

SetAlgorithmMessage Fawkes BlackBoard Interface Message.

Definition at line 203 of file NavGraphGeneratorInterface.h.

Constructor & Destructor Documentation

SetAlgorithmMessage() [1/3]

fawkes::NavGraphGeneratorInterface::SetAlgorithmMessage::SetAlgorithmMessage

(

const Algorithm

ini_algorithm

)

Constructor with initial values.

Parameters

ini_algorithm

initial value for algorithm

Definition at line 460 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_ENUM, fawkes::NavGraphGeneratorInterface::NO_INTERSECTION, fawkes::NavGraphGeneratorInterface::NOT_CONNECTED, fawkes::NavGraphGeneratorInterface::SPLIT_INTERSECTION, and fawkes::NavGraphGeneratorInterface::UNCONNECTED.

SetAlgorithmMessage() [2/3]

fawkes::NavGraphGeneratorInterface::SetAlgorithmMessage::SetAlgorithmMessage

(

)

Constructor.

Definition at line 484 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_ENUM, fawkes::NavGraphGeneratorInterface::NO_INTERSECTION, fawkes::NavGraphGeneratorInterface::NOT_CONNECTED, fawkes::NavGraphGeneratorInterface::SPLIT_INTERSECTION, and fawkes::NavGraphGeneratorInterface::UNCONNECTED.

~SetAlgorithmMessage()

fawkes::NavGraphGeneratorInterface::SetAlgorithmMessage::~SetAlgorithmMessage

(

)

Destructor.

Definition at line 508 of file NavGraphGeneratorInterface.cpp.

References fawkes::Interface::data_ptr.

SetAlgorithmMessage() [3/3]

fawkes::NavGraphGeneratorInterface::SetAlgorithmMessage::SetAlgorithmMessage ( const SetAlgorithmMessage *  m )

explicit

Copy constructor.

Parameters

m	message to copy from

Definition at line 516 of file NavGraphGeneratorInterface.cpp.

References fawkes::Message::data_ptr, fawkes::Message::data_size, and fawkes::Message::data_ts.

Member Function Documentation

algorithm()

NavGraphGeneratorInterface::Algorithm fawkes::NavGraphGeneratorInterface::SetAlgorithmMessage::algorithm

(

)

const

Get algorithm value.

Algorithm to use.

Returns

algorithm value

Definition at line 531 of file NavGraphGeneratorInterface.cpp.

clone()

Message * fawkes::NavGraphGeneratorInterface::SetAlgorithmMessage::clone ( ) const

virtual

Clone this message.

Produces a message of the same type as this message and copies the data to the new message.

Returns

clone of this message

Reimplemented from fawkes::Message.

Definition at line 562 of file NavGraphGeneratorInterface.cpp.

maxlenof_algorithm()

size_t fawkes::NavGraphGeneratorInterface::SetAlgorithmMessage::maxlenof_algorithm

(

)

const

Get maximum length of algorithm value.

Returns

length of algorithm value, can be length of the array or number of maximum number of characters for a string

Definition at line 541 of file NavGraphGeneratorInterface.cpp.

set_algorithm()

void fawkes::NavGraphGeneratorInterface::SetAlgorithmMessage::set_algorithm

(

const Algorithm

new_algorithm

)

Set algorithm value.

Algorithm to use.

Parameters

new_algorithm

new algorithm value

Definition at line 551 of file NavGraphGeneratorInterface.cpp.

References fawkes::change_field().

---

The documentation for this class was generated from the following files:

• src/libs/interfaces/NavGraphGeneratorInterface.h
• src/plugins/navgraph-generator/interfaces/NavGraphGeneratorInterface.cpp