neo::cca::ComponentID Class Reference

An opaque handle for a component. More...

#include <ComponentID.hh>

Public Member Functions
virtual	~ComponentID ()
	required destructor. More...
virtual ::std::string	getInstanceName ()=0 throw (Exception )
	return the name. More...
virtual ::std::string	getSerialization ()=0 throw (Exception )
	return a framework specific serialization. More...
virtual bool	isSameAs (ComponentID_shared cid)=0
	ComponentID identity may not be testable as a pointer comparison. More...

Detailed Description

An opaque handle for a component.

Noone in component-land should ever directly mention ComponentID. Use ComponentID_shared instead. Memory lifecycle: All ComponentID_shared are created by the framework and then shared liberally. All should be declared as local stack variables or stored in STL containers. NOTE classic transition: There is no toString function. Use getInstanceName() or getInstanceName().c_str() instead.

Constructor & Destructor Documentation

~ComponentID()

virtual neo::cca::ComponentID::~ComponentID ( )

inlinevirtual

required destructor.

{}

Member Function Documentation

getInstanceName()

virtual ::std::string neo::cca::ComponentID::getInstanceName ( ) throw ( Exception )

pure virtual

return the name.

getSerialization()

virtual ::std::string neo::cca::ComponentID::getSerialization ( ) throw ( Exception )

pure virtual

return a framework specific serialization.

isSameAs()

virtual bool neo::cca::ComponentID::isSameAs ( ComponentID_shared  cid )

pure virtual

ComponentID identity may not be testable as a pointer comparison.

All ids originate in the framework, however.

---

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

• ComponentID.hh