fawkes::FacerInterface::GetNameMessage Class Reference
GetNameMessage Fawkes BlackBoard Interface Message. More...
#include <interfaces/FacerInterface.h>
Classes | |
| struct | GetNameMessage_data_t |
| Internal data storage, do NOT modify! | |
Public Member Functions | |
| GetNameMessage (const uint32_t ini_index) | |
| Constructor with initial values. | |
| GetNameMessage () | |
| Constructor. | |
| ~GetNameMessage () | |
| Destructor. | |
| GetNameMessage (const GetNameMessage *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. | |
| virtual Message * | clone () const |
| Clone this message. | |
Detailed Description
GetNameMessage Fawkes BlackBoard Interface Message.
Definition at line 234 of file FacerInterface.h.
Constructor & Destructor Documentation
| fawkes::FacerInterface::GetNameMessage::GetNameMessage | ( | const uint32_t | ini_index | ) |
Constructor with initial values.
- Parameters:
-
ini_index initial value for index
Definition at line 1154 of file FacerInterface.cpp.
References fawkes::Message::add_fieldinfo(), fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, and fawkes::IFT_UINT32.
| fawkes::FacerInterface::GetNameMessage::GetNameMessage | ( | ) |
Constructor.
Definition at line 1165 of file FacerInterface.cpp.
References fawkes::Message::add_fieldinfo(), fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, and fawkes::IFT_UINT32.
Referenced by clone().
| fawkes::FacerInterface::GetNameMessage::~GetNameMessage | ( | ) |
Destructor.
Definition at line 1176 of file FacerInterface.cpp.
References fawkes::Message::data_ptr.
| fawkes::FacerInterface::GetNameMessage::GetNameMessage | ( | const GetNameMessage * | m | ) |
Copy constructor.
- Parameters:
-
m message to copy from
Definition at line 1184 of file FacerInterface.cpp.
References fawkes::Message::data_ptr, fawkes::Message::data_size, and fawkes::Message::data_ts.
Member Function Documentation
| Message * fawkes::FacerInterface::GetNameMessage::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 1230 of file FacerInterface.cpp.
References GetNameMessage().
| uint32_t fawkes::FacerInterface::GetNameMessage::index | ( | ) | const |
Get index value.
Index of the identity.
- Returns:
- index value
Definition at line 1199 of file FacerInterface.cpp.
| size_t fawkes::FacerInterface::GetNameMessage::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 1209 of file FacerInterface.cpp.
| void fawkes::FacerInterface::GetNameMessage::set_index | ( | const uint32_t | new_index | ) |
Set index value.
Index of the identity.
- Parameters:
-
new_index new index value
Definition at line 1219 of file FacerInterface.cpp.
The documentation for this class was generated from the following files:
- src/interfaces/FacerInterface.h
- src/interfaces/FacerInterface.cpp
