fawkes::SwitchInterface::SetMessage Class Reference

SetMessage Fawkes BlackBoard Interface Message. More...

#include <interfaces/SwitchInterface.h>

Inheritance diagram for fawkes::SwitchInterface::SetMessage:

Inheritance graph
[legend]

List of all members.


Classes

struct  SetMessage_data_t
 Internal data storage, do NOT modify!

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

Detailed Description

SetMessage Fawkes BlackBoard Interface Message.

Definition at line 78 of file SwitchInterface.h.

Constructor & Destructor Documentation

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

Constructor with initial values.

Parameters:
ini_enabled initial value for enabled
ini_value initial value for value

Definition at line 339 of file SwitchInterface.cpp.

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

fawkes::SwitchInterface::SetMessage::SetMessage (  ) 

Constructor.

Definition at line 351 of file SwitchInterface.cpp.

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

Referenced by clone().

fawkes::SwitchInterface::SetMessage::~SetMessage (  ) 

Destructor.

Definition at line 362 of file SwitchInterface.cpp.

References fawkes::Message::data_ptr.

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

Copy constructor.

Parameters:
m message to copy from

Definition at line 370 of file SwitchInterface.cpp.

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

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 457 of file SwitchInterface.cpp.

References SetMessage().

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

Get enabled value.

True if the switch is currently enabled.

Returns:
enabled value

Definition at line 386 of file SwitchInterface.cpp.

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 396 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 432 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_enabled new enabled value

Definition at line 408 of file SwitchInterface.cpp.

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_value new value value

Definition at line 446 of file SwitchInterface.cpp.

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 422 of file SwitchInterface.cpp.

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