Classes | Public Member Functions

fawkes::NavigatorInterface::CartesianGotoMessage Class Reference

CartesianGotoMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::NavigatorInterface::CartesianGotoMessage:
Inheritance graph
[legend]

List of all members.

Classes

struct  CartesianGotoMessage_data_t
 Internal data storage, do NOT modify!

Public Member Functions

 CartesianGotoMessage (const float ini_x, const float ini_y, const float ini_orientation)
 Constructor with initial values.
 CartesianGotoMessage ()
 Constructor.
 ~CartesianGotoMessage ()
 Destructor.
 CartesianGotoMessage (const CartesianGotoMessage *m)
 Copy constructor.
float x () const
 Get x value.
void set_x (const float new_x)
 Set x value.
size_t maxlenof_x () const
 Get maximum length of x value.
float y () const
 Get y value.
void set_y (const float new_y)
 Set y value.
size_t maxlenof_y () const
 Get maximum length of y value.
float orientation () const
 Get orientation value.
void set_orientation (const float new_orientation)
 Set orientation value.
size_t maxlenof_orientation () const
 Get maximum length of orientation value.
virtual Messageclone () const
 Clone this message.

Detailed Description

CartesianGotoMessage Fawkes BlackBoard Interface Message.

Definition at line 141 of file NavigatorInterface.h.


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_x initial value for x
ini_y initial value for y
ini_orientation initial 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:
m message 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.

References CartesianGotoMessage().

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_orientation new 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_x new 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_y new 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: