Fawkes API  Fawkes Development Version
fawkes::PanTiltInterface::SetEnabledMessage Class Reference

SetEnabledMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::PanTiltInterface::SetEnabledMessage:

List of all members.

Classes

struct  SetEnabledMessage_data_t
 Internal data storage, do NOT modify! More...

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.

Detailed Description


Constructor & Destructor Documentation

fawkes::PanTiltInterface::SetEnabledMessage::SetEnabledMessage ( const bool  ini_enabled)
fawkes::PanTiltInterface::SetEnabledMessage::~SetEnabledMessage ( )

Destructor.

Definition at line 1222 of file PanTiltInterface.cpp.

References fawkes::Interface::data_ptr.

fawkes::PanTiltInterface::SetEnabledMessage::SetEnabledMessage ( const SetEnabledMessage m)

Copy constructor.

Parameters:
mmessage to copy from

Definition at line 1230 of file PanTiltInterface.cpp.

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


Member Function Documentation

Message * fawkes::PanTiltInterface::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 1276 of file PanTiltInterface.cpp.

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

Get enabled value.

Is the pan/tilt unit enabled?

Returns:
enabled value

Definition at line 1245 of file PanTiltInterface.cpp.

References fawkes::PanTiltInterface::PanTiltInterface_data_t::enabled.

Referenced by PanTiltRX28Thread::loop().

size_t fawkes::PanTiltInterface::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 1255 of file PanTiltInterface.cpp.

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

Set enabled value.

Is the pan/tilt unit enabled?

Parameters:
new_enablednew enabled value

Definition at line 1265 of file PanTiltInterface.cpp.

References fawkes::PanTiltInterface::PanTiltInterface_data_t::enabled.


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