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

MoveGripperMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::JacoInterface::MoveGripperMessage:

Public Member Functions

 MoveGripperMessage (const float ini_finger1, const float ini_finger2, const float ini_finger3)
 Constructor with initial values. More...
 
 MoveGripperMessage ()
 Constructor. More...
 
 ~MoveGripperMessage ()
 Destructor. More...
 
 MoveGripperMessage (const MoveGripperMessage *m)
 Copy constructor. More...
 
float finger1 () const
 Get finger1 value. More...
 
void set_finger1 (const float new_finger1)
 Set finger1 value. More...
 
size_t maxlenof_finger1 () const
 Get maximum length of finger1 value. More...
 
float finger2 () const
 Get finger2 value. More...
 
void set_finger2 (const float new_finger2)
 Set finger2 value. More...
 
size_t maxlenof_finger2 () const
 Get maximum length of finger2 value. More...
 
float finger3 () const
 Get finger3 value. More...
 
void set_finger3 (const float new_finger3)
 Set finger3 value. More...
 
size_t maxlenof_finger3 () const
 Get maximum length of finger3 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

MoveGripperMessage Fawkes BlackBoard Interface Message.

Definition at line 225 of file JacoInterface.h.

Constructor & Destructor Documentation

◆ MoveGripperMessage() [1/3]

fawkes::JacoInterface::MoveGripperMessage::MoveGripperMessage ( const float  ini_finger1,
const float  ini_finger2,
const float  ini_finger3 
)

Constructor with initial values.

Parameters
ini_finger1initial value for finger1
ini_finger2initial value for finger2
ini_finger3initial value for finger3

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

◆ MoveGripperMessage() [2/3]

fawkes::JacoInterface::MoveGripperMessage::MoveGripperMessage ( )

◆ ~MoveGripperMessage()

fawkes::JacoInterface::MoveGripperMessage::~MoveGripperMessage ( )

Destructor.

Definition at line 1345 of file JacoInterface.cpp.

References fawkes::Message::data_ptr.

◆ MoveGripperMessage() [3/3]

fawkes::JacoInterface::MoveGripperMessage::MoveGripperMessage ( const MoveGripperMessage m)

Copy constructor.

Parameters
mmessage to copy from

Definition at line 1353 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::MoveGripperMessage::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 1459 of file JacoInterface.cpp.

◆ finger1()

float fawkes::JacoInterface::MoveGripperMessage::finger1 ( ) const

Get finger1 value.

Value of finger 1. Range [0,60]

Returns
finger1 value

Definition at line 1368 of file JacoInterface.cpp.

Referenced by JacoActThread::loop().

◆ finger2()

float fawkes::JacoInterface::MoveGripperMessage::finger2 ( ) const

Get finger2 value.

Value of finger 2. Range [0,60]

Returns
finger2 value

Definition at line 1398 of file JacoInterface.cpp.

Referenced by JacoActThread::loop().

◆ finger3()

float fawkes::JacoInterface::MoveGripperMessage::finger3 ( ) const

Get finger3 value.

Value of finger 3. Range [0,60]

Returns
finger3 value

Definition at line 1428 of file JacoInterface.cpp.

Referenced by JacoActThread::loop().

◆ maxlenof_finger1()

size_t fawkes::JacoInterface::MoveGripperMessage::maxlenof_finger1 ( ) const

Get maximum length of finger1 value.

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

Definition at line 1378 of file JacoInterface.cpp.

◆ maxlenof_finger2()

size_t fawkes::JacoInterface::MoveGripperMessage::maxlenof_finger2 ( ) const

Get maximum length of finger2 value.

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

Definition at line 1408 of file JacoInterface.cpp.

◆ maxlenof_finger3()

size_t fawkes::JacoInterface::MoveGripperMessage::maxlenof_finger3 ( ) const

Get maximum length of finger3 value.

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

Definition at line 1438 of file JacoInterface.cpp.

◆ set_finger1()

void fawkes::JacoInterface::MoveGripperMessage::set_finger1 ( const float  new_finger1)

Set finger1 value.

Value of finger 1. Range [0,60]

Parameters
new_finger1new finger1 value

Definition at line 1388 of file JacoInterface.cpp.

◆ set_finger2()

void fawkes::JacoInterface::MoveGripperMessage::set_finger2 ( const float  new_finger2)

Set finger2 value.

Value of finger 2. Range [0,60]

Parameters
new_finger2new finger2 value

Definition at line 1418 of file JacoInterface.cpp.

◆ set_finger3()

void fawkes::JacoInterface::MoveGripperMessage::set_finger3 ( const float  new_finger3)

Set finger3 value.

Value of finger 3. Range [0,60]

Parameters
new_finger3new finger3 value

Definition at line 1448 of file JacoInterface.cpp.


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