EnableDurationMessage Fawkes BlackBoard Interface Message. More...
#include <interfaces/SwitchInterface.h>
Classes | |
struct | EnableDurationMessage_data_t |
Internal data storage, do NOT modify! | |
Public Member Functions | |
EnableDurationMessage (const float ini_duration, const float ini_value) | |
Constructor with initial values. | |
EnableDurationMessage () | |
Constructor. | |
~EnableDurationMessage () | |
Destructor. | |
EnableDurationMessage (const EnableDurationMessage *m) | |
Copy constructor. | |
float | duration () const |
Get duration value. | |
void | set_duration (const float new_duration) |
Set duration value. | |
size_t | maxlenof_duration () const |
Get maximum length of duration 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. |
EnableDurationMessage Fawkes BlackBoard Interface Message.
Definition at line 163 of file SwitchInterface.h.
fawkes::SwitchInterface::EnableDurationMessage::EnableDurationMessage | ( | const float | ini_duration, | |
const float | ini_value | |||
) |
Constructor with initial values.
ini_duration | initial value for duration | |
ini_value | initial value for value |
Definition at line 583 of file SwitchInterface.cpp.
References fawkes::Message::add_fieldinfo(), fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, and fawkes::IFT_FLOAT.
fawkes::SwitchInterface::EnableDurationMessage::EnableDurationMessage | ( | ) |
Constructor.
Definition at line 596 of file SwitchInterface.cpp.
References fawkes::Message::add_fieldinfo(), fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, and fawkes::IFT_FLOAT.
Referenced by clone().
fawkes::SwitchInterface::EnableDurationMessage::~EnableDurationMessage | ( | ) |
Destructor.
Definition at line 608 of file SwitchInterface.cpp.
References fawkes::Message::data_ptr.
fawkes::SwitchInterface::EnableDurationMessage::EnableDurationMessage | ( | const EnableDurationMessage * | m | ) |
Copy constructor.
m | message to copy from |
Definition at line 616 of file SwitchInterface.cpp.
References fawkes::Message::data_ptr, fawkes::Message::data_size, and fawkes::Message::data_ts.
Message * fawkes::SwitchInterface::EnableDurationMessage::clone | ( | ) | const [virtual] |
Clone this message.
Produces a message of the same type as this message and copies the data to the new message.
Reimplemented from fawkes::Message.
Definition at line 702 of file SwitchInterface.cpp.
References EnableDurationMessage().
float fawkes::SwitchInterface::EnableDurationMessage::duration | ( | ) | const |
Get duration value.
Duration in seconds for which the switch should be enabled.
Definition at line 632 of file SwitchInterface.cpp.
Referenced by FawkesBeepDaemon::loop().
size_t fawkes::SwitchInterface::EnableDurationMessage::maxlenof_duration | ( | ) | const |
Get maximum length of duration value.
Definition at line 642 of file SwitchInterface.cpp.
size_t fawkes::SwitchInterface::EnableDurationMessage::maxlenof_value | ( | ) | const |
Get maximum length of value value.
Definition at line 677 of file SwitchInterface.cpp.
void fawkes::SwitchInterface::EnableDurationMessage::set_duration | ( | const float | new_duration | ) |
Set duration value.
Duration in seconds for which the switch should be enabled.
new_duration | new duration value |
Definition at line 653 of file SwitchInterface.cpp.
void fawkes::SwitchInterface::EnableDurationMessage::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.
new_value | new value value |
Definition at line 691 of file SwitchInterface.cpp.
float fawkes::SwitchInterface::EnableDurationMessage::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.
Definition at line 667 of file SwitchInterface.cpp.
Referenced by FawkesBeepDaemon::loop().