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

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

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]

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

◆ InterfaceInfo() [2/2]

InterfaceInfo::InterfaceInfo ( const InterfaceInfo & i )

Copy constructor.

Parameters

i	info to copy

Definition at line 77 of file interface_info.cpp.

◆ ~InterfaceInfo()

InterfaceInfo::~InterfaceInfo ( )

Destructor.

Definition at line 92 of file interface_info.cpp.

Member Function Documentation

◆ has_writer()

bool InterfaceInfo::has_writer ( ) const

Check if there is a writer.

Returns: true if there is a writer, false otherwise

Definition at line 171 of file interface_info.cpp.

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

◆ hash()

const unsigned char * InterfaceInfo::hash ( ) const

Get interface version hash.

Returns: interface version hash

Definition at line 148 of file interface_info.cpp.

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

◆ hash_printable()

std::string InterfaceInfo::hash_printable ( ) const

Get interface version hash in printable format.

Returns: interface version hash printable string

Definition at line 157 of file interface_info.cpp.

◆ id()

const char * InterfaceInfo::id ( ) const

Get interface ID.

Returns: ID string

Definition at line 139 of file interface_info.cpp.

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

◆ num_readers()

unsigned int InterfaceInfo::num_readers ( ) const

Get number of readers.

Returns: number of readers

Definition at line 180 of file interface_info.cpp.

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

◆ operator<()

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

Parameters

ii	interface info to compare this to

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

Definition at line 229 of file interface_info.cpp.

◆ operator=()

InterfaceInfo & InterfaceInfo::operator= ( const InterfaceInfo & i )

Assignment operator.

Parameters

i	info to copy from

Returns: reference to this instance

Definition at line 105 of file interface_info.cpp.

◆ readers()

const std::list< std::string > & InterfaceInfo::readers ( ) const

Get readers of interface.

Returns: string of names of readers of this interface

Definition at line 189 of file interface_info.cpp.

Referenced by InterfaceInfo().

◆ serial()

unsigned int InterfaceInfo::serial ( ) const

Get interface instance serial.

Returns: type string

Definition at line 207 of file interface_info.cpp.

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

◆ timestamp()

const Time * InterfaceInfo::timestamp ( ) const

Get interface timestamp.

Returns: point to interface last update time

Definition at line 216 of file interface_info.cpp.

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

◆ type()

const char * InterfaceInfo::type ( ) const

Get interface type.

Returns: type string

Definition at line 130 of file interface_info.cpp.

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

◆ writer()

const std::string & 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 198 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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ InterfaceInfo() [1/2]

◆ InterfaceInfo() [2/2]

◆ ~InterfaceInfo()

Member Function Documentation

◆ has_writer()

◆ hash()

◆ hash_printable()

◆ id()

◆ num_readers()

◆ operator<()

◆ operator=()

◆ readers()

◆ serial()

◆ timestamp()

◆ type()

◆ writer()