rec::robotino::api2::ComId Class Reference

The id of a Com object. More...

#include <ComId.h>

Public Member Functions
	ComId ()
bool	operator== (const ComId &other) const
bool	operator!= (const ComId &other) const
bool	operator< (const ComId &other) const
bool	isNull () const
	operator bool () const

Static Public Member Functions
static const ComId	null ()

Friends
class	WorkerThread

Detailed Description

The id of a Com object.

The ComId is passed to Actor object to establish a relation ship to the Com object.

Constructor & Destructor Documentation

rec::robotino::api2::ComId::ComId ( )

inline

Contructs the first ComId object.

Exceptions

nothing

Member Function Documentation

bool rec::robotino::api2::ComId::isNull

(

)

const

Returns

true if the ComId is null.

static const ComId rec::robotino::api2::ComId::null ( )

static

Returns

The null ComId.

rec::robotino::api2::ComId::operator bool ( ) const

inline

Returns

true if the ComId is not null.

bool rec::robotino::api2::ComId::operator!= ( const ComId &  other ) const

inline

Compares two ComId instances.

Parameters

other

Other ComId instance.

Returns

true if the ComIds are unequal.

bool rec::robotino::api2::ComId::operator< ( const ComId &  other ) const

inline

Compares two ComId instances.

Parameters

other

Other ComId instance.

Returns

true if the other ComId is less than this ComId.

bool rec::robotino::api2::ComId::operator== ( const ComId &  other ) const

inline

Compares two ComId instances.

Parameters

other

Other ComId instance.

Returns

true if the ComIds are equal.

---

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

• C:/srcs/git/openrobotino/api2/lib/rec/robotino/api2/ComId.h