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

MoveServoMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::NaoJointPositionInterface::MoveServoMessage:

List of all members.

Classes

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

Public Member Functions

 MoveServoMessage (const uint32_t ini_servo, const float ini_value, const float ini_speed)
 Constructor with initial values.
 MoveServoMessage ()
 Constructor.
 ~MoveServoMessage ()
 Destructor.
 MoveServoMessage (const MoveServoMessage *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.
float speed () const
 Get speed value.
void set_speed (const float new_speed)
 Set speed value.
size_t maxlenof_speed () const
 Get maximum length of speed value.
virtual Messageclone () const
 Clone this message.

Detailed Description


Constructor & Destructor Documentation

fawkes::NaoJointPositionInterface::MoveServoMessage::MoveServoMessage ( const uint32_t  ini_servo,
const float  ini_value,
const float  ini_speed 
)
fawkes::NaoJointPositionInterface::MoveServoMessage::~MoveServoMessage ( )

Destructor.

Definition at line 2350 of file NaoJointPositionInterface.cpp.

References fawkes::Interface::data_ptr.

fawkes::NaoJointPositionInterface::MoveServoMessage::MoveServoMessage ( const MoveServoMessage m)

Copy constructor.

Parameters:
mmessage to copy from

Definition at line 2358 of file NaoJointPositionInterface.cpp.

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


Member Function Documentation

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

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

size_t fawkes::NaoJointPositionInterface::MoveServoMessage::maxlenof_speed ( ) const

Get maximum length of speed value.

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

Definition at line 2453 of file NaoJointPositionInterface.cpp.

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

uint32_t fawkes::NaoJointPositionInterface::MoveServoMessage::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 2377 of file NaoJointPositionInterface.cpp.

void fawkes::NaoJointPositionInterface::MoveServoMessage::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 2401 of file NaoJointPositionInterface.cpp.

void fawkes::NaoJointPositionInterface::MoveServoMessage::set_speed ( const float  new_speed)

Set speed value.

Fraction of max speed in range [0.0..1.0].

Parameters:
new_speednew speed value

Definition at line 2465 of file NaoJointPositionInterface.cpp.

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

Set value value.

Servo value to set for servos.

Parameters:
new_valuenew value value

Definition at line 2431 of file NaoJointPositionInterface.cpp.

float fawkes::NaoJointPositionInterface::MoveServoMessage::speed ( ) const

Get speed value.

Fraction of max speed in range [0.0..1.0].

Returns:
speed value

Definition at line 2443 of file NaoJointPositionInterface.cpp.

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

Get value value.

Servo value to set for servos.

Returns:
value value

Definition at line 2411 of file NaoJointPositionInterface.cpp.


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