Fawkes API  Fawkes Development Version
fawkes::NaoJointStiffnessInterface::SetStiffnessMessage Class Reference

SetStiffnessMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::NaoJointStiffnessInterface::SetStiffnessMessage:

Public Member Functions

 SetStiffnessMessage (const uint32_t ini_servo, const float ini_value, const float ini_time_sec)
 Constructor with initial values. More...
 
 SetStiffnessMessage ()
 Constructor. More...
 
 ~SetStiffnessMessage ()
 Destructor. More...
 
 SetStiffnessMessage (const SetStiffnessMessage *m)
 Copy constructor. More...
 
uint32_t servo () const
 Get servo value. More...
 
void set_servo (const uint32_t new_servo)
 Set servo value. More...
 
size_t maxlenof_servo () const
 Get maximum length of servo value. More...
 
float value () const
 Get value value. More...
 
void set_value (const float new_value)
 Set value value. More...
 
size_t maxlenof_value () const
 Get maximum length of value value. More...
 
float time_sec () const
 Get time_sec value. More...
 
void set_time_sec (const float new_time_sec)
 Set time_sec value. More...
 
size_t maxlenof_time_sec () const
 Get maximum length of time_sec 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

◆ SetStiffnessMessage() [1/3]

fawkes::NaoJointStiffnessInterface::SetStiffnessMessage::SetStiffnessMessage ( const uint32_t  ini_servo,
const float  ini_value,
const float  ini_time_sec 
)

Constructor with initial values.

Parameters
ini_servoinitial value for servo
ini_valueinitial value for value
ini_time_secinitial value for time_sec

Definition at line 986 of file NaoJointStiffnessInterface.cpp.

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

◆ SetStiffnessMessage() [2/3]

fawkes::NaoJointStiffnessInterface::SetStiffnessMessage::SetStiffnessMessage ( )

◆ ~SetStiffnessMessage()

fawkes::NaoJointStiffnessInterface::SetStiffnessMessage::~SetStiffnessMessage ( )

Destructor.

Definition at line 1014 of file NaoJointStiffnessInterface.cpp.

References fawkes::Message::data_ptr.

◆ SetStiffnessMessage() [3/3]

fawkes::NaoJointStiffnessInterface::SetStiffnessMessage::SetStiffnessMessage ( const SetStiffnessMessage m)

Copy constructor.

Parameters
mmessage to copy from

Definition at line 1022 of file NaoJointStiffnessInterface.cpp.

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

Member Function Documentation

◆ clone()

Message * fawkes::NaoJointStiffnessInterface::SetStiffnessMessage::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 1138 of file NaoJointStiffnessInterface.cpp.

◆ maxlenof_servo()

size_t fawkes::NaoJointStiffnessInterface::SetStiffnessMessage::maxlenof_servo ( ) const

Get maximum length of servo value.

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

Definition at line 1052 of file NaoJointStiffnessInterface.cpp.

◆ maxlenof_time_sec()

size_t fawkes::NaoJointStiffnessInterface::SetStiffnessMessage::maxlenof_time_sec ( ) const

Get maximum length of time_sec value.

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

Definition at line 1117 of file NaoJointStiffnessInterface.cpp.

◆ maxlenof_value()

size_t fawkes::NaoJointStiffnessInterface::SetStiffnessMessage::maxlenof_value ( ) const

Get maximum length of value value.

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

Definition at line 1087 of file NaoJointStiffnessInterface.cpp.

◆ servo()

uint32_t fawkes::NaoJointStiffnessInterface::SetStiffnessMessage::servo ( ) const

Get servo value.

A concatenated list of SERVO_* constants from the NaoJointPositionInterface to define the servos that should execute the movement. The list shall consist of binary or'ed SERVO_* constants.

Returns
servo value

Definition at line 1042 of file NaoJointStiffnessInterface.cpp.

◆ set_servo()

void fawkes::NaoJointStiffnessInterface::SetStiffnessMessage::set_servo ( const uint32_t  new_servo)

Set servo value.

A concatenated list of SERVO_* constants from the NaoJointPositionInterface to define the servos that should execute the movement. The list shall consist of binary or'ed SERVO_* constants.

Parameters
new_servonew servo value

Definition at line 1067 of file NaoJointStiffnessInterface.cpp.

◆ set_time_sec()

void fawkes::NaoJointStiffnessInterface::SetStiffnessMessage::set_time_sec ( const float  new_time_sec)

Set time_sec value.

Time when to reach the stiffness.

Parameters
new_time_secnew time_sec value

Definition at line 1127 of file NaoJointStiffnessInterface.cpp.

◆ set_value()

void fawkes::NaoJointStiffnessInterface::SetStiffnessMessage::set_value ( const float  new_value)

Set value value.

Servo value to set for servos.

Parameters
new_valuenew value value

Definition at line 1097 of file NaoJointStiffnessInterface.cpp.

◆ time_sec()

float fawkes::NaoJointStiffnessInterface::SetStiffnessMessage::time_sec ( ) const

Get time_sec value.

Time when to reach the stiffness.

Returns
time_sec value

Definition at line 1107 of file NaoJointStiffnessInterface.cpp.

◆ value()

float fawkes::NaoJointStiffnessInterface::SetStiffnessMessage::value ( ) const

Get value value.

Servo value to set for servos.

Returns
value value

Definition at line 1077 of file NaoJointStiffnessInterface.cpp.


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