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

CartesianGotoMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::JacoInterface::CartesianGotoMessage:

Public Member Functions

 CartesianGotoMessage (const float ini_x, const float ini_y, const float ini_z, const float ini_e1, const float ini_e2, const float ini_e3)
 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 z () const
 Get z value. More...
 
void set_z (const float new_z)
 Set z value. More...
 
size_t maxlenof_z () const
 Get maximum length of z value. More...
 
float e1 () const
 Get e1 value. More...
 
void set_e1 (const float new_e1)
 Set e1 value. More...
 
size_t maxlenof_e1 () const
 Get maximum length of e1 value. More...
 
float e2 () const
 Get e2 value. More...
 
void set_e2 (const float new_e2)
 Set e2 value. More...
 
size_t maxlenof_e2 () const
 Get maximum length of e2 value. More...
 
float e3 () const
 Get e3 value. More...
 
void set_e3 (const float new_e3)
 Set e3 value. More...
 
size_t maxlenof_e3 () const
 Get maximum length of e3 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...
 
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_tdata_ts
 data timestamp aliasing pointer More...
 

Detailed Description

Constructor & Destructor Documentation

◆ CartesianGotoMessage() [1/3]

fawkes::JacoInterface::CartesianGotoMessage::CartesianGotoMessage ( const float  ini_x,
const float  ini_y,
const float  ini_z,
const float  ini_e1,
const float  ini_e2,
const float  ini_e3 
)

Constructor with initial values.

Parameters
ini_xinitial value for x
ini_yinitial value for y
ini_zinitial value for z
ini_e1initial value for e1
ini_e2initial value for e2
ini_e3initial value for e3

Definition at line 800 of file JacoInterface.cpp.

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

◆ CartesianGotoMessage() [2/3]

fawkes::JacoInterface::CartesianGotoMessage::CartesianGotoMessage ( )

◆ ~CartesianGotoMessage()

fawkes::JacoInterface::CartesianGotoMessage::~CartesianGotoMessage ( )

Destructor.

Definition at line 837 of file JacoInterface.cpp.

References fawkes::Message::data_ptr.

◆ CartesianGotoMessage() [3/3]

fawkes::JacoInterface::CartesianGotoMessage::CartesianGotoMessage ( const CartesianGotoMessage m)

Copy constructor.

Parameters
mmessage to copy from

Definition at line 845 of file JacoInterface.cpp.

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

Member Function Documentation

◆ clone()

Message * fawkes::JacoInterface::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 1041 of file JacoInterface.cpp.

◆ e1()

float fawkes::JacoInterface::CartesianGotoMessage::e1 ( ) const

Get e1 value.

1st Euler angle of target rotation

Returns
e1 value

Definition at line 950 of file JacoInterface.cpp.

Referenced by JacoActThread::loop().

◆ e2()

float fawkes::JacoInterface::CartesianGotoMessage::e2 ( ) const

Get e2 value.

2nd Euler angle of target rotation

Returns
e2 value

Definition at line 980 of file JacoInterface.cpp.

Referenced by JacoActThread::loop().

◆ e3()

float fawkes::JacoInterface::CartesianGotoMessage::e3 ( ) const

Get e3 value.

3rd Euler angle of target rotation

Returns
e3 value

Definition at line 1010 of file JacoInterface.cpp.

Referenced by JacoActThread::loop().

◆ maxlenof_e1()

size_t fawkes::JacoInterface::CartesianGotoMessage::maxlenof_e1 ( ) const

Get maximum length of e1 value.

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

Definition at line 960 of file JacoInterface.cpp.

◆ maxlenof_e2()

size_t fawkes::JacoInterface::CartesianGotoMessage::maxlenof_e2 ( ) const

Get maximum length of e2 value.

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

Definition at line 990 of file JacoInterface.cpp.

◆ maxlenof_e3()

size_t fawkes::JacoInterface::CartesianGotoMessage::maxlenof_e3 ( ) const

Get maximum length of e3 value.

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

Definition at line 1020 of file JacoInterface.cpp.

◆ maxlenof_x()

size_t fawkes::JacoInterface::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 870 of file JacoInterface.cpp.

◆ maxlenof_y()

size_t fawkes::JacoInterface::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 900 of file JacoInterface.cpp.

◆ maxlenof_z()

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

◆ set_e1()

void fawkes::JacoInterface::CartesianGotoMessage::set_e1 ( const float  new_e1)

Set e1 value.

1st Euler angle of target rotation

Parameters
new_e1new e1 value

Definition at line 970 of file JacoInterface.cpp.

◆ set_e2()

void fawkes::JacoInterface::CartesianGotoMessage::set_e2 ( const float  new_e2)

Set e2 value.

2nd Euler angle of target rotation

Parameters
new_e2new e2 value

Definition at line 1000 of file JacoInterface.cpp.

◆ set_e3()

void fawkes::JacoInterface::CartesianGotoMessage::set_e3 ( const float  new_e3)

Set e3 value.

3rd Euler angle of target rotation

Parameters
new_e3new e3 value

Definition at line 1030 of file JacoInterface.cpp.

◆ set_x()

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

Set x value.

X-coordinate of target

Parameters
new_xnew x value

Definition at line 880 of file JacoInterface.cpp.

◆ set_y()

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

Set y value.

Y-coordinate of target

Parameters
new_ynew y value

Definition at line 910 of file JacoInterface.cpp.

◆ set_z()

void fawkes::JacoInterface::CartesianGotoMessage::set_z ( const float  new_z)

Set z value.

Z-coordinate of target

Parameters
new_znew z value

Definition at line 940 of file JacoInterface.cpp.

◆ x()

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

Get x value.

X-coordinate of target

Returns
x value

Definition at line 860 of file JacoInterface.cpp.

Referenced by JacoActThread::loop().

◆ y()

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

Get y value.

Y-coordinate of target

Returns
y value

Definition at line 890 of file JacoInterface.cpp.

Referenced by JacoActThread::loop().

◆ z()

float fawkes::JacoInterface::CartesianGotoMessage::z ( ) const

Get z value.

Z-coordinate of target

Returns
z value

Definition at line 920 of file JacoInterface.cpp.

Referenced by JacoActThread::loop().


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