Fawkes API Fawkes Development Version

fawkes::LedInterface::SetIntensityMessage Class Reference

SetIntensityMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::LedInterface::SetIntensityMessage:

List of all members.

Classes

struct  SetIntensityMessage_data_t
 Internal data storage, do NOT modify!

Public Member Functions

 SetIntensityMessage (const float ini_time_sec, const float ini_intensity)
 Constructor with initial values.
 SetIntensityMessage ()
 Constructor.
 ~SetIntensityMessage ()
 Destructor.
 SetIntensityMessage (const SetIntensityMessage *m)
 Copy constructor.
float time_sec () const
 Get time_sec value.
void set_time_sec (const float new_time_sec)
 Set time_sec value.
size_t maxlenof_time_sec () const
 Get maximum length of time_sec value.
float intensity () const
 Get intensity value.
void set_intensity (const float new_intensity)
 Set intensity value.
size_t maxlenof_intensity () const
 Get maximum length of intensity value.
virtual Messageclone () const
 Clone this message.

Detailed Description

SetIntensityMessage Fawkes BlackBoard Interface Message.

Definition at line 57 of file LedInterface.h.


Constructor & Destructor Documentation

fawkes::LedInterface::SetIntensityMessage::SetIntensityMessage ( const float  ini_time_sec,
const float  ini_intensity 
)

Constructor with initial values.

Parameters:
ini_time_secinitial value for time_sec
ini_intensityinitial value for intensity

Definition at line 151 of file LedInterface.cpp.

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

fawkes::LedInterface::SetIntensityMessage::SetIntensityMessage ( )
fawkes::LedInterface::SetIntensityMessage::~SetIntensityMessage ( )

Destructor.

Definition at line 176 of file LedInterface.cpp.

References fawkes::Interface::data_ptr.

fawkes::LedInterface::SetIntensityMessage::SetIntensityMessage ( const SetIntensityMessage m)

Copy constructor.

Parameters:
mmessage to copy from

Definition at line 184 of file LedInterface.cpp.

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


Member Function Documentation

Message * fawkes::LedInterface::SetIntensityMessage::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 264 of file LedInterface.cpp.

float fawkes::LedInterface::SetIntensityMessage::intensity ( ) const

Get intensity value.

Intensity value.

Returns:
intensity value

Definition at line 233 of file LedInterface.cpp.

Referenced by PanTiltRX28Thread::loop().

size_t fawkes::LedInterface::SetIntensityMessage::maxlenof_intensity ( ) const

Get maximum length of intensity value.

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

Definition at line 243 of file LedInterface.cpp.

size_t fawkes::LedInterface::SetIntensityMessage::maxlenof_time_sec ( ) const

Get maximum length of time_sec value.

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

Definition at line 211 of file LedInterface.cpp.

void fawkes::LedInterface::SetIntensityMessage::set_intensity ( const float  new_intensity)

Set intensity value.

Intensity value.

Parameters:
new_intensitynew intensity value

Definition at line 253 of file LedInterface.cpp.

void fawkes::LedInterface::SetIntensityMessage::set_time_sec ( const float  new_time_sec)

Set time_sec value.

Time in seconds when to reach the intensity.

Parameters:
new_time_secnew time_sec value

Definition at line 223 of file LedInterface.cpp.

float fawkes::LedInterface::SetIntensityMessage::time_sec ( ) const

Get time_sec value.

Time in seconds when to reach the intensity.

Returns:
time_sec value

Definition at line 201 of file LedInterface.cpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends