CartesianGotoWithFrameMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::NavigatorInterface::CartesianGotoWithFrameMessage:

Public Member Functions
	CartesianGotoWithFrameMessage (const float ini_x, const float ini_y, const float ini_orientation, const char *ini_target_frame)
	Constructor with initial values. More...

	CartesianGotoWithFrameMessage ()
	Constructor. More...

	~CartesianGotoWithFrameMessage ()
	Destructor. More...

	CartesianGotoWithFrameMessage (const CartesianGotoWithFrameMessage *m)
	Copy constructor. 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...

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

void	set_orientation (const float new_orientation)
	Set orientation value. More...

size_t	maxlenof_orientation () const
	Get maximum length of orientation value. More...

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

void	set_target_frame (const char *new_target_frame)
	Set target_frame value. More...

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

CartesianGotoWithFrameMessage Fawkes BlackBoard Interface Message.

Definition at line 255 of file NavigatorInterface.h.

Constructor & Destructor Documentation

◆ CartesianGotoWithFrameMessage() [1/3]

fawkes::NavigatorInterface::CartesianGotoWithFrameMessage::CartesianGotoWithFrameMessage	(	const float	ini_x,
		const float	ini_y,
		const float	ini_orientation,
		const char *	ini_target_frame
	)

Constructor with initial values.

Parameters

ini_x	initial value for x
ini_y	initial value for y
ini_orientation	initial value for orientation
ini_target_frame	initial value for target_frame

Definition at line 1518 of file NavigatorInterface.cpp.

References fawkes::Message::add_fieldinfo(), fawkes::NavigatorInterface::AllowBackward, fawkes::NavigatorInterface::Backward, fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, fawkes::NavigatorInterface::ESCAPE, fawkes::NavigatorInterface::Forward, fawkes::IFT_FLOAT, fawkes::IFT_STRING, fawkes::NavigatorInterface::MovingNotAllowed, fawkes::NavigatorInterface::OrientAtTarget, and fawkes::NavigatorInterface::OrientDuringTravel.

◆ CartesianGotoWithFrameMessage() [2/3]

fawkes::NavigatorInterface::CartesianGotoWithFrameMessage::CartesianGotoWithFrameMessage ( )

Constructor.

Definition at line 1543 of file NavigatorInterface.cpp.

References fawkes::Message::add_fieldinfo(), fawkes::NavigatorInterface::AllowBackward, fawkes::NavigatorInterface::Backward, fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, fawkes::NavigatorInterface::ESCAPE, fawkes::NavigatorInterface::Forward, fawkes::IFT_FLOAT, fawkes::IFT_STRING, fawkes::NavigatorInterface::MovingNotAllowed, fawkes::NavigatorInterface::OrientAtTarget, and fawkes::NavigatorInterface::OrientDuringTravel.

◆ ~CartesianGotoWithFrameMessage()

fawkes::NavigatorInterface::CartesianGotoWithFrameMessage::~CartesianGotoWithFrameMessage ( )

Destructor.

Definition at line 1564 of file NavigatorInterface.cpp.

References fawkes::Interface::data_ptr.

◆ CartesianGotoWithFrameMessage() [3/3]

fawkes::NavigatorInterface::CartesianGotoWithFrameMessage::CartesianGotoWithFrameMessage ( const CartesianGotoWithFrameMessage * m )

explicit

Copy constructor.

Parameters

m	message to copy from

Definition at line 1572 of file NavigatorInterface.cpp.

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

Member Function Documentation

◆ clone()

Message * fawkes::NavigatorInterface::CartesianGotoWithFrameMessage::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 1708 of file NavigatorInterface.cpp.

◆ maxlenof_orientation()

size_t fawkes::NavigatorInterface::CartesianGotoWithFrameMessage::maxlenof_orientation ( ) const

Get maximum length of orientation value.

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

Definition at line 1657 of file NavigatorInterface.cpp.

◆ maxlenof_target_frame()

size_t fawkes::NavigatorInterface::CartesianGotoWithFrameMessage::maxlenof_target_frame ( ) const

Get maximum length of target_frame value.

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

Definition at line 1687 of file NavigatorInterface.cpp.

◆ maxlenof_x()

size_t fawkes::NavigatorInterface::CartesianGotoWithFrameMessage::maxlenof_x ( ) const

Get maximum length of x value.

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

Definition at line 1597 of file NavigatorInterface.cpp.

◆ maxlenof_y()

size_t fawkes::NavigatorInterface::CartesianGotoWithFrameMessage::maxlenof_y ( ) const

Get maximum length of y value.

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

Definition at line 1627 of file NavigatorInterface.cpp.

◆ orientation()

float fawkes::NavigatorInterface::CartesianGotoWithFrameMessage::orientation ( ) const

Get orientation value.

The desired orientation of the robot at the target.

Returns: orientation value

Definition at line 1647 of file NavigatorInterface.cpp.

◆ set_orientation()

void fawkes::NavigatorInterface::CartesianGotoWithFrameMessage::set_orientation ( const float new_orientation )

Set orientation value.

The desired orientation of the robot at the target.

Parameters

new_orientation new orientation value

Definition at line 1667 of file NavigatorInterface.cpp.

References fawkes::change_field().

◆ set_target_frame()

void fawkes::NavigatorInterface::CartesianGotoWithFrameMessage::set_target_frame ( const char * new_target_frame )

Set target_frame value.

The target frame to plan in.

Parameters

new_target_frame new target_frame value

Definition at line 1697 of file NavigatorInterface.cpp.

References fawkes::change_field().

◆ set_x()

void fawkes::NavigatorInterface::CartesianGotoWithFrameMessage::set_x ( const float new_x )

Set x value.

X-coordinate of the target, in the robot's coordinate system.

Parameters

new_x new x value

Definition at line 1607 of file NavigatorInterface.cpp.

References fawkes::change_field().

◆ set_y()

void fawkes::NavigatorInterface::CartesianGotoWithFrameMessage::set_y ( const float new_y )

Set y value.

Y-coordinate of the target, in the robot's coordinate system.

Parameters

new_y new y value

Definition at line 1637 of file NavigatorInterface.cpp.

References fawkes::change_field().

◆ target_frame()

char * fawkes::NavigatorInterface::CartesianGotoWithFrameMessage::target_frame ( ) const

Get target_frame value.

The target frame to plan in.

Returns: target_frame value

Definition at line 1677 of file NavigatorInterface.cpp.

◆ x()

float fawkes::NavigatorInterface::CartesianGotoWithFrameMessage::x ( ) const

Get x value.

X-coordinate of the target, in the robot's coordinate system.

Returns: x value

Definition at line 1587 of file NavigatorInterface.cpp.

◆ y()

float fawkes::NavigatorInterface::CartesianGotoWithFrameMessage::y ( ) const

Get y value.

Y-coordinate of the target, in the robot's coordinate system.

Returns: y value

Definition at line 1617 of file NavigatorInterface.cpp.

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

src/libs/interfaces/NavigatorInterface.h
src/libs/interfaces/NavigatorInterface.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CartesianGotoWithFrameMessage() [1/3]

◆ CartesianGotoWithFrameMessage() [2/3]

◆ ~CartesianGotoWithFrameMessage()

◆ CartesianGotoWithFrameMessage() [3/3]

Member Function Documentation

◆ clone()

◆ maxlenof_orientation()

◆ maxlenof_target_frame()

◆ maxlenof_x()

◆ maxlenof_y()

◆ orientation()

◆ set_orientation()

◆ set_target_frame()

◆ set_x()

◆ set_y()

◆ target_frame()

◆ x()

◆ y()