Fawkes API  Fawkes Development Version
fawkes::CameraControlInterface::SetEffectMessage Class Reference

SetEffectMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::CameraControlInterface::SetEffectMessage:

Public Member Functions

 SetEffectMessage (const Effect ini_effect)
 Constructor with initial values. More...
 
 SetEffectMessage ()
 Constructor. More...
 
 ~SetEffectMessage ()
 Destructor. More...
 
 SetEffectMessage (const SetEffectMessage *m)
 Copy constructor. More...
 
Effect effect () const
 Get effect value. More...
 
void set_effect (const Effect new_effect)
 Set effect value. More...
 
size_t maxlenof_effect () const
 Get maximum length of effect 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

◆ SetEffectMessage() [1/3]

◆ SetEffectMessage() [2/3]

◆ ~SetEffectMessage()

fawkes::CameraControlInterface::SetEffectMessage::~SetEffectMessage ( )

Destructor.

Definition at line 425 of file CameraControlInterface.cpp.

References fawkes::Message::data_ptr.

◆ SetEffectMessage() [3/3]

fawkes::CameraControlInterface::SetEffectMessage::SetEffectMessage ( const SetEffectMessage m)

Copy constructor.

Parameters
mmessage to copy from

Definition at line 433 of file CameraControlInterface.cpp.

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

Member Function Documentation

◆ clone()

Message * fawkes::CameraControlInterface::SetEffectMessage::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 479 of file CameraControlInterface.cpp.

◆ effect()

CameraControlInterface::Effect fawkes::CameraControlInterface::SetEffectMessage::effect ( ) const

Get effect value.

Currently active effect.

Returns
effect value

Definition at line 448 of file CameraControlInterface.cpp.

Referenced by PanTiltSonyEviD100PThread::loop().

◆ maxlenof_effect()

size_t fawkes::CameraControlInterface::SetEffectMessage::maxlenof_effect ( ) const

Get maximum length of effect value.

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

Definition at line 458 of file CameraControlInterface.cpp.

◆ set_effect()

void fawkes::CameraControlInterface::SetEffectMessage::set_effect ( const Effect  new_effect)

Set effect value.

Currently active effect.

Parameters
new_effectnew effect value

Definition at line 468 of file CameraControlInterface.cpp.

Referenced by WebviewPtzCamRequestProcessor::process_request().


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