Fawkes API  Fawkes Development Version
fawkes::OpenRaveInterface::MoveObjectMessage Class Reference

MoveObjectMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::OpenRaveInterface::MoveObjectMessage:

List of all members.

Classes

struct  MoveObjectMessage_data_t
 Internal data storage, do NOT modify! More...

Public Member Functions

 MoveObjectMessage (const char *ini_name, const float ini_x, const float ini_y, const float ini_z)
 Constructor with initial values.
 MoveObjectMessage ()
 Constructor.
 ~MoveObjectMessage ()
 Destructor.
 MoveObjectMessage (const MoveObjectMessage *m)
 Copy constructor.
char * name () const
 Get name value.
void set_name (const char *new_name)
 Set name value.
size_t maxlenof_name () const
 Get maximum length of name value.
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 z () const
 Get z value.
void set_z (const float new_z)
 Set z value.
size_t maxlenof_z () const
 Get maximum length of z value.
virtual Messageclone () const
 Clone this message.

Detailed Description


Constructor & Destructor Documentation

fawkes::OpenRaveInterface::MoveObjectMessage::MoveObjectMessage ( const char *  ini_name,
const float  ini_x,
const float  ini_y,
const float  ini_z 
)
fawkes::OpenRaveInterface::MoveObjectMessage::~MoveObjectMessage ( )

Destructor.

Definition at line 740 of file OpenRaveInterface.cpp.

References fawkes::Interface::data_ptr.

fawkes::OpenRaveInterface::MoveObjectMessage::MoveObjectMessage ( const MoveObjectMessage m)

Copy constructor.

Parameters:
mmessage to copy from

Definition at line 748 of file OpenRaveInterface.cpp.

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


Member Function Documentation

Message * fawkes::OpenRaveInterface::MoveObjectMessage::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 884 of file OpenRaveInterface.cpp.

size_t fawkes::OpenRaveInterface::MoveObjectMessage::maxlenof_name ( ) const

Get maximum length of name value.

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

Definition at line 773 of file OpenRaveInterface.cpp.

size_t fawkes::OpenRaveInterface::MoveObjectMessage::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 803 of file OpenRaveInterface.cpp.

size_t fawkes::OpenRaveInterface::MoveObjectMessage::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 833 of file OpenRaveInterface.cpp.

size_t fawkes::OpenRaveInterface::MoveObjectMessage::maxlenof_z ( ) const

Get maximum length of z value.

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

Definition at line 863 of file OpenRaveInterface.cpp.

char * fawkes::OpenRaveInterface::MoveObjectMessage::name ( ) const

Get name value.

Name of object

Returns:
name value

Definition at line 763 of file OpenRaveInterface.cpp.

Referenced by OpenRaveMessageHandlerThread::loop().

void fawkes::OpenRaveInterface::MoveObjectMessage::set_name ( const char *  new_name)

Set name value.

Name of object

Parameters:
new_namenew name value

Definition at line 783 of file OpenRaveInterface.cpp.

void fawkes::OpenRaveInterface::MoveObjectMessage::set_x ( const float  new_x)

Set x value.

x position of object (meters)

Parameters:
new_xnew x value

Definition at line 813 of file OpenRaveInterface.cpp.

void fawkes::OpenRaveInterface::MoveObjectMessage::set_y ( const float  new_y)

Set y value.

y position of object (meters)

Parameters:
new_ynew y value

Definition at line 843 of file OpenRaveInterface.cpp.

void fawkes::OpenRaveInterface::MoveObjectMessage::set_z ( const float  new_z)

Set z value.

z position of object (meters)

Parameters:
new_znew z value

Definition at line 873 of file OpenRaveInterface.cpp.

float fawkes::OpenRaveInterface::MoveObjectMessage::x ( ) const

Get x value.

x position of object (meters)

Returns:
x value

Definition at line 793 of file OpenRaveInterface.cpp.

Referenced by OpenRaveMessageHandlerThread::loop().

float fawkes::OpenRaveInterface::MoveObjectMessage::y ( ) const

Get y value.

y position of object (meters)

Returns:
y value

Definition at line 823 of file OpenRaveInterface.cpp.

Referenced by OpenRaveMessageHandlerThread::loop().

float fawkes::OpenRaveInterface::MoveObjectMessage::z ( ) const

Get z value.

z position of object (meters)

Returns:
z value

Definition at line 853 of file OpenRaveInterface.cpp.

Referenced by OpenRaveMessageHandlerThread::loop().


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