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

SetNameMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::FacerInterface::SetNameMessage:

List of all members.

Classes

struct  SetNameMessage_data_t
 Internal data storage, do NOT modify! More...

Public Member Functions

 SetNameMessage (const uint32_t ini_index, const char *ini_name)
 Constructor with initial values.
 SetNameMessage ()
 Constructor.
 ~SetNameMessage ()
 Destructor.
 SetNameMessage (const SetNameMessage *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.
char * name () const
 Get name value.
void set_name (const char *new_name)
 Set name value.
size_t maxlenof_name () const
 Get maximum length of name value.
virtual Messageclone () const
 Clone this message.

Detailed Description


Constructor & Destructor Documentation

fawkes::FacerInterface::SetNameMessage::SetNameMessage ( const uint32_t  ini_index,
const char *  ini_name 
)
fawkes::FacerInterface::SetNameMessage::~SetNameMessage ( )

Destructor.

Definition at line 1056 of file FacerInterface.cpp.

References fawkes::Interface::data_ptr.

fawkes::FacerInterface::SetNameMessage::SetNameMessage ( const SetNameMessage m)

Copy constructor.

Parameters:
mmessage to copy from

Definition at line 1064 of file FacerInterface.cpp.

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


Member Function Documentation

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

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

Get index value.

Index of the identity.

Returns:
index value

Definition at line 1079 of file FacerInterface.cpp.

size_t fawkes::FacerInterface::SetNameMessage::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 1089 of file FacerInterface.cpp.

size_t fawkes::FacerInterface::SetNameMessage::maxlenof_name ( ) const

Get maximum length of name value.

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

Definition at line 1119 of file FacerInterface.cpp.

char * fawkes::FacerInterface::SetNameMessage::name ( ) const

Get name value.

Name of the identity.

Returns:
name value

Definition at line 1109 of file FacerInterface.cpp.

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

Set index value.

Index of the identity.

Parameters:
new_indexnew index value

Definition at line 1099 of file FacerInterface.cpp.

void fawkes::FacerInterface::SetNameMessage::set_name ( const char *  new_name)

Set name value.

Name of the identity.

Parameters:
new_namenew name value

Definition at line 1129 of file FacerInterface.cpp.


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