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

SetServoMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::NaoJointPositionInterface::SetServoMessage:

List of all members.

Classes

struct  SetServoMessage_data_t
 Internal data storage, do NOT modify! More...

Public Member Functions

 SetServoMessage (const uint32_t ini_servo, const float ini_value, const int32_t ini_time)
 Constructor with initial values.
 SetServoMessage ()
 Constructor.
 ~SetServoMessage ()
 Destructor.
 SetServoMessage (const SetServoMessage *m)
 Copy constructor.
uint32_t servo () const
 Get servo value.
void set_servo (const uint32_t new_servo)
 Set servo value.
size_t maxlenof_servo () const
 Get maximum length of servo value.
float value () const
 Get value value.
void set_value (const float new_value)
 Set value value.
size_t maxlenof_value () const
 Get maximum length of value value.
int32_t time () const
 Get time value.
void set_time (const int32_t new_time)
 Set time value.
size_t maxlenof_time () const
 Get maximum length of time value.
virtual Messageclone () const
 Clone this message.

Detailed Description


Constructor & Destructor Documentation

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

Destructor.

Definition at line 1198 of file NaoJointPositionInterface.cpp.

References fawkes::Interface::data_ptr.

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

Copy constructor.

Parameters:
mmessage to copy from

Definition at line 1206 of file NaoJointPositionInterface.cpp.

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


Member Function Documentation

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 1324 of file NaoJointPositionInterface.cpp.

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 1233 of file NaoJointPositionInterface.cpp.

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 1299 of file NaoJointPositionInterface.cpp.

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 1265 of file NaoJointPositionInterface.cpp.

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 1223 of file NaoJointPositionInterface.cpp.

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 1245 of file NaoJointPositionInterface.cpp.

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 1313 of file NaoJointPositionInterface.cpp.

References fawkes::NaoJointPositionInterface::NaoJointPositionInterface_data_t::time.

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 1275 of file NaoJointPositionInterface.cpp.

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 1289 of file NaoJointPositionInterface.cpp.

References fawkes::NaoJointPositionInterface::NaoJointPositionInterface_data_t::time.

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

Get value value.

Servo value to set for servos.

Returns:
value value

Definition at line 1255 of file NaoJointPositionInterface.cpp.


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