IDOMCatalog interface The IDOMCatalog serves as a catalog for addressable DOM nodes, where a DOM node ID is used as the address of the node. More...

#include <idomcatalog.h>

Inheritance diagram for IDOMCatalog:

[legend]

Public Member Functions
virtual DOMid	createNewDOMid (const EDLSysString &uri)=0
	Creates a new DOM id from a URI string. More...

virtual DOMid	createNewDOMid (uint32 id1, uint32 id2=0)=0
	Creates a new DOM id based on an integer identifier. More...

virtual bool	registerObject (DOMid id, const IEDLObjectPtr &ptrObject)=0
	Registers the IEDLObject specified by ptrObject in the catalog, under the ID specified by id. More...

virtual bool	registerNumbers (DOMid id, uint32 id1, uint32 id2)=0
	Registers the number pait in the catalog, under the ID specified by id. More...

virtual bool	unregisterObject (DOMid id)=0
	Unregisters the IEDLObject currently registered under the specified ID in the catalog. More...

virtual bool	getObject (DOMid id, IEDLObjectPtr &ptrObject)=0
	Retrieves an IEDLObject by using its DOM id. More...

virtual bool	getURI (DOMid id, EDLSysString &uri)=0
	Retrieves the URI of a registered object by using its DOM ID. More...

virtual DOMid	getIdByURI (const EDLSysString &uri, bool createIfNotExist=false)=0
	Retrieve the DOM ID of a registered resource by using its URI, optionally creating it. More...

virtual DOMid	getIdByNumbers (uint32 id1, uint32 id2=0, bool createIfNotExist=false)=0
	Retrieve the DOM ID of a registered resource by using the integer identifier(s) used to create the DOM ID, optionally creating it. More...

virtual DOMid	getIdByIndex (uint32 index) const =0
	Retrieve the DOM ID of a registered resource by its index in the internal vector. More...

virtual uint32	getCount () const =0
	Retrieve count of registered resource objects. More...

Public Member Functions inherited from IEDLObject
virtual const CClassID &	getClassID () const =0
	Returns class ID of IEDLObject. More...

virtual bool	init (CClassParams *pData)
	The init() method is called to perform any post-construction initialization of an IEDLObject that has been created by the EDL class factory, before it is actually returned by the factory. More...

virtual bool	clone (IEDLObjectPtr &ptrObject, IEDLClassFactory *pFactory)
	Create a copy of EDLObject. More...

Public Member Functions inherited from IRCObject
virtual void	addRef () const =0
	Increases the reference count of the actual object pointed to. This would take place during an assignment or copying.

virtual bool	decRef () const =0
	Decreases the reference count of the actual object pointed to. When the reference count falls to Zero, it deletes the actual object pointed to. More...

virtual int32	getRefCount () const =0
	Retrieve the current reference count of the actual object pointed to. More...

Static Public Member Functions
static const CClassID &	classID ()
	Retrieves the class id of IDOMCatalog. More...

Additional Inherited Members
Protected Member Functions inherited from IRCObject
virtual	~IRCObject ()
	Virtual destructor.

Detailed Description

IDOMCatalog interface The IDOMCatalog serves as a catalog for addressable DOM nodes, where a DOM node ID is used as the address of the node.

Member Function Documentation

◆ classID()

static const CClassID& IDOMCatalog::classID ( )

inlinestatic

Retrieves the class id of IDOMCatalog.

Returns: CClassID Class id of the catalog.

◆ createNewDOMid() [1/2]

virtual DOMid IDOMCatalog::createNewDOMid ( const EDLSysString & uri )

pure virtual

Creates a new DOM id from a URI string.

Parameters

uri	A string uniquely addressing a resource.

Returns: DOMid. The newly created DOM id. The newly allocated ID will be unique across the the current process.

◆ createNewDOMid() [2/2]

virtual DOMid IDOMCatalog::createNewDOMid	(	uint32	id1,
		uint32	id2 = `0`
	)

pure virtual

