Fawkes API  Fawkes Development Version
fawkes::NavigatorInterface::CartesianGotoMessage Class Reference

CartesianGotoMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::NavigatorInterface::CartesianGotoMessage:

Public Member Functions

 CartesianGotoMessage (const float ini_x, const float ini_y, const float ini_orientation)
 Constructor with initial values. More...
 
 CartesianGotoMessage ()
 Constructor. More...
 
 ~CartesianGotoMessage ()
 Destructor. More...
 
 CartesianGotoMessage (const CartesianGotoMessage *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...
 
virtual Messageclone () 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...
 
Messageoperator= (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 Timetime_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...
 
Interfaceinterface () 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...
 
- 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)
 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_tdata_ts
 data timestamp aliasing pointer More...
 

Detailed Description

Constructor & Destructor Documentation

fawkes::NavigatorInterface::CartesianGotoMessage::CartesianGotoMessage ( const float  ini_x,
const float  ini_y,
const float  ini_orientation 
)

Constructor with initial values.

Parameters
ini_xinitial value for x
ini_yinitial value for y
ini_orientationinitial value for orientation

Definition at line 773 of file NavigatorInterface.cpp.

References fawkes::Message::add_fieldinfo(), fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, and fawkes::IFT_FLOAT.

fawkes::NavigatorInterface::CartesianGotoMessage::CartesianGotoMessage ( )
fawkes::NavigatorInterface::CartesianGotoMessage::~CartesianGotoMessage ( )

Destructor.

Definition at line 801 of file NavigatorInterface.cpp.

References fawkes::Message::data_ptr.

fawkes::NavigatorInterface::CartesianGotoMessage::CartesianGotoMessage ( const CartesianGotoMessage m)

Copy constructor.

Parameters
mmessage to copy from

Definition at line 809 of file NavigatorInterface.cpp.

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

Member Function Documentation

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

size_t fawkes::NavigatorInterface::CartesianGotoMessage::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 894 of file NavigatorInterface.cpp.

size_t fawkes::NavigatorInterface::CartesianGotoMessage::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 834 of file NavigatorInterface.cpp.

size_t fawkes::NavigatorInterface::CartesianGotoMessage::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 864 of file NavigatorInterface.cpp.

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

Get orientation value.

The orientation of the robot at the target.

Returns
orientation value

Definition at line 884 of file NavigatorInterface.cpp.

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

Set orientation value.

The orientation of the robot at the target.

Parameters
new_orientationnew orientation value

Definition at line 904 of file NavigatorInterface.cpp.

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

Set x value.

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

Parameters
new_xnew x value

Definition at line 844 of file NavigatorInterface.cpp.

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

Set y value.

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

Parameters
new_ynew y value

Definition at line 874 of file NavigatorInterface.cpp.

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

Get x value.

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

Returns
x value

Definition at line 824 of file NavigatorInterface.cpp.

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

Get y value.

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

Returns
y value

Definition at line 854 of file NavigatorInterface.cpp.


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