fawkes::SwitchInterface::EnableDurationMessage Class Reference

EnableDurationMessage Fawkes BlackBoard Interface Message. More...

#include <interfaces/SwitchInterface.h>

Inheritance diagram for fawkes::SwitchInterface::EnableDurationMessage:
Inheritance graph
[legend]

List of all members.

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 Messageclone () const
 Clone this message.

Detailed Description

EnableDurationMessage Fawkes BlackBoard Interface Message.

Definition at line 163 of file SwitchInterface.h.


Constructor & Destructor Documentation

fawkes::SwitchInterface::EnableDurationMessage::EnableDurationMessage ( const float  ini_duration,
const float  ini_value 
)

Constructor with initial values.

Parameters:
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 (  ) 
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.

Parameters:
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.


Member Function Documentation

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.

Returns:
clone of this 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.

Returns:
duration value

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.

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

Definition at line 642 of file SwitchInterface.cpp.

size_t fawkes::SwitchInterface::EnableDurationMessage::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 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.

Parameters:
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.

Parameters:
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.

Returns:
value value

Definition at line 667 of file SwitchInterface.cpp.

Referenced by FawkesBeepDaemon::loop().


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

Generated on 1 Mar 2011 for Fawkes API by  doxygen 1.6.1