Fawkes API  Fawkes Development Version
fawkes::SwitchInterface::SetMessage Class Reference

SetMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::SwitchInterface::SetMessage:

List of all members.

Classes

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

Public Member Functions

 SetMessage (const bool ini_enabled, const float ini_value)
 Constructor with initial values.
 SetMessage ()
 Constructor.
 ~SetMessage ()
 Destructor.
 SetMessage (const SetMessage *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.
float value () const
 Get value value.
void set_value (const float new_value)
 Set value value.
size_t maxlenof_value () const
 Get maximum length of value value.
virtual Messageclone () const
 Clone this message.

Detailed Description


Constructor & Destructor Documentation

fawkes::SwitchInterface::SetMessage::SetMessage ( const bool  ini_enabled,
const float  ini_value 
)
fawkes::SwitchInterface::SetMessage::~SetMessage ( )

Destructor.

Definition at line 380 of file SwitchInterface.cpp.

References fawkes::Interface::data_ptr.

fawkes::SwitchInterface::SetMessage::SetMessage ( const SetMessage m)

Copy constructor.

Parameters:
mmessage to copy from

Definition at line 388 of file SwitchInterface.cpp.

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


Member Function Documentation

Message * fawkes::SwitchInterface::SetMessage::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 476 of file SwitchInterface.cpp.

bool fawkes::SwitchInterface::SetMessage::is_enabled ( ) const

Get enabled value.

True if the switch is currently enabled.

Returns:
enabled value

Definition at line 405 of file SwitchInterface.cpp.

References fawkes::SwitchInterface::SwitchInterface_data_t::enabled.

Referenced by FawkesBeepDaemon::loop().

size_t fawkes::SwitchInterface::SetMessage::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 415 of file SwitchInterface.cpp.

size_t fawkes::SwitchInterface::SetMessage::maxlenof_value ( ) const

Get maximum length of value value.

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

Definition at line 451 of file SwitchInterface.cpp.

void fawkes::SwitchInterface::SetMessage::set_enabled ( const bool  new_enabled)

Set enabled value.

True if the switch is currently enabled.

Parameters:
new_enablednew enabled value

Definition at line 427 of file SwitchInterface.cpp.

References fawkes::SwitchInterface::SwitchInterface_data_t::enabled.

void fawkes::SwitchInterface::SetMessage::set_value ( const float  new_value)

Set value value.

If switches support multiple states these can be indicated with this value. For example for a switch that notes the intensity it could be a value in the valid range.

Parameters:
new_valuenew value value

Definition at line 465 of file SwitchInterface.cpp.

References fawkes::SwitchInterface::SwitchInterface_data_t::value.

float fawkes::SwitchInterface::SetMessage::value ( ) const

Get value value.

If switches support multiple states these can be indicated with this value. For example for a switch that notes the intensity it could be a value in the valid range.

Returns:
value value

Definition at line 441 of file SwitchInterface.cpp.

References fawkes::SwitchInterface::SwitchInterface_data_t::value.

Referenced by FawkesBeepDaemon::loop().


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