This class is a common base to all objects with a name. More...

#include <NamedObject.hxx>

Inheritance diagram for dueca::NamedObject:

[legend]

Public Member Functions
const std::string	getEntity () const
	Returns the "entity" part of the name.

const std::string	getClass () const
	Returns the "class" part of the name.

const std::string	getPart () const
	Returns the sub-entity or "part" part of the name.

const NameSet &	getNameSet () const
	This returns the complete name set.

const GlobalId &	getId () const
	This returns the id.

virtual ObjectType	getObjectType () const =0
	This has to be re-implemented in a derived class, used to get an idea of what the derived class does.

Protected Member Functions
	NamedObject (const GlobalId &id)
	Reserve for AssociateObject.

	NamedObject (const NameSet &ns)
	Normal constructor, protected, because it has no use to create a NamedObject by itself.

virtual	~NamedObject ()
	Destructor.

Friends
class	ObjectManager
	An ObjectManager may initialise its name later.

class	ScriptInterpret
	And also the ScriptInterpret object may do this.

Detailed Description

This class is a common base to all objects with a name.

These objects will be locatable by the CSE registry.

The name consists of a tuple (entity, cclass, part)

entity is the simulated entity, e.g. "PH-LAB"
cclass is the model class of the channel or component, e.g. "engine signals"
part is the part within the entity, e.g. "engine 1"

The NamedObject class links the name tuple to an object id. The object id consists of another tuple (location, object).

location is the DUECA node where an object is located.
object is an id of the object itself.

Note that the entity, class, part tuple is stored, upon creation, in the registry. The methods that query this tuple use the registry, in combination with my_id, to return the answer.

The registry will provide methods to obtain the object id from the (entity, class, part) tuple and vice versa.

Constructor & Destructor Documentation

◆ NamedObject()

dueca::NamedObject::NamedObject ( const GlobalId & id )

protected

Reserve for AssociateObject.

Only for AssociateObject descendant

Member Function Documentation

◆ getId()

const GlobalId & dueca::NamedObject::getId ( ) const

This returns the id.

Normally this is used by a derived class, because the id has to be supplied to obtain various services, such as channel access and activation

◆ getObjectType()

virtual ObjectType dueca::NamedObject::getObjectType ( ) const

pure virtual

This has to be re-implemented in a derived class, used to get an idea of what the derived class does.

Implemented in dueca::EasyId, dueca::Module, dueca::ScriptInterpret, and dueca::Ticker.

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

/home/abuild/rpmbuild/BUILD/dueca-4.1.1/dueca/NamedObject.hxx

Public Member Functions