fawkes::InterfaceInfo Class Reference

Interface info. More...

#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...
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...

Detailed Description

Interface info.

This class holds information about a specific interface.

Author

Tim Niemueller

Definition at line 34 of file interface_info.h.

Constructor & Destructor Documentation

InterfaceInfo() [1/2]

fawkes::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.

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
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(), num_readers(), readers(), serial(), and writer().

Referenced by fawkes::InterfaceInfoList::append().

InterfaceInfo() [2/2]

fawkes::InterfaceInfo::InterfaceInfo

(

const InterfaceInfo &

i

)

Copy constructor.

Parameters

i	info to copy

Definition at line 73 of file interface_info.cpp.

~InterfaceInfo()

fawkes::InterfaceInfo::~InterfaceInfo

(

)

Destructor.

Definition at line 89 of file interface_info.cpp.

Member Function Documentation

has_writer()

bool fawkes::InterfaceInfo::has_writer

(

)

const

Check if there is a writer.

Returns

true if there is a writer, false otherwise

Definition at line 146 of file interface_info.cpp.

Referenced by fawkes::BlackBoardInterfaceListContent::append_interface(), fawkes::InterfaceChooserDialog::init_row(), and InterfaceInfo().

hash()

const unsigned char * fawkes::InterfaceInfo::hash

(

)

const

Get interface version hash.

Returns

interface version hash

Definition at line 122 of file interface_info.cpp.

Referenced by fawkes::BlackBoardInterfaceListContent::append_interface().

hash_printable()

std::string fawkes::InterfaceInfo::hash_printable

(

)

const

Get interface version hash in printable format.

Returns

interface version hash printable string

Definition at line 131 of file interface_info.cpp.

id()

const char * fawkes::InterfaceInfo::id

(

)

const

Get interface ID.

Returns

ID string

Definition at line 112 of file interface_info.cpp.

Referenced by fawkes::BlackBoardInterfaceListContent::append_interface(), fawkes::MultiInterfaceChooserDialog::init_row(), and fawkes::InterfaceChooserDialog::init_row().

num_readers()

unsigned int fawkes::InterfaceInfo::num_readers

(

)

const

Get number of readers.

Returns

number of readers

Definition at line 156 of file interface_info.cpp.

Referenced by fawkes::BlackBoardInterfaceListContent::append_interface(), fawkes::InterfaceChooserDialog::init_row(), and InterfaceInfo().

operator<()

bool fawkes::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).

Parameters

ii	interface info to compare this to

Returns

true if this instance is considered less than ii, false otherwise

Definition at line 210 of file interface_info.cpp.

readers()

const std::list< std::string > & fawkes::InterfaceInfo::readers

(

)

const

Get readers of interface.

Returns

string of names of readers of this interface

Definition at line 166 of file interface_info.cpp.

Referenced by InterfaceInfo().

serial()

unsigned int fawkes::InterfaceInfo::serial

(

)

const

Get interface instance serial.

Returns

type string

Definition at line 186 of file interface_info.cpp.

Referenced by fawkes::BlackBoardInterfaceListContent::append_interface(), and InterfaceInfo().

timestamp()

const Time * fawkes::InterfaceInfo::timestamp

(

)

const

Get interface timestamp.

Returns

point to interface last update time

Definition at line 196 of file interface_info.cpp.

Referenced by fawkes::BlackBoardInterfaceListContent::append_interface().

type()

const char * fawkes::InterfaceInfo::type

(

)

const

Get interface type.

Returns

type string

Definition at line 102 of file interface_info.cpp.

Referenced by fawkes::BlackBoardInterfaceListContent::append_interface(), fawkes::MultiInterfaceChooserDialog::init_row(), and fawkes::InterfaceChooserDialog::init_row().

writer()

const std::string & fawkes::InterfaceInfo::writer

(

)

const

Get name of writer on interface.

Returns

name of writer owner or empty string of no writer or unknown

Definition at line 176 of file interface_info.cpp.

Referenced by InterfaceInfo().

---

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

• src/libs/interface/interface_info.h
• src/libs/interface/interface_info.cpp