AddEdgeMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::NavGraphGeneratorInterface::AddEdgeMessage:

Public Member Functions
	AddEdgeMessage (const char ini_p1, const char ini_p2, const bool ini_directed, const EdgeMode ini_mode)
	Constructor with initial values. More...

	AddEdgeMessage ()
	Constructor. More...

	~AddEdgeMessage ()
	Destructor. More...

	AddEdgeMessage (const AddEdgeMessage *m)
	Copy constructor. More...

char *	p1 () const
	Get p1 value. More...

void	set_p1 (const char *new_p1)
	Set p1 value. More...

size_t	maxlenof_p1 () const
	Get maximum length of p1 value. More...

char *	p2 () const
	Get p2 value. More...

void	set_p2 (const char *new_p2)
	Set p2 value. More...

size_t	maxlenof_p2 () const
	Get maximum length of p2 value. More...

bool	is_directed () const
	Get directed value. More...

void	set_directed (const bool new_directed)
	Set directed value. More...

size_t	maxlenof_directed () const
	Get maximum length of directed value. More...

EdgeMode	mode () const
	Get mode value. More...

void	set_mode (const EdgeMode 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...

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

AddEdgeMessage Fawkes BlackBoard Interface Message.

Definition at line 622 of file NavGraphGeneratorInterface.h.

Constructor & Destructor Documentation

◆ AddEdgeMessage() [1/3]

fawkes::NavGraphGeneratorInterface::AddEdgeMessage::AddEdgeMessage	(	const char *	ini_p1,
		const char *	ini_p2,
		const bool	ini_directed,
		const EdgeMode	ini_mode
	)

Constructor with initial values.

Parameters

ini_p1	initial value for p1
ini_p2	initial value for p2
ini_directed	initial value for directed
ini_mode	initial value for mode

Definition at line 2417 of file NavGraphGeneratorInterface.cpp.

◆ AddEdgeMessage() [2/3]

fawkes::NavGraphGeneratorInterface::AddEdgeMessage::AddEdgeMessage ( )

Constructor.

Definition at line 2449 of file NavGraphGeneratorInterface.cpp.

◆ ~AddEdgeMessage()

fawkes::NavGraphGeneratorInterface::AddEdgeMessage::~AddEdgeMessage ( )

Destructor.

Definition at line 2476 of file NavGraphGeneratorInterface.cpp.

References fawkes::Interface::data_ptr.

◆ AddEdgeMessage() [3/3]

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

explicit

Copy constructor.

Parameters

m	message to copy from

Definition at line 2484 of file NavGraphGeneratorInterface.cpp.

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

Member Function Documentation

◆ clone()

Message * fawkes::NavGraphGeneratorInterface::AddEdgeMessage::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 2626 of file NavGraphGeneratorInterface.cpp.

◆ is_directed()

bool fawkes::NavGraphGeneratorInterface::AddEdgeMessage::is_directed ( ) const

Get directed value.

True to create a directed edge from p1 to p2, otherwise the edge is assumed to be undirected.

Returns: directed value

Definition at line 2562 of file NavGraphGeneratorInterface.cpp.

◆ maxlenof_directed()

size_t fawkes::NavGraphGeneratorInterface::AddEdgeMessage::maxlenof_directed ( ) const

Get maximum length of directed value.

Returns: length of directed value, can be length of the array or number of maximum number of characters for a string

Definition at line 2572 of file NavGraphGeneratorInterface.cpp.

◆ maxlenof_mode()

size_t fawkes::NavGraphGeneratorInterface::AddEdgeMessage::maxlenof_mode ( ) const

Get maximum length of mode value.

Returns: length of mode value, can be length of the array or number of maximum number of characters for a string

Definition at line 2605 of file NavGraphGeneratorInterface.cpp.

◆ maxlenof_p1()

size_t fawkes::NavGraphGeneratorInterface::AddEdgeMessage::maxlenof_p1 ( ) const

Get maximum length of p1 value.

Returns: length of p1 value, can be length of the array or number of maximum number of characters for a string

Definition at line 2509 of file NavGraphGeneratorInterface.cpp.

◆ maxlenof_p2()

size_t fawkes::NavGraphGeneratorInterface::AddEdgeMessage::maxlenof_p2 ( ) const

Get maximum length of p2 value.

Returns: length of p2 value, can be length of the array or number of maximum number of characters for a string

Definition at line 2539 of file NavGraphGeneratorInterface.cpp.

◆ mode()

NavGraphGeneratorInterface::EdgeMode fawkes::NavGraphGeneratorInterface::AddEdgeMessage::mode ( ) const

Get mode value.

The edge insertion mode.

Returns: mode value

Definition at line 2595 of file NavGraphGeneratorInterface.cpp.

◆ p1()

char * fawkes::NavGraphGeneratorInterface::AddEdgeMessage::p1 ( ) const

Get p1 value.

ID of first node.

Returns: p1 value

Definition at line 2499 of file NavGraphGeneratorInterface.cpp.

◆ p2()

char * fawkes::NavGraphGeneratorInterface::AddEdgeMessage::p2 ( ) const

Get p2 value.

ID of second node.

Returns: p2 value

Definition at line 2529 of file NavGraphGeneratorInterface.cpp.

◆ set_directed()

void fawkes::NavGraphGeneratorInterface::AddEdgeMessage::set_directed ( const bool new_directed )

Set directed value.

True to create a directed edge from p1 to p2, otherwise the edge is assumed to be undirected.

Parameters

new_directed new directed value

Definition at line 2585 of file NavGraphGeneratorInterface.cpp.

References fawkes::change_field().

◆ set_mode()

void fawkes::NavGraphGeneratorInterface::AddEdgeMessage::set_mode ( const EdgeMode new_mode )

Set mode value.

The edge insertion mode.

Parameters

new_mode new mode value

Definition at line 2615 of file NavGraphGeneratorInterface.cpp.

References fawkes::change_field().

◆ set_p1()

void fawkes::NavGraphGeneratorInterface::AddEdgeMessage::set_p1 ( const char * new_p1 )

Set p1 value.

ID of first node.

Parameters

new_p1 new p1 value

Definition at line 2519 of file NavGraphGeneratorInterface.cpp.

References fawkes::change_field().

◆ set_p2()

void fawkes::NavGraphGeneratorInterface::AddEdgeMessage::set_p2 ( const char * new_p2 )

Set p2 value.

ID of second node.

Parameters

new_p2 new p2 value

Definition at line 2549 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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AddEdgeMessage() [1/3]

◆ AddEdgeMessage() [2/3]

◆ ~AddEdgeMessage()

◆ AddEdgeMessage() [3/3]

Member Function Documentation

◆ clone()

◆ is_directed()

◆ maxlenof_directed()

◆ maxlenof_mode()

◆ maxlenof_p1()

◆ maxlenof_p2()

◆ mode()

◆ p1()

◆ p2()

◆ set_directed()

◆ set_mode()

◆ set_p1()

◆ set_p2()