Fawkes API  Fawkes Development Version
fawkes::LedInterface::SetIntensityMessage Class Reference

SetIntensityMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::LedInterface::SetIntensityMessage:

Public Member Functions

 SetIntensityMessage (const float ini_time_sec, const float ini_intensity)
 Constructor with initial values. More...
 
 SetIntensityMessage ()
 Constructor. More...
 
 ~SetIntensityMessage ()
 Destructor. More...
 
 SetIntensityMessage (const SetIntensityMessage *m)
 Copy constructor. More...
 
float time_sec () const
 Get time_sec value. More...
 
void set_time_sec (const float new_time_sec)
 Set time_sec value. More...
 
size_t maxlenof_time_sec () const
 Get maximum length of time_sec value. More...
 
float intensity () const
 Get intensity value. More...
 
void set_intensity (const float new_intensity)
 Set intensity value. More...
 
size_t maxlenof_intensity () const
 Get maximum length of intensity value. More...
 
virtual Messageclone () const
 Clone this message. More...
 
- Public Member Functions inherited from fawkes::Message
 Message (const char *type)
 Constructor. More...
 
 Message (const Message *mesg)
 Copy constructor. More...
 
 Message (const Message &mesg)
 Copy constructor. More...
 
virtual ~Message ()
 Destructor. More...
 
Messageoperator= (const Message &m)
 Assign this message to given message. More...
 
unsigned int id () const
 Get message ID. More...
 
void set_id (unsigned int message_id)
 Set message ID. More...
 
void mark_enqueued ()
 Mark message as being enqueued. More...
 
bool enqueued () const
 Check is message has been enqueued. More...
 
const Timetime_enqueued () const
 Get time when message was enqueued. More...
 
unsigned int sender_id () const
 Get ID of sender. More...
 
const char * sender_thread_name () const
 Get sender of message. More...
 
Interfaceinterface () const
 Get transmitting interface. More...
 
const char * type () const
 Get message type. More...
 
InterfaceFieldIterator fields ()
 Get iterator over all fields of this interface instance. More...
 
InterfaceFieldIterator fields_end ()
 Invalid iterator. More...
 
unsigned int num_fields () const
 Get the number of fields in the message. More...
 
const void * datachunk () const
 Get pointer to data. More...
 
unsigned int datasize () const
 Get size of data. More...
 
unsigned int hops () const
 Get number of hops. More...
 
void set_hops (unsigned int hops)
 Set number of hops. More...
 
void set_from_chunk (const void *chunk)
 Set from raw data chunk. More...
 
unsigned int recipient () const
 Get recipient memory serial. More...
 
template<class MessageType >
bool is_of_type ()
 Check if message has desired type. More...
 
template<class MessageType >
MessageType * as_type ()
 Cast message to given type if possible. More...
 
- Public Member Functions inherited from fawkes::RefCount
 RefCount ()
 Constructor. More...
 
virtual ~RefCount ()
 Destructor. More...
 
void ref ()
 Increment reference count. More...
 
void unref ()
 Decrement reference count and conditionally delete this instance. More...
 
unsigned int refcount ()
 Get reference count for this instance. More...
 

Additional Inherited Members

- Protected Member Functions inherited from fawkes::Message
void add_fieldinfo (interface_fieldtype_t type, const char *name, size_t length, void *value, const char *enumtype=0, const interface_enum_map_t *enum_map=0)
 Add an entry to the info list. More...
 
- Protected Attributes inherited from fawkes::Message
void * data_ptr
 Pointer to memory that contains local data. More...
 
unsigned int data_size
 Size of memory needed to hold all data. More...
 
message_data_ts_tdata_ts
 data timestamp aliasing pointer More...
 

Detailed Description

SetIntensityMessage Fawkes BlackBoard Interface Message.

Definition at line 55 of file LedInterface.h.

Constructor & Destructor Documentation

◆ SetIntensityMessage() [1/3]

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 153 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.

◆ SetIntensityMessage() [2/3]

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

◆ ~SetIntensityMessage()

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

Destructor.

Definition at line 178 of file LedInterface.cpp.

References fawkes::Message::data_ptr.

◆ SetIntensityMessage() [3/3]

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

Copy constructor.

Parameters
mmessage to copy from

Definition at line 186 of file LedInterface.cpp.

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

Member Function Documentation

◆ clone()

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 266 of file LedInterface.cpp.

◆ intensity()

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

Get intensity value.

Intensity value.

Returns
intensity value

Definition at line 235 of file LedInterface.cpp.

Referenced by NaoQiLedThread::bb_interface_message_received(), DynamixelDriverThread::exec_act(), and PanTiltRX28Thread::loop().

◆ maxlenof_intensity()

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 245 of file LedInterface.cpp.

◆ maxlenof_time_sec()

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 213 of file LedInterface.cpp.

◆ set_intensity()

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

Set intensity value.

Intensity value.

Parameters
new_intensitynew intensity value

Definition at line 255 of file LedInterface.cpp.

◆ set_time_sec()

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 225 of file LedInterface.cpp.

◆ time_sec()

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 203 of file LedInterface.cpp.

Referenced by NaoQiLedThread::bb_interface_message_received().


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