Fawkes API  Fawkes Development Version
fawkes::MotorInterface::SetMotorStateMessage Class Reference

SetMotorStateMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::MotorInterface::SetMotorStateMessage:

List of all members.

Classes

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

Public Member Functions

 SetMotorStateMessage (const uint32_t ini_motor_state)
 Constructor with initial values.
 SetMotorStateMessage ()
 Constructor.
 ~SetMotorStateMessage ()
 Destructor.
 SetMotorStateMessage (const SetMotorStateMessage *m)
 Copy constructor.
uint32_t motor_state () const
 Get motor_state value.
void set_motor_state (const uint32_t new_motor_state)
 Set motor_state value.
size_t maxlenof_motor_state () const
 Get maximum length of motor_state value.
virtual Messageclone () const
 Clone this message.

Detailed Description


Constructor & Destructor Documentation

fawkes::MotorInterface::SetMotorStateMessage::SetMotorStateMessage ( const uint32_t  ini_motor_state)
fawkes::MotorInterface::SetMotorStateMessage::~SetMotorStateMessage ( )

Destructor.

Definition at line 681 of file MotorInterface.cpp.

References fawkes::Interface::data_ptr.

fawkes::MotorInterface::SetMotorStateMessage::SetMotorStateMessage ( const SetMotorStateMessage m)

Copy constructor.

Parameters:
mmessage to copy from

Definition at line 689 of file MotorInterface.cpp.

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


Member Function Documentation

Message * fawkes::MotorInterface::SetMotorStateMessage::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 739 of file MotorInterface.cpp.

size_t fawkes::MotorInterface::SetMotorStateMessage::maxlenof_motor_state ( ) const

Get maximum length of motor_state value.

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

Definition at line 716 of file MotorInterface.cpp.

uint32_t fawkes::MotorInterface::SetMotorStateMessage::motor_state ( ) const

Get motor_state value.

The new motor state to set. Use the MOTOR_* constants.

Returns:
motor_state value

Definition at line 706 of file MotorInterface.cpp.

References fawkes::MotorInterface::MotorInterface_data_t::motor_state.

Referenced by PlayerMotorPositionMapper::sync_fawkes_to_player().

void fawkes::MotorInterface::SetMotorStateMessage::set_motor_state ( const uint32_t  new_motor_state)

Set motor_state value.

The new motor state to set. Use the MOTOR_* constants.

Parameters:
new_motor_statenew motor_state value

Definition at line 728 of file MotorInterface.cpp.

References fawkes::MotorInterface::MotorInterface_data_t::motor_state.


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