fawkes::KatanaInterface::SetEnabledMessage Class Reference

SetEnabledMessage Fawkes BlackBoard Interface Message. More...

#include <interfaces/KatanaInterface.h>

Inheritance diagram for fawkes::KatanaInterface::SetEnabledMessage:

Inheritance graph
[legend]

List of all members.


Classes

struct  SetEnabledMessage_data_t
 Internal data storage, do NOT modify!

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 Message * clone () const
 Clone this message.

Detailed Description

SetEnabledMessage Fawkes BlackBoard Interface Message.

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

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

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

Constructor.

Definition at line 1155 of file KatanaInterface.cpp.

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

Referenced by clone().

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

Destructor.

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

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

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

References SetEnabledMessage().

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

Get enabled value.

Are motors enabled?

Returns:
enabled value

Definition at line 1187 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 1197 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 1207 of file KatanaInterface.cpp.

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