Fawkes API  Fawkes Development Version
fawkes::NaoJointPositionInterface::SetServoMessage Class Reference

SetServoMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::NaoJointPositionInterface::SetServoMessage:

Public Member Functions

 SetServoMessage (const uint32_t ini_servo, const float ini_value, const int32_t ini_time)
 Constructor with initial values. More...
 
 SetServoMessage ()
 Constructor. More...
 
 ~SetServoMessage ()
 Destructor. More...
 
 SetServoMessage (const SetServoMessage *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...
 
int32_t time () const
 Get time value. More...
 
void set_time (const int32_t new_time)
 Set time value. More...
 
size_t maxlenof_time () const
 Get maximum length of time 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

◆ SetServoMessage() [1/3]

fawkes::NaoJointPositionInterface::SetServoMessage::SetServoMessage ( const uint32_t  ini_servo,
const float  ini_value,
const int32_t  ini_time 
)

Constructor with initial values.

Parameters
ini_servoinitial value for servo
ini_valueinitial value for value
ini_timeinitial value for time

Definition at line 1174 of file NaoJointPositionInterface.cpp.

References fawkes::Message::add_fieldinfo(), fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, fawkes::IFT_FLOAT, fawkes::IFT_INT32, fawkes::IFT_UINT32, fawkes::NaoJointPositionInterface::ROBOTYPE_ACADEMIC, and fawkes::NaoJointPositionInterface::ROBOTYPE_ROBOCUP.

◆ SetServoMessage() [2/3]

◆ ~SetServoMessage()

fawkes::NaoJointPositionInterface::SetServoMessage::~SetServoMessage ( )

Destructor.

Definition at line 1206 of file NaoJointPositionInterface.cpp.

References fawkes::Message::data_ptr.

◆ SetServoMessage() [3/3]

fawkes::NaoJointPositionInterface::SetServoMessage::SetServoMessage ( const SetServoMessage m)

Copy constructor.

Parameters
mmessage to copy from

Definition at line 1214 of file NaoJointPositionInterface.cpp.

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

Member Function Documentation

◆ clone()

Message * fawkes::NaoJointPositionInterface::SetServoMessage::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 1332 of file NaoJointPositionInterface.cpp.

◆ maxlenof_servo()

size_t fawkes::NaoJointPositionInterface::SetServoMessage::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 1241 of file NaoJointPositionInterface.cpp.

◆ maxlenof_time()

size_t fawkes::NaoJointPositionInterface::SetServoMessage::maxlenof_time ( ) const

Get maximum length of time value.

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

Definition at line 1307 of file NaoJointPositionInterface.cpp.

◆ maxlenof_value()

size_t fawkes::NaoJointPositionInterface::SetServoMessage::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 1273 of file NaoJointPositionInterface.cpp.

◆ servo()

uint32_t fawkes::NaoJointPositionInterface::SetServoMessage::servo ( ) const

Get servo value.

A concatenated list of SERVO_* constants 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 1231 of file NaoJointPositionInterface.cpp.

◆ set_servo()

void fawkes::NaoJointPositionInterface::SetServoMessage::set_servo ( const uint32_t  new_servo)

Set servo value.

A concatenated list of SERVO_* constants 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 1253 of file NaoJointPositionInterface.cpp.

◆ set_time()

void fawkes::NaoJointPositionInterface::SetServoMessage::set_time ( const int32_t  new_time)

Set time value.

Current reference time in ms. For real hardware this is the DCM time. Times in messages are always offsets to the current time and the current time is added before executing the command.

Parameters
new_timenew time value

Definition at line 1321 of file NaoJointPositionInterface.cpp.

◆ set_value()

void fawkes::NaoJointPositionInterface::SetServoMessage::set_value ( const float  new_value)

Set value value.

Servo value to set for servos.

Parameters
new_valuenew value value

Definition at line 1283 of file NaoJointPositionInterface.cpp.

◆ time()

int32_t fawkes::NaoJointPositionInterface::SetServoMessage::time ( ) const

Get time value.

Current reference time in ms. For real hardware this is the DCM time. Times in messages are always offsets to the current time and the current time is added before executing the command.

Returns
time value

Definition at line 1297 of file NaoJointPositionInterface.cpp.

◆ value()

float fawkes::NaoJointPositionInterface::SetServoMessage::value ( ) const

Get value value.

Servo value to set for servos.

Returns
value value

Definition at line 1263 of file NaoJointPositionInterface.cpp.


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