Fawkes API Fawkes Development Version

fawkes::FacerInterface::EnableIdentityMessage Class Reference

EnableIdentityMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::FacerInterface::EnableIdentityMessage:

List of all members.

Classes

struct  EnableIdentityMessage_data_t
 Internal data storage, do NOT modify!

Public Member Functions

 EnableIdentityMessage (const uint32_t ini_index, const bool ini_enable)
 Constructor with initial values.
 EnableIdentityMessage ()
 Constructor.
 ~EnableIdentityMessage ()
 Destructor.
 EnableIdentityMessage (const EnableIdentityMessage *m)
 Copy constructor.
uint32_t index () const
 Get index value.
void set_index (const uint32_t new_index)
 Set index value.
size_t maxlenof_index () const
 Get maximum length of index value.
bool is_enable () const
 Get enable value.
void set_enable (const bool new_enable)
 Set enable value.
size_t maxlenof_enable () const
 Get maximum length of enable value.
virtual Messageclone () const
 Clone this message.

Detailed Description


Constructor & Destructor Documentation

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

Constructor with initial values.

Parameters:
ini_indexinitial value for index
ini_enableinitial value for enable

Definition at line 907 of file FacerInterface.cpp.

References fawkes::Message::add_fieldinfo(), fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, fawkes::IFT_BOOL, and fawkes::IFT_UINT32.

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

Destructor.

Definition at line 932 of file FacerInterface.cpp.

References fawkes::Interface::data_ptr.

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

Copy constructor.

Parameters:
mmessage to copy from

Definition at line 940 of file FacerInterface.cpp.

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


Member Function Documentation

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 1016 of file FacerInterface.cpp.

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

Get index value.

Index of the identity.

Returns:
index value

Definition at line 955 of file FacerInterface.cpp.

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

Get enable value.

En-/disable flag.

Returns:
enable value

Definition at line 985 of file FacerInterface.cpp.

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 995 of file FacerInterface.cpp.

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 965 of file FacerInterface.cpp.

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

Set enable value.

En-/disable flag.

Parameters:
new_enablenew enable value

Definition at line 1005 of file FacerInterface.cpp.

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 975 of file FacerInterface.cpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends