fawkes::MotorInterface::SetMotorStateMessage Class Reference

SetMotorStateMessage Fawkes BlackBoard Interface Message. More...

#include <interfaces/MotorInterface.h>

Inheritance diagram for fawkes::MotorInterface::SetMotorStateMessage:

Inheritance graph
[legend]

List of all members.


Classes

struct  SetMotorStateMessage_data_t
 Internal data storage, do NOT modify!

Public Member Functions

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

Detailed Description

SetMotorStateMessage Fawkes BlackBoard Interface Message.

Definition at line 103 of file MotorInterface.h.

Constructor & Destructor Documentation

fawkes::MotorInterface::SetMotorStateMessage::SetMotorStateMessage ( const unsigned int  ini_motor_state  ) 

Constructor with initial values.

Parameters:
ini_motor_state initial value for motor_state

Definition at line 638 of file MotorInterface.cpp.

References fawkes::Message::add_fieldinfo(), fawkes::Message::data_ptr, fawkes::Message::data_size, and fawkes::IFT_UINT.

fawkes::MotorInterface::SetMotorStateMessage::SetMotorStateMessage (  ) 

Constructor.

Definition at line 648 of file MotorInterface.cpp.

References fawkes::Message::add_fieldinfo(), fawkes::Message::data_ptr, fawkes::Message::data_size, and fawkes::IFT_UINT.

Referenced by clone().

fawkes::MotorInterface::SetMotorStateMessage::~SetMotorStateMessage (  ) 

Destructor.

Definition at line 658 of file MotorInterface.cpp.

References fawkes::Message::data_ptr.

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

Copy constructor.

Parameters:
m message to copy from

Definition at line 666 of file MotorInterface.cpp.

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

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 715 of file MotorInterface.cpp.

References SetMotorStateMessage().

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 692 of file MotorInterface.cpp.

unsigned int 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 682 of file MotorInterface.cpp.

Referenced by PlayerMotorPositionMapper::sync_fawkes_to_player().

void fawkes::MotorInterface::SetMotorStateMessage::set_motor_state ( const unsigned int  new_motor_state  ) 

Set motor_state value.

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

Parameters:
new_motor_state new motor_state value

Definition at line 704 of file MotorInterface.cpp.

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