fawkes::KatanaInterface::SetEnabledMessage Class Reference

SetEnabledMessage Fawkes BlackBoard Interface Message. More...

#include <interfaces/KatanaInterface.h>

Inheritance diagram for fawkes::KatanaInterface::SetEnabledMessage:

[legend]
List of all members.

Public Member Functions

 SetEnabledMessage (const bool ini_enabled)
 Constructor with initial values.
 SetEnabledMessage ()
 Constructor.
 ~SetEnabledMessage ()
 Destructor.
 SetEnabledMessage (const SetEnabledMessage *m)
 Copy constructor.
bool is_enabled () const
 Get enabled value.
void set_enabled (const bool new_enabled)
 Set enabled value.
size_t maxlenof_enabled () const
 Get maximum length of enabled value.
virtual Messageclone () const
 Clone this message.

Classes

struct  SetEnabledMessage_data_t
 Internal data storage, do NOT modify!

Detailed Description

SetEnabledMessage Fawkes BlackBoard Interface Message.

Definition at line 280 of file KatanaInterface.h.


Constructor & Destructor Documentation

fawkes::KatanaInterface::SetEnabledMessage::SetEnabledMessage ( const bool  ini_enabled  ) 

Constructor with initial values.

Parameters:
ini_enabled initial value for enabled

Definition at line 1211 of file KatanaInterface.cpp.

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

fawkes::KatanaInterface::SetEnabledMessage::SetEnabledMessage (  ) 

Constructor.

Definition at line 1222 of file KatanaInterface.cpp.

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

fawkes::KatanaInterface::SetEnabledMessage::~SetEnabledMessage (  ) 

Destructor.

Definition at line 1233 of file KatanaInterface.cpp.

References fawkes::Message::data_ptr.

fawkes::KatanaInterface::SetEnabledMessage::SetEnabledMessage ( const SetEnabledMessage m  ) 

Copy constructor.

Parameters:
m message to copy from

Definition at line 1241 of file KatanaInterface.cpp.

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


Member Function Documentation

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

bool fawkes::KatanaInterface::SetEnabledMessage::is_enabled (  )  const

Get enabled value.

Are motors enabled?

Returns:
enabled value

Definition at line 1256 of file KatanaInterface.cpp.

Referenced by KatanaActThread::loop().

size_t fawkes::KatanaInterface::SetEnabledMessage::maxlenof_enabled (  )  const

Get maximum length of enabled value.

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

Definition at line 1266 of file KatanaInterface.cpp.

void fawkes::KatanaInterface::SetEnabledMessage::set_enabled ( const bool  new_enabled  ) 

Set enabled value.

Are motors enabled?

Parameters:
new_enabled new enabled value

Definition at line 1276 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