Creates a new DOM id based on an integer identifier.

Parameters

id1	A numeric identifier.
id2	A second numeric identifier (optional. Presently not used, and set to zero.)

Returns: DOMid. The newly created DOM id. The newly allocated ID will be unique across the the current process.

◆ getCount()

virtual uint32 IDOMCatalog::getCount ( ) const

pure virtual

Retrieve count of registered resource objects.

Returns: uint32 Returns the count of catalog entries.

◆ getIdByIndex()

virtual DOMid IDOMCatalog::getIdByIndex ( uint32 index ) const

pure virtual

Retrieve the DOM ID of a registered resource by its index in the internal vector.

Parameters

index The registered resource index

Returns: DOMid Returns the DOM ID of the resource.

◆ getIdByNumbers()

virtual DOMid IDOMCatalog::getIdByNumbers	(	uint32	id1,
		uint32	id2 = `0`,
		bool	createIfNotExist = `false`
	)

pure virtual

Retrieve the DOM ID of a registered resource by using the integer identifier(s) used to create the DOM ID, optionally creating it.

Parameters

id1	A numeric identifier.
id2	A second numeric identifier (optional. Presently not used, and set to zero.)
createIfNotExist	If set to true, create a new DOM ID if it doesn't already exist

Returns: DOMid The DOM id of the identified resource. If a new id has been created it will be unique across the process.

◆ getIdByURI()

virtual DOMid IDOMCatalog::getIdByURI	(	const EDLSysString &	uri,
		bool	createIfNotExist = `false`
	)

pure virtual

Retrieve the DOM ID of a registered resource by using its URI, optionally creating it.

Parameters

uri	URI of the resource whose DOM ID is required.
createIfNotExist	If set to true, create a new DOM ID if it doesn't already exist

Returns: DOMid The DOM ID of the resource.

◆ getObject()

virtual bool IDOMCatalog::getObject	(	DOMid	id,
		IEDLObjectPtr &	ptrObject
	)

pure virtual

Retrieves an IEDLObject by using its DOM id.

Parameters

id	The DOM ID of the IEDLObject to retrieve.
ptrObject	A Smart pointer to receive a reference to the retrieved IEDLObject.

Returns: bool True on success, false if the call fails.

◆ getURI()

virtual bool IDOMCatalog::getURI	(	DOMid	id,
		EDLSysString &	uri
	)

pure virtual

Retrieves the URI of a registered object by using its DOM ID.

Parameters

id	DOM ID of the resource
uri	Pointer to receive the URI for the resource

Returns: bool True on success, false if the call fails.

◆ registerNumbers()

virtual bool IDOMCatalog::registerNumbers	(	DOMid	id,
		uint32	id1,
		uint32	id2
	)

pure virtual

Registers the number pait in the catalog, under the ID specified by id.

Parameters

id	The ID to register the object under.
id1	A numeric identifier.
id2	A second numeric identifier.

Returns: bool True on success, false if the call fails.

◆ registerObject()

virtual bool IDOMCatalog::registerObject	(	DOMid	id,
		const IEDLObjectPtr &	ptrObject
	)

pure virtual

Registers the IEDLObject specified by ptrObject in the catalog, under the ID specified by id.

Parameters

id	The ID to register the object under.
ptrObject	A smart pointer to the IEDLObject to register.

Returns: bool True on success, false if the call fails.

◆ unregisterObject()

virtual bool IDOMCatalog::unregisterObject ( DOMid id )

pure virtual

Unregisters the IEDLObject currently registered under the specified ID in the catalog.

Parameters

id	The DOM id of the object to unregister.

Returns: bool True on success, false if the call fails.

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

idomcatalog.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ classID()

◆ createNewDOMid() [1/2]

◆ createNewDOMid() [2/2]

◆ getCount()

◆ getIdByIndex()

◆ getIdByNumbers()

◆ getIdByURI()

◆ getObject()

◆ getURI()

◆ registerNumbers()

◆ registerObject()

◆ unregisterObject()