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

AngularGotoMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::JacoInterface::AngularGotoMessage:

Public Member Functions

 AngularGotoMessage (const float ini_j1, const float ini_j2, const float ini_j3, const float ini_j4, const float ini_j5, const float ini_j6)
 Constructor with initial values. More...
 
 AngularGotoMessage ()
 Constructor. More...
 
 ~AngularGotoMessage ()
 Destructor. More...
 
 AngularGotoMessage (const AngularGotoMessage *m)
 Copy constructor. More...
 
float j1 () const
 Get j1 value. More...
 
void set_j1 (const float new_j1)
 Set j1 value. More...
 
size_t maxlenof_j1 () const
 Get maximum length of j1 value. More...
 
float j2 () const
 Get j2 value. More...
 
void set_j2 (const float new_j2)
 Set j2 value. More...
 
size_t maxlenof_j2 () const
 Get maximum length of j2 value. More...
 
float j3 () const
 Get j3 value. More...
 
void set_j3 (const float new_j3)
 Set j3 value. More...
 
size_t maxlenof_j3 () const
 Get maximum length of j3 value. More...
 
float j4 () const
 Get j4 value. More...
 
void set_j4 (const float new_j4)
 Set j4 value. More...
 
size_t maxlenof_j4 () const
 Get maximum length of j4 value. More...
 
float j5 () const
 Get j5 value. More...
 
void set_j5 (const float new_j5)
 Set j5 value. More...
 
size_t maxlenof_j5 () const
 Get maximum length of j5 value. More...
 
float j6 () const
 Get j6 value. More...
 
void set_j6 (const float new_j6)
 Set j6 value. More...
 
size_t maxlenof_j6 () const
 Get maximum length of j6 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

AngularGotoMessage Fawkes BlackBoard Interface Message.

Definition at line 180 of file JacoInterface.h.

Constructor & Destructor Documentation

◆ AngularGotoMessage() [1/3]

fawkes::JacoInterface::AngularGotoMessage::AngularGotoMessage ( const float  ini_j1,
const float  ini_j2,
const float  ini_j3,
const float  ini_j4,
const float  ini_j5,
const float  ini_j6 
)

Constructor with initial values.

Parameters
ini_j1initial value for j1
ini_j2initial value for j2
ini_j3initial value for j3
ini_j4initial value for j4
ini_j5initial value for j5
ini_j6initial value for j6

Definition at line 1041 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.

◆ AngularGotoMessage() [2/3]

fawkes::JacoInterface::AngularGotoMessage::AngularGotoMessage ( )

◆ ~AngularGotoMessage()

fawkes::JacoInterface::AngularGotoMessage::~AngularGotoMessage ( )

Destructor.

Definition at line 1078 of file JacoInterface.cpp.

References fawkes::Interface::data_ptr.

◆ AngularGotoMessage() [3/3]

fawkes::JacoInterface::AngularGotoMessage::AngularGotoMessage ( const AngularGotoMessage m)
explicit

Copy constructor.

Parameters
mmessage to copy from

Definition at line 1086 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::AngularGotoMessage::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 1282 of file JacoInterface.cpp.

◆ j1()

float fawkes::JacoInterface::AngularGotoMessage::j1 ( ) const

Get j1 value.

Angular value of 1st joint

Returns
j1 value

Definition at line 1101 of file JacoInterface.cpp.

◆ j2()

float fawkes::JacoInterface::AngularGotoMessage::j2 ( ) const

Get j2 value.

Angular value of 2nd joint

Returns
j2 value

Definition at line 1131 of file JacoInterface.cpp.

◆ j3()

float fawkes::JacoInterface::AngularGotoMessage::j3 ( ) const

Get j3 value.

Angular value of 3rd joint

Returns
j3 value

Definition at line 1161 of file JacoInterface.cpp.

◆ j4()

float fawkes::JacoInterface::AngularGotoMessage::j4 ( ) const

Get j4 value.

Angular value of 4th joint

Returns
j4 value

Definition at line 1191 of file JacoInterface.cpp.

◆ j5()

float fawkes::JacoInterface::AngularGotoMessage::j5 ( ) const

Get j5 value.

Angular value of 5th joint

Returns
j5 value

Definition at line 1221 of file JacoInterface.cpp.

◆ j6()

float fawkes::JacoInterface::AngularGotoMessage::j6 ( ) const

Get j6 value.

Angular value of 6th joint

Returns
j6 value

Definition at line 1251 of file JacoInterface.cpp.

◆ maxlenof_j1()

size_t fawkes::JacoInterface::AngularGotoMessage::maxlenof_j1 ( ) const

Get maximum length of j1 value.

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

Definition at line 1111 of file JacoInterface.cpp.

◆ maxlenof_j2()

size_t fawkes::JacoInterface::AngularGotoMessage::maxlenof_j2 ( ) const

Get maximum length of j2 value.

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

Definition at line 1141 of file JacoInterface.cpp.

◆ maxlenof_j3()

size_t fawkes::JacoInterface::AngularGotoMessage::maxlenof_j3 ( ) const

Get maximum length of j3 value.

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

Definition at line 1171 of file JacoInterface.cpp.

◆ maxlenof_j4()

size_t fawkes::JacoInterface::AngularGotoMessage::maxlenof_j4 ( ) const

Get maximum length of j4 value.

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

Definition at line 1201 of file JacoInterface.cpp.

◆ maxlenof_j5()

size_t fawkes::JacoInterface::AngularGotoMessage::maxlenof_j5 ( ) const

Get maximum length of j5 value.

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

Definition at line 1231 of file JacoInterface.cpp.

◆ maxlenof_j6()

size_t fawkes::JacoInterface::AngularGotoMessage::maxlenof_j6 ( ) const

Get maximum length of j6 value.

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

Definition at line 1261 of file JacoInterface.cpp.

◆ set_j1()

void fawkes::JacoInterface::AngularGotoMessage::set_j1 ( const float  new_j1)

Set j1 value.

Angular value of 1st joint

Parameters
new_j1new j1 value

Definition at line 1121 of file JacoInterface.cpp.

References fawkes::change_field().

◆ set_j2()

void fawkes::JacoInterface::AngularGotoMessage::set_j2 ( const float  new_j2)

Set j2 value.

Angular value of 2nd joint

Parameters
new_j2new j2 value

Definition at line 1151 of file JacoInterface.cpp.

References fawkes::change_field().

◆ set_j3()

void fawkes::JacoInterface::AngularGotoMessage::set_j3 ( const float  new_j3)

Set j3 value.

Angular value of 3rd joint

Parameters
new_j3new j3 value

Definition at line 1181 of file JacoInterface.cpp.

References fawkes::change_field().

◆ set_j4()

void fawkes::JacoInterface::AngularGotoMessage::set_j4 ( const float  new_j4)

Set j4 value.

Angular value of 4th joint

Parameters
new_j4new j4 value

Definition at line 1211 of file JacoInterface.cpp.

References fawkes::change_field().

◆ set_j5()

void fawkes::JacoInterface::AngularGotoMessage::set_j5 ( const float  new_j5)

Set j5 value.

Angular value of 5th joint

Parameters
new_j5new j5 value

Definition at line 1241 of file JacoInterface.cpp.

References fawkes::change_field().

◆ set_j6()

void fawkes::JacoInterface::AngularGotoMessage::set_j6 ( const float  new_j6)

Set j6 value.

Angular value of 6th joint

Parameters
new_j6new j6 value

Definition at line 1271 of file JacoInterface.cpp.

References fawkes::change_field().


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