fawkes::KatanaInterface::SetMaxVelocityMessage Class Reference

SetMaxVelocityMessage Fawkes BlackBoard Interface Message. More...

#include <interfaces/KatanaInterface.h>

Inheritance diagram for fawkes::KatanaInterface::SetMaxVelocityMessage:

Inheritance graph
[legend]

List of all members.


Classes

struct  SetMaxVelocityMessage_data_t
 Internal data storage, do NOT modify!

Public Member Functions

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

Detailed Description

SetMaxVelocityMessage Fawkes BlackBoard Interface Message.

Definition at line 229 of file KatanaInterface.h.

Constructor & Destructor Documentation

fawkes::KatanaInterface::SetMaxVelocityMessage::SetMaxVelocityMessage ( const unsigned char  ini_max_velocity  ) 

Constructor with initial values.

Parameters:
ini_max_velocity initial value for max_velocity

Definition at line 1232 of file KatanaInterface.cpp.

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

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

Constructor.

Definition at line 1242 of file KatanaInterface.cpp.

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

Referenced by clone().

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

Destructor.

Definition at line 1252 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 1260 of file KatanaInterface.cpp.

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

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 1305 of file KatanaInterface.cpp.

References SetMaxVelocityMessage().

unsigned char fawkes::KatanaInterface::SetMaxVelocityMessage::max_velocity (  )  const

Get max_velocity value.

Maximum velocity

Returns:
max_velocity value

Definition at line 1274 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 1284 of file KatanaInterface.cpp.

void fawkes::KatanaInterface::SetMaxVelocityMessage::set_max_velocity ( const unsigned char  new_max_velocity  ) 

Set max_velocity value.

Maximum velocity

Parameters:
new_max_velocity new max_velocity value

Definition at line 1294 of file KatanaInterface.cpp.

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