Fawkes API Fawkes Development Version
|
#include <>>
Public Member Functions | |
InterfaceInfo (const char *type, const char *id, const unsigned char *hash, unsigned int serial, bool has_writer, unsigned int num_readers, const std::list< std::string > &readers, const std::string &writer, const Time *timestamp) | |
Constructor. More... | |
InterfaceInfo (const InterfaceInfo &i) | |
Copy constructor. More... | |
~InterfaceInfo () | |
Destructor. More... | |
const char * | type () const |
Get interface type. More... | |
const char * | id () const |
Get interface ID. More... | |
const unsigned char * | hash () const |
Get interface version hash. More... | |
std::string | hash_printable () const |
Get interface version hash in printable format. More... | |
bool | has_writer () const |
Check if there is a writer. More... | |
unsigned int | num_readers () const |
Get number of readers. More... | |
const std::list< std::string > & | readers () const |
Get readers of interface. More... | |
const std::string & | writer () const |
Get name of writer on interface. More... | |
unsigned int | serial () const |
Get interface instance serial. More... | |
const Time * | timestamp () const |
Get interface timestamp. More... | |
InterfaceInfo & | operator= (const InterfaceInfo &i) |
Assignment operator. More... | |
bool | operator< (const InterfaceInfo &ii) const |
< operator This compares two interface infos with respect to the less than (<) relation considering the type and id of an interface. More... | |
Interface info.
This class holds information about a specific interface.
Definition at line 34 of file interface_info.h.
InterfaceInfo::InterfaceInfo | ( | const char * | type, |
const char * | id, | ||
const unsigned char * | hash, | ||
unsigned int | serial, | ||
bool | has_writer, | ||
unsigned int | num_readers, | ||
const std::list< std::string > & | readers, | ||
const std::string & | writer, | ||
const Time * | timestamp | ||
) |
Constructor.
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 |
readers | name of readers of interface |
writer | name of writer of interface |
timestamp | interface timestamp (time of last write or data timestamp) |
Definition at line 52 of file interface_info.cpp.
References has_writer(), hash(), num_readers(), readers(), serial(), timestamp(), type(), and writer().
InterfaceInfo::InterfaceInfo | ( | const InterfaceInfo & | i | ) |
InterfaceInfo::~InterfaceInfo | ( | ) |
Destructor.
Definition at line 92 of file interface_info.cpp.
bool InterfaceInfo::has_writer | ( | ) | const |
Check if there is a writer.
Definition at line 171 of file interface_info.cpp.
Referenced by fawkes::BlackBoardInterfaceListContent::append_interface(), fawkes::InterfaceChooserDialog::init_row(), and InterfaceInfo().
const unsigned char * InterfaceInfo::hash | ( | ) | const |
Get interface version hash.
Definition at line 148 of file interface_info.cpp.
Referenced by fawkes::BlackBoardInterfaceListContent::append_interface(), and InterfaceInfo().
std::string InterfaceInfo::hash_printable | ( | ) | const |
Get interface version hash in printable format.
Definition at line 157 of file interface_info.cpp.
const char * InterfaceInfo::id | ( | ) | const |
Get interface ID.
Definition at line 139 of file interface_info.cpp.
Referenced by fawkes::BlackBoardInterfaceListContent::append_interface(), fawkes::InterfaceChooserDialog::init_row(), and fawkes::MultiInterfaceChooserDialog::init_row().
unsigned int InterfaceInfo::num_readers | ( | ) | const |
Get number of readers.
Definition at line 180 of file interface_info.cpp.
Referenced by fawkes::BlackBoardInterfaceListContent::append_interface(), fawkes::InterfaceChooserDialog::init_row(), and InterfaceInfo().
bool InterfaceInfo::operator< | ( | const InterfaceInfo & | ii | ) | const |
< operator This compares two interface infos with respect to the less than (<) relation considering the type and id of an interface.
An interface info A is less than an interface info B (A < B) iff (A.type < B.type) or ((A.type == B.type) && A.id < B.id).
ii | interface info to compare this to |
ii
, false otherwise Definition at line 229 of file interface_info.cpp.
InterfaceInfo & InterfaceInfo::operator= | ( | const InterfaceInfo & | i | ) |
Assignment operator.
i | info to copy from |
Definition at line 105 of file interface_info.cpp.
const std::list< std::string > & InterfaceInfo::readers | ( | ) | const |
Get readers of interface.
Definition at line 189 of file interface_info.cpp.
Referenced by InterfaceInfo().
unsigned int InterfaceInfo::serial | ( | ) | const |
Get interface instance serial.
Definition at line 207 of file interface_info.cpp.
Referenced by fawkes::BlackBoardInterfaceListContent::append_interface(), and InterfaceInfo().
const Time * InterfaceInfo::timestamp | ( | ) | const |
Get interface timestamp.
Definition at line 216 of file interface_info.cpp.
Referenced by fawkes::BlackBoardInterfaceListContent::append_interface(), and InterfaceInfo().
const char * InterfaceInfo::type | ( | ) | const |
Get interface type.
Definition at line 130 of file interface_info.cpp.
Referenced by fawkes::BlackBoardInterfaceListContent::append_interface(), fawkes::InterfaceChooserDialog::init_row(), fawkes::MultiInterfaceChooserDialog::init_row(), InterfaceInfo(), BlackBoardSynchronizationThread::writer_added(), and BlackBoardSynchronizationThread::writer_removed().
const std::string & InterfaceInfo::writer | ( | ) | const |
Get name of writer on interface.
Definition at line 198 of file interface_info.cpp.
Referenced by InterfaceInfo(), BlackBoardSynchronizationThread::writer_added(), and BlackBoardSynchronizationThread::writer_removed().