Fawkes API  Fawkes Development Version
fawkes::InterfaceInfo Class Reference

Interface info. More...

#include <>>

List of all members.

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

Detailed Description

Interface info.

This class holds information about a specific interface.

Author:
Tim Niemueller

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:
typetype of the interface
idid of the interface
hashversion hash
has_writertrue if there is a writer, false otherwise
num_readersnumber of readers
serialinstance serial

Definition at line 46 of file interface_info.cpp.

References has_writer(), num_readers(), and serial().

fawkes::InterfaceInfo::InterfaceInfo ( const InterfaceInfo i)

Copy constructor.

Parameters:
iinfo to copy

Definition at line 62 of file interface_info.cpp.

fawkes::InterfaceInfo::~InterfaceInfo ( )

Destructor.

Definition at line 75 of file interface_info.cpp.


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 117 of file interface_info.cpp.

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

const unsigned char * fawkes::InterfaceInfo::hash ( ) const

Get interface version hash.

Returns:
interface version hash

Definition at line 107 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 97 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 127 of file interface_info.cpp.

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

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:
iiinterface info to compare this to
Returns:
true if this instance is considered less than ii, false otherwise

Definition at line 152 of file interface_info.cpp.

unsigned int fawkes::InterfaceInfo::serial ( ) const

Get interface instance serial.

Returns:
type string

Definition at line 137 of file interface_info.cpp.

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

const char * fawkes::InterfaceInfo::type ( ) const

Get interface type.

Returns:
type string

Definition at line 87 of file interface_info.cpp.

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


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