fawkes::FacerInterface::EnableIdentityMessage Class Reference

EnableIdentityMessage Fawkes BlackBoard Interface Message. More...

#include <interfaces/FacerInterface.h>

Inheritance diagram for fawkes::FacerInterface::EnableIdentityMessage:

Inheritance graph
[legend]

List of all members.


Classes

struct  EnableIdentityMessage_data_t
 Internal data storage, do NOT modify!

Public Member Functions

 EnableIdentityMessage (const unsigned int ini_index, const bool ini_enable)
 Constructor with initial values.
 EnableIdentityMessage ()
 Constructor.
 ~EnableIdentityMessage ()
 Destructor.
 EnableIdentityMessage (const EnableIdentityMessage *m)
 Copy constructor.
unsigned int index () const
 Get index value.
void set_index (const unsigned int 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 Message * clone () const
 Clone this message.

Detailed Description

EnableIdentityMessage Fawkes BlackBoard Interface Message.

Definition at line 159 of file FacerInterface.h.

Constructor & Destructor Documentation

fawkes::FacerInterface::EnableIdentityMessage::EnableIdentityMessage ( const unsigned int  ini_index,
const bool  ini_enable 
)

Constructor with initial values.

Parameters:
ini_index initial value for index
ini_enable initial value for enable

Definition at line 857 of file FacerInterface.cpp.

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

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

Constructor.

Definition at line 869 of file FacerInterface.cpp.

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

Referenced by clone().

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

Destructor.

Definition at line 880 of file FacerInterface.cpp.

References fawkes::Message::data_ptr.

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

Copy constructor.

Parameters:
m message to copy from

Definition at line 888 of file FacerInterface.cpp.

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

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

References EnableIdentityMessage().

unsigned int fawkes::FacerInterface::EnableIdentityMessage::index (  )  const

Get index value.

Index of the identity.

Returns:
index value

Definition at line 902 of file FacerInterface.cpp.

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

Get enable value.

En-/disable flag.

Returns:
enable value

Definition at line 932 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 942 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 912 of file FacerInterface.cpp.

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

Set enable value.

En-/disable flag.

Parameters:
new_enable new enable value

Definition at line 952 of file FacerInterface.cpp.

void fawkes::FacerInterface::EnableIdentityMessage::set_index ( const unsigned int  new_index  ) 

Set index value.

Index of the identity.

Parameters:
new_index new index value

Definition at line 922 of file FacerInterface.cpp.

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