Fawkes API  Fawkes Development Version
fawkes::SwitchInterface::EnableDurationMessage Class Reference

EnableDurationMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::SwitchInterface::EnableDurationMessage:

Public Member Functions

 EnableDurationMessage (const float ini_duration, const float ini_value)
 Constructor with initial values. More...
 
 EnableDurationMessage ()
 Constructor. More...
 
 ~EnableDurationMessage ()
 Destructor. More...
 
 EnableDurationMessage (const EnableDurationMessage *m)
 Copy constructor. More...
 
float duration () const
 Get duration value. More...
 
void set_duration (const float new_duration)
 Set duration value. More...
 
size_t maxlenof_duration () const
 Get maximum length of duration value. More...
 
float value () const
 Get value value. More...
 
void set_value (const float new_value)
 Set value value. More...
 
size_t maxlenof_value () const
 Get maximum length of value 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

Constructor & Destructor Documentation

◆ EnableDurationMessage() [1/3]

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

Constructor with initial values.

Parameters
ini_durationinitial value for duration
ini_valueinitial value for value

Definition at line 585 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.

◆ EnableDurationMessage() [2/3]

fawkes::SwitchInterface::EnableDurationMessage::EnableDurationMessage ( )

◆ ~EnableDurationMessage()

fawkes::SwitchInterface::EnableDurationMessage::~EnableDurationMessage ( )

Destructor.

Definition at line 610 of file SwitchInterface.cpp.

References fawkes::Message::data_ptr.

◆ EnableDurationMessage() [3/3]

fawkes::SwitchInterface::EnableDurationMessage::EnableDurationMessage ( const EnableDurationMessage m)

Copy constructor.

Parameters
mmessage to copy from

Definition at line 618 of file SwitchInterface.cpp.

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

Member Function Documentation

◆ clone()

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

◆ duration()

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

Referenced by FawkesBeepDaemon::loop().

◆ maxlenof_duration()

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

◆ maxlenof_value()

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

◆ set_duration()

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_durationnew duration value

Definition at line 655 of file SwitchInterface.cpp.

◆ set_value()

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_valuenew value value

Definition at line 693 of file SwitchInterface.cpp.

◆ value()

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

Referenced by FawkesBeepDaemon::loop().


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