fawkes::InterfaceInfo Class Reference
Interface info. More...
#include <interface/interface_info.h>
Public Member Functions | |
| InterfaceInfo (const char *type, const char *id, const unsigned char *hash, unsigned int serial, bool has_writer, unsigned int num_readers) | |
| Constructor. | |
| InterfaceInfo (const InterfaceInfo &i) | |
| Copy constructor. | |
| ~InterfaceInfo () | |
| Destructor. | |
| const char * | type () const |
| Get interface type. | |
| const char * | id () const |
| Get interface ID. | |
| const unsigned char * | hash () const |
| Get interface version hash. | |
| bool | has_writer () const |
| Check if there is a writer. | |
| unsigned int | num_readers () const |
| Get number of readers. | |
| unsigned int | serial () const |
| Get interface instance serial. | |
Detailed Description
Interface info.This class holds information about a specific interface.
Definition at line 31 of file interface_info.h.
Constructor & Destructor Documentation
| fawkes::InterfaceInfo::InterfaceInfo | ( | const char * | type, | |
| const char * | id, | |||
| const unsigned char * | hash, | |||
| unsigned int | serial, | |||
| bool | has_writer, | |||
| unsigned int | num_readers | |||
| ) |
Constructor.
- Parameters:
-
type type of the interface id id of the interface hash version hash has_writer true if there is a writer, false otherwise num_readers number of readers serial instance serial
Definition at line 49 of file interface_info.cpp.
| fawkes::InterfaceInfo::InterfaceInfo | ( | const InterfaceInfo & | i | ) |
| fawkes::InterfaceInfo::~InterfaceInfo | ( | ) |
Member Function Documentation
| bool fawkes::InterfaceInfo::has_writer | ( | ) | const |
Check if there is a writer.
- Returns:
- true if there is a writer, false otherwise
Definition at line 120 of file interface_info.cpp.
Referenced by fawkes::BlackBoardInterfaceListContent::append_interface().
| const unsigned char * fawkes::InterfaceInfo::hash | ( | ) | const |
Get interface version hash.
- Returns:
- interface version hash
Definition at line 110 of file interface_info.cpp.
Referenced by fawkes::BlackBoardInterfaceListContent::append_interface().
| const char * fawkes::InterfaceInfo::id | ( | ) | const |
Get interface ID.
- Returns:
- ID string
Definition at line 100 of file interface_info.cpp.
Referenced by fawkes::BlackBoardInterfaceListContent::append_interface().
| unsigned int fawkes::InterfaceInfo::num_readers | ( | ) | const |
Get number of readers.
- Returns:
- number of readers
Definition at line 130 of file interface_info.cpp.
Referenced by fawkes::BlackBoardInterfaceListContent::append_interface().
| unsigned int fawkes::InterfaceInfo::serial | ( | ) | const |
Get interface instance serial.
- Returns:
- type string
Definition at line 140 of file interface_info.cpp.
Referenced by fawkes::BlackBoardInterfaceListContent::append_interface().
| const char * fawkes::InterfaceInfo::type | ( | ) | const |
Get interface type.
- Returns:
- type string
Definition at line 90 of file interface_info.cpp.
Referenced by fawkes::BlackBoardInterfaceListContent::append_interface().
The documentation for this class was generated from the following files:
- src/libs/interface/interface_info.h
- src/libs/interface/interface_info.cpp

