SetBoundingBoxMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::NavGraphGeneratorInterface::SetBoundingBoxMessage:

Public Member Functions
	SetBoundingBoxMessage (const float ini_p1_x, const float ini_p1_y, const float ini_p2_x, const float ini_p2_y)
	Constructor with initial values. More...

	SetBoundingBoxMessage ()
	Constructor. More...

	~SetBoundingBoxMessage ()
	Destructor. More...

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

float	p1_x () const
	Get p1_x value. More...

void	set_p1_x (const float new_p1_x)
	Set p1_x value. More...

size_t	maxlenof_p1_x () const
	Get maximum length of p1_x value. More...

float	p1_y () const
	Get p1_y value. More...

void	set_p1_y (const float new_p1_y)
	Set p1_y value. More...

size_t	maxlenof_p1_y () const
	Get maximum length of p1_y value. More...

float	p2_x () const
	Get p2_x value. More...

void	set_p2_x (const float new_p2_x)
	Set p2_x value. More...

size_t	maxlenof_p2_x () const
	Get maximum length of p2_x value. More...

float	p2_y () const
	Get p2_y value. More...

void	set_p2_y (const float new_p2_y)
	Set p2_y value. More...

size_t	maxlenof_p2_y () const
	Get maximum length of p2_y 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

SetBoundingBoxMessage Fawkes BlackBoard Interface Message.

Definition at line 270 of file NavGraphGeneratorInterface.h.

Constructor & Destructor Documentation

◆ SetBoundingBoxMessage() [1/3]

fawkes::NavGraphGeneratorInterface::SetBoundingBoxMessage::SetBoundingBoxMessage	(	const float	ini_p1_x,
		const float	ini_p1_y,
		const float	ini_p2_x,
		const float	ini_p2_y
	)

Constructor with initial values.

Parameters

ini_p1_x	initial value for p1_x
ini_p1_y	initial value for p1_y
ini_p2_x	initial value for p2_x
ini_p2_y	initial value for p2_y

Definition at line 741 of file NavGraphGeneratorInterface.cpp.

◆ SetBoundingBoxMessage() [2/3]

fawkes::NavGraphGeneratorInterface::SetBoundingBoxMessage::SetBoundingBoxMessage ( )

Constructor.

Definition at line 771 of file NavGraphGeneratorInterface.cpp.

◆ ~SetBoundingBoxMessage()

fawkes::NavGraphGeneratorInterface::SetBoundingBoxMessage::~SetBoundingBoxMessage ( )

Destructor.

Definition at line 798 of file NavGraphGeneratorInterface.cpp.

References fawkes::Interface::data_ptr.

◆ SetBoundingBoxMessage() [3/3]

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

explicit

Copy constructor.

Parameters

m	message to copy from

Definition at line 806 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::SetBoundingBoxMessage::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 942 of file NavGraphGeneratorInterface.cpp.

◆ maxlenof_p1_x()

size_t fawkes::NavGraphGeneratorInterface::SetBoundingBoxMessage::maxlenof_p1_x ( ) const

Get maximum length of p1_x value.

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

Definition at line 831 of file NavGraphGeneratorInterface.cpp.

◆ maxlenof_p1_y()

size_t fawkes::NavGraphGeneratorInterface::SetBoundingBoxMessage::maxlenof_p1_y ( ) const

Get maximum length of p1_y value.

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

Definition at line 861 of file NavGraphGeneratorInterface.cpp.

◆ maxlenof_p2_x()

size_t fawkes::NavGraphGeneratorInterface::SetBoundingBoxMessage::maxlenof_p2_x ( ) const

Get maximum length of p2_x value.

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

Definition at line 891 of file NavGraphGeneratorInterface.cpp.

◆ maxlenof_p2_y()

size_t fawkes::NavGraphGeneratorInterface::SetBoundingBoxMessage::maxlenof_p2_y ( ) const

Get maximum length of p2_y value.

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

Definition at line 921 of file NavGraphGeneratorInterface.cpp.

◆ p1_x()

float fawkes::NavGraphGeneratorInterface::SetBoundingBoxMessage::p1_x ( ) const

Get p1_x value.

X coordinate of bbox start point in global frame.

Returns: p1_x value

Definition at line 821 of file NavGraphGeneratorInterface.cpp.

◆ p1_y()

float fawkes::NavGraphGeneratorInterface::SetBoundingBoxMessage::p1_y ( ) const

Get p1_y value.

Y coordinate of bbox start point in global frame.

Returns: p1_y value

Definition at line 851 of file NavGraphGeneratorInterface.cpp.

◆ p2_x()

float fawkes::NavGraphGeneratorInterface::SetBoundingBoxMessage::p2_x ( ) const

Get p2_x value.

X coordinate of bbox end point in global frame.

Returns: p2_x value

Definition at line 881 of file NavGraphGeneratorInterface.cpp.

◆ p2_y()

float fawkes::NavGraphGeneratorInterface::SetBoundingBoxMessage::p2_y ( ) const

Get p2_y value.

Y coordinate of bbox end point in global frame.

Returns: p2_y value

Definition at line 911 of file NavGraphGeneratorInterface.cpp.

◆ set_p1_x()

void fawkes::NavGraphGeneratorInterface::SetBoundingBoxMessage::set_p1_x ( const float new_p1_x )

Set p1_x value.

X coordinate of bbox start point in global frame.

Parameters

new_p1_x new p1_x value

Definition at line 841 of file NavGraphGeneratorInterface.cpp.

References fawkes::change_field().

◆ set_p1_y()

void fawkes::NavGraphGeneratorInterface::SetBoundingBoxMessage::set_p1_y ( const float new_p1_y )

Set p1_y value.

Y coordinate of bbox start point in global frame.

Parameters

new_p1_y new p1_y value

Definition at line 871 of file NavGraphGeneratorInterface.cpp.

References fawkes::change_field().

◆ set_p2_x()

void fawkes::NavGraphGeneratorInterface::SetBoundingBoxMessage::set_p2_x ( const float new_p2_x )

Set p2_x value.

X coordinate of bbox end point in global frame.

Parameters

new_p2_x new p2_x value

Definition at line 901 of file NavGraphGeneratorInterface.cpp.

References fawkes::change_field().

◆ set_p2_y()

void fawkes::NavGraphGeneratorInterface::SetBoundingBoxMessage::set_p2_y ( const float new_p2_y )

Set p2_y value.

Y coordinate of bbox end point in global frame.

Parameters

new_p2_y new p2_y value

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

◆ SetBoundingBoxMessage() [1/3]

◆ SetBoundingBoxMessage() [2/3]

◆ ~SetBoundingBoxMessage()

◆ SetBoundingBoxMessage() [3/3]

Member Function Documentation

◆ clone()

◆ maxlenof_p1_x()

◆ maxlenof_p1_y()

◆ maxlenof_p2_x()

◆ maxlenof_p2_y()

◆ p1_x()

◆ p1_y()

◆ p2_x()

◆ p2_y()

◆ set_p1_x()

◆ set_p1_y()

◆ set_p2_x()

◆ set_p2_y()