Fawkes API  Fawkes Development Version
fawkes::FacerInterface::EnableIdentityMessage Class Reference

EnableIdentityMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::FacerInterface::EnableIdentityMessage:

Public Member Functions

 EnableIdentityMessage (const uint32_t ini_index, const bool ini_enable)
 Constructor with initial values. More...
 
 EnableIdentityMessage ()
 Constructor. More...
 
 ~EnableIdentityMessage ()
 Destructor. More...
 
 EnableIdentityMessage (const EnableIdentityMessage *m)
 Copy constructor. More...
 
uint32_t index () const
 Get index value. More...
 
void set_index (const uint32_t new_index)
 Set index value. More...
 
size_t maxlenof_index () const
 Get maximum length of index value. More...
 
bool is_enable () const
 Get enable value. More...
 
void set_enable (const bool new_enable)
 Set enable value. More...
 
size_t maxlenof_enable () const
 Get maximum length of enable 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

◆ EnableIdentityMessage() [1/3]

fawkes::FacerInterface::EnableIdentityMessage::EnableIdentityMessage ( const uint32_t  ini_index,
const bool  ini_enable 
)

◆ EnableIdentityMessage() [2/3]

◆ ~EnableIdentityMessage()

fawkes::FacerInterface::EnableIdentityMessage::~EnableIdentityMessage ( )

Destructor.

Definition at line 1088 of file FacerInterface.cpp.

References fawkes::Message::data_ptr.

◆ EnableIdentityMessage() [3/3]

fawkes::FacerInterface::EnableIdentityMessage::EnableIdentityMessage ( const EnableIdentityMessage m)

Copy constructor.

Parameters
mmessage to copy from

Definition at line 1096 of file FacerInterface.cpp.

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

Member Function Documentation

◆ clone()

Message * fawkes::FacerInterface::EnableIdentityMessage::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 1172 of file FacerInterface.cpp.

◆ index()

uint32_t fawkes::FacerInterface::EnableIdentityMessage::index ( ) const

Get index value.

Index of the identity.

Returns
index value

Definition at line 1111 of file FacerInterface.cpp.

◆ is_enable()

bool fawkes::FacerInterface::EnableIdentityMessage::is_enable ( ) const

Get enable value.

En-/disable flag.

Returns
enable value

Definition at line 1141 of file FacerInterface.cpp.

◆ maxlenof_enable()

size_t fawkes::FacerInterface::EnableIdentityMessage::maxlenof_enable ( ) const

Get maximum length of enable value.

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

Definition at line 1151 of file FacerInterface.cpp.

◆ maxlenof_index()

size_t fawkes::FacerInterface::EnableIdentityMessage::maxlenof_index ( ) const

Get maximum length of index value.

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

Definition at line 1121 of file FacerInterface.cpp.

◆ set_enable()

void fawkes::FacerInterface::EnableIdentityMessage::set_enable ( const bool  new_enable)

Set enable value.

En-/disable flag.

Parameters
new_enablenew enable value

Definition at line 1161 of file FacerInterface.cpp.

◆ set_index()

void fawkes::FacerInterface::EnableIdentityMessage::set_index ( const uint32_t  new_index)

Set index value.

Index of the identity.

Parameters
new_indexnew index value

Definition at line 1131 of file FacerInterface.cpp.


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