EnableDurationMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::SwitchInterface::EnableDurationMessage:

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.
Public Member Functions inherited from fawkes::Message
	Message (const char *type)
	Constructor.
	Message (const Message *mesg)
	Copy constructor.
	Message (const Message &mesg)
	Copy constructor.
virtual	~Message ()
	Destructor.
Message &	operator= (const Message &m)
	Assign this message to given message.
unsigned int	id () const
	Get message ID.
void	set_id (unsigned int message_id)
	Set message ID.
void	mark_enqueued ()
	Mark message as being enqueued.
bool	enqueued () const
	Check is message has been enqueued.
const Time *	time_enqueued () const
	Get time when message was enqueued.
unsigned int	sender_id () const
	Get ID of sender.
const char *	sender_thread_name () const
	Get sender of message.
Interface *	interface () const
	Get transmitting interface.
const char *	type () const
	Get message type.
InterfaceFieldIterator	fields ()
	Get iterator over all fields of this interface instance.
InterfaceFieldIterator	fields_end ()
	Invalid iterator.
unsigned int	num_fields () const
	Get the number of fields in the message.
const void *	datachunk () const
	Get pointer to data.
unsigned int	datasize () const
	Get size of data.
unsigned int	hops () const
	Get number of hops.
void	set_hops (unsigned int hops)
	Set number of hops.
void	set_from_chunk (const void *chunk)
	Set from raw data chunk.
unsigned int	recipient () const
	Get recipient memory serial.
template<class MessageType >
bool	is_of_type ()
	Check if message has desired type.
Public Member Functions inherited from fawkes::RefCount
	RefCount ()
	Constructor.
virtual	~RefCount ()
	Destructor.
void	ref ()
	Increment reference count.
void	unref ()
	Decrement reference count and conditionally delete this instance.
unsigned int	refcount ()
	Get reference count for this instance.

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)
	Add an entry to the info list.
Protected Attributes inherited from fawkes::Message
void *	data_ptr
	Pointer to memory that contains local data.
unsigned int	data_size
	Size of memory needed to hold all data.
message_data_ts_t *	data_ts
	data timestamp aliasing pointer

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 ( )

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.

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

Destructor.

Definition at line 608 of file SwitchInterface.cpp.

References fawkes::Interface::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.

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:

src/libs/interfaces/SwitchInterface.h
src/libs/interfaces/SwitchInterface.cpp

Classes

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation