fawkes::KatanaInterface::SetMaxVelocityMessage Class Reference

SetMaxVelocityMessage Fawkes BlackBoard Interface Message. More...

#include <interfaces/KatanaInterface.h>

Inheritance diagram for fawkes::KatanaInterface::SetMaxVelocityMessage:

[legend]
List of all members.

Public Member Functions

 SetMaxVelocityMessage (const uint8_t ini_max_velocity)
 Constructor with initial values.
 SetMaxVelocityMessage ()
 Constructor.
 ~SetMaxVelocityMessage ()
 Destructor.
 SetMaxVelocityMessage (const SetMaxVelocityMessage *m)
 Copy constructor.
uint8_t max_velocity () const
 Get max_velocity value.
void set_max_velocity (const uint8_t new_max_velocity)
 Set max_velocity value.
size_t maxlenof_max_velocity () const
 Get maximum length of max_velocity value.
virtual Messageclone () const
 Clone this message.

Classes

struct  SetMaxVelocityMessage_data_t
 Internal data storage, do NOT modify!

Detailed Description

SetMaxVelocityMessage Fawkes BlackBoard Interface Message.

Definition at line 307 of file KatanaInterface.h.


Constructor & Destructor Documentation

fawkes::KatanaInterface::SetMaxVelocityMessage::SetMaxVelocityMessage ( const uint8_t  ini_max_velocity  ) 

Constructor with initial values.

Parameters:
ini_max_velocity initial value for max_velocity

Definition at line 1301 of file KatanaInterface.cpp.

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

fawkes::KatanaInterface::SetMaxVelocityMessage::SetMaxVelocityMessage (  ) 

Constructor.

Definition at line 1312 of file KatanaInterface.cpp.

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

fawkes::KatanaInterface::SetMaxVelocityMessage::~SetMaxVelocityMessage (  ) 

Destructor.

Definition at line 1323 of file KatanaInterface.cpp.

References fawkes::Message::data_ptr.

fawkes::KatanaInterface::SetMaxVelocityMessage::SetMaxVelocityMessage ( const SetMaxVelocityMessage m  ) 

Copy constructor.

Parameters:
m message to copy from

Definition at line 1331 of file KatanaInterface.cpp.

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


Member Function Documentation

Message * fawkes::KatanaInterface::SetMaxVelocityMessage::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 1377 of file KatanaInterface.cpp.

uint8_t fawkes::KatanaInterface::SetMaxVelocityMessage::max_velocity (  )  const

Get max_velocity value.

Maximum velocity

Returns:
max_velocity value

Definition at line 1346 of file KatanaInterface.cpp.

Referenced by KatanaActThread::loop().

size_t fawkes::KatanaInterface::SetMaxVelocityMessage::maxlenof_max_velocity (  )  const

Get maximum length of max_velocity value.

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

Definition at line 1356 of file KatanaInterface.cpp.

void fawkes::KatanaInterface::SetMaxVelocityMessage::set_max_velocity ( const uint8_t  new_max_velocity  ) 

Set max_velocity value.

Maximum velocity

Parameters:
new_max_velocity new max_velocity value

Definition at line 1366 of file KatanaInterface.cpp.


The documentation for this class was generated from the following files:
Generated on Tue Feb 22 13:32:41 2011 for Fawkes API by  doxygen 1.4.7