#include <GaudiKernel/IDataProviderSvc.h>

Inheritance diagram for IDataProviderSvc:

[legend]

Collaboration diagram for IDataProviderSvc:

Public Types
enum	{ SEPARATOR = '/' }

enum	Status : StatusCode::code_t { Status::IDataProviderSvc_NO_ERROR = 1, Status::DOUBL_OBJ_PATH, Status::INVALID_OBJ_PATH, Status::INVALID_ROOT, Status::INVALID_OBJECT, Status::INVALID_PARENT, Status::OBJ_NOT_LOADED, Status::NO_DATA_LOADER, Status::INVALID_OBJ_ADDR, Status::DIR_NOT_EMPTY, Status::NO_MORE_LEVELS, Status::NO_ACCESS, Status::LAST }
	Status code definitions. More...

Public Types inherited from IInterface
enum	Status : StatusCode::code_t { Status::FAILURE = 0, Status::SUCCESS = 1, Status::NO_INTERFACE, Status::VERSMISMATCH, Status::LAST_ERROR }
	Return status. More...

using	iid = Gaudi::InterfaceId< IInterface, 0, 0 >
	Interface ID. More...

using	ext_iids = Gaudi::interface_list< iid >
	Extra interfaces. More...

Public Member Functions
	DeclareInterfaceID (IDataProviderSvc, 4, 0)
	InterfaceID. More...

StatusCode	registerObject (std::string_view fullPath, DataObject *pObject)
	Register object with the data store. More...

virtual StatusCode	registerObject (std::string_view parentPath, std::string_view objectPath, DataObject *pObject)=0
	Register object with the data store. More...

StatusCode	registerObject (std::string_view parentPath, int item, DataObject *pObject)
	Register object with the data store. More...

virtual StatusCode	registerObject (DataObject parentObj, std::string_view objectPath, DataObject pObject)=0
	Register object with the data store. More...

StatusCode	registerObject (DataObject parentObj, int item, DataObject pObject)
	Register object with the data store. More...

virtual StatusCode	unregisterObject (std::string_view fullPath)=0
	Unregister object from the data store. More...

StatusCode	unregisterObject (std::string_view parentPath, std::string_view objPath)
	Unregister object from the data store. More...

StatusCode	unregisterObject (std::string_view parentPath, int item)
	Unregister object from the data store. More...

virtual StatusCode	unregisterObject (DataObject *pObject)=0
	Unregister object from the data store. More...

virtual StatusCode	unregisterObject (DataObject *pParent, std::string_view objPath)=0
	Unregister object from the data store. More...

StatusCode	unregisterObject (DataObject *pParent, int item)
	Unregister object from the data store. More...

virtual StatusCode	retrieveObject (IRegistry pDirectory, std::string_view path, DataObject &pObject)=0
	Retrieve object identified by its directory entry. More...

StatusCode	retrieveObject (std::string_view fullPath, DataObject *&pObject)
	Retrieve object identified by its full path from the data store. More...

StatusCode	retrieveObject (std::string_view parentPath, std::string_view objectPath, DataObject *&pObject)
	Retrieve object from data store. More...

StatusCode	retrieveObject (std::string_view parentPath, int item, DataObject *&pObject)
	Retrieve object from data store. More...

StatusCode	retrieveObject (DataObject parentObj, std::string_view objectPath, DataObject &pObject)
	Retrieve object from data store. More...

StatusCode	retrieveObject (DataObject parentObj, int item, DataObject &pObject)
	Retrieve object from data store. More...

virtual StatusCode	findObject (IRegistry pDirectory, std::string_view path, DataObject &pObject)=0
	Find object identified by its directory entry. More...

virtual StatusCode	findObject (std::string_view fullPath, DataObject *&pObject)=0
	Find object identified by its full path in the data store. More...

StatusCode	findObject (std::string_view parentPath, std::string_view objectPath, DataObject *&pObject)
	Find object identified by its parent object and the path to the object relative to the parent. More...

StatusCode	findObject (std::string_view parentPath, int item, DataObject *&pObject)
	Find object identified by its parent object and an integer identifier in the data store. More...

StatusCode	findObject (DataObject parentObj, std::string_view objectPath, DataObject &pObject)
	Find object identified by its parent object and the path to the object relative to the parent. More...

StatusCode	findObject (DataObject parentObj, int item, DataObject &pObject)
	Find object identified by its parent object and an integer identifier in the data store. More...

virtual StatusCode	updateObject (IRegistry *pDirectory)=0
	Update object identified by its directory entry. More...

StatusCode	updateObject (std::string_view fullPath)
	Update object identified by its full path in the data store. More...

virtual StatusCode	updateObject (DataObject *toUpdate)=0
	Update object identified by its pointer. More...

StatusCode	updateObject (std::string_view parentPath, std::string_view updatePath)
	Update object identified by its parent's path and the path relative to the parent. More...

StatusCode	updateObject (DataObject *pParent, std::string_view updatePath)
	Update object identified by its parent's pointer and the path relative to the parent. More...

virtual StatusCode	addPreLoadItem (const DataStoreItem &item)=0
	Add an item to the preload list. More...

StatusCode	addPreLoadItem (std::string itemPath)
	Add an item to the preload list. More...

virtual StatusCode	removePreLoadItem (const DataStoreItem &item)=0
	Remove an item from the preload list. More...

StatusCode	removePreLoadItem (std::string itemPath)
	Remove an item from the preload list. More...

virtual StatusCode	resetPreLoad ()=0
	Clear the preload list. More...

virtual StatusCode	preLoad ()=0
	Load all preload items of the list. More...

virtual StatusCode	linkObject (IRegistry from, std::string_view objPath, DataObject toObj)=0
	Add a link to another object. More...

StatusCode	linkObject (std::string_view fromPath, std::string_view objPath, DataObject *toObj)
	Add a link to another object. More...

StatusCode	linkObject (DataObject fromObj, std::string_view objPath, DataObject toObj)
	Add a link to another object. More...

virtual StatusCode	linkObject (std::string_view fullPath, DataObject *toObj)=0
	Add a link to another object. More...

virtual StatusCode	unlinkObject (IRegistry *from, std::string_view objPath)=0
	Remove a link to another object. More...

StatusCode	unlinkObject (std::string_view fromPath, std::string_view objPath)
	Remove a link to another object. More...

virtual StatusCode	unlinkObject (DataObject *fromObj, std::string_view objPath)=0
	Remove a link to another object. More...

virtual StatusCode	unlinkObject (std::string_view fullPath)=0
	Remove a link to another object. More...

Public Member Functions inherited from IInterface
virtual void *	i_cast (const InterfaceID &) const =0
	main cast function More...

virtual std::vector< std::string >	getInterfaceNames () const =0
	Returns a vector of strings containing the names of all the implemented interfaces. More...

virtual unsigned long	addRef ()=0
	Increment the reference count of Interface instance. More...

virtual unsigned long	release ()=0
	Release Interface instance. More...

virtual unsigned long	refCount () const =0
	Current reference count. More...

virtual StatusCode	queryInterface (const InterfaceID &ti, void **pp)=0
	Set the void** to the pointer to the requested interface of the instance. More...

virtual	~IInterface ()=default
	Virtual destructor. More...

Static Private Member Functions
static std::string	itemToPath (int item)
	Helper function to convert item numbers to path strings. More...

Additional Inherited Members
Static Public Member Functions inherited from IInterface
static const InterfaceID &	interfaceID ()
	Return an instance of InterfaceID identifying the interface. More...

Detailed Description

Data provider interface definition. The data provider interface allows to:

Define lists of items to be loaded automatically when a new root node is assigned to the data store.
Register objects from the data store. Once objects are registered with the data store the client gives up ownership.
Unregister objects from the data store. Unregistering an object means to actually delete all entries hanging below, not the object itself - since the client claims back ownership. Note that this is a very delicate operation - any reference to the object will be invalid. Even worse: invalid references cannot be detected.
Retrieve objects to the data store. Depending on the availibility of the requested object in the data store the represented object will be loaded if possible.
Find objects beeing present in the store without actually creating the representation if the object is not present.
Create 'soft' links between objects in the transient store.
Request object updates.

Author: Markus Frank; Sebastien Ponce

Definition at line 53 of file IDataProviderSvc.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
SEPARATOR

Definition at line 63 of file IDataProviderSvc.h.

63 { SEPARATOR = '/' };

◆ Status

enum IDataProviderSvc::Status : StatusCode::code_t

strong

Status code definitions.

Enumerator
IDataProviderSvc_NO_ERROR	Success.
DOUBL_OBJ_PATH	The path for this objects is already in use.
INVALID_OBJ_PATH	Invalid path from root to object request failed.
INVALID_ROOT	Invalid root path object cannot be retrieved or stored.
INVALID_OBJECT	Object pointer is invalid.
INVALID_PARENT	Pointer to parent object is not valid.
OBJ_NOT_LOADED	Sorry, the requested object is not loaded.
NO_DATA_LOADER	No data loader available.
INVALID_OBJ_ADDR	Invalid object address.
DIR_NOT_EMPTY	Directory entry is NOT empty.
NO_MORE_LEVELS	Automatic data loading had to stop: maximum depth.
NO_ACCESS	Access to the requested leaf is inhibited.
LAST	Terminator.

Definition at line 558 of file IDataProviderSvc.h.

                     : StatusCode::code_t {
     IDataProviderSvc_NO_ERROR = 1,
     DOUBL_OBJ_PATH,
     INVALID_OBJ_PATH,
     INVALID_ROOT,
     INVALID_OBJECT,
     INVALID_PARENT,
     OBJ_NOT_LOADED,
     NO_DATA_LOADER,
     INVALID_OBJ_ADDR,
     DIR_NOT_EMPTY,
     NO_MORE_LEVELS,
     NO_ACCESS,
     LAST
   };

Member Function Documentation

◆ addPreLoadItem() [1/2]

virtual StatusCode IDataProviderSvc::addPreLoadItem ( const DataStoreItem & item )

pure virtual

Add an item to the preload list.

Parameters

item	Specs of item to be preloaded

Returns: Status code indicating success or failure.

◆ addPreLoadItem() [2/2]

StatusCode IDataProviderSvc::addPreLoadItem ( std::string itemPath )

inline

Add an item to the preload list.

The item is identified by the path to the object.

Parameters

itemPath Path to the item to be preloaded.

Returns: Status code indicating success or failure.

Definition at line 443 of file IDataProviderSvc.h.

                                                   {
     return addPreLoadItem( DataStoreItem( std::move( itemPath ), 1 ) );
   }

◆ DeclareInterfaceID()

IDataProviderSvc::DeclareInterfaceID	(	IDataProviderSvc	,
		4	,
		0
	)

InterfaceID.

◆ findObject() [1/6]

StatusCode IDataProviderSvc::findObject	(	DataObject *	parentObj,
		int	item,
		DataObject *&	pObject
	)

inline

Find object identified by its parent object and an integer identifier in the data store.

In case the object is not present the pointer will be set to NULL.

Parameters

parentObj	Pointer to parent node of the object.
item	Item identifier.
pObject	Reference to the pointer of the object to be returned.

Returns: Status code indicating success or failure.

Definition at line 373 of file IDataProviderSvc.h.

                                                                                  {
     return findObject( parentObj, itemToPath( item ), pObject );
   }

◆ findObject() [2/6]

StatusCode IDataProviderSvc::findObject	(	DataObject *	parentObj,
		std::string_view	objectPath,
		DataObject *&	pObject
	)

inline

Find object identified by its parent object and the path to the object relative to the parent.

The result will be returned in the second argument. In case the object is not present the pointer will be set to NULL.

Parameters

parentObj	Pointer to parent node of the object.
objectPath	Relative path name of the object.
pObject	Reference to the pointer of the object to be returned.

Returns: Status code indicating success or failure.

Definition at line 361 of file IDataProviderSvc.h.

                                                                                                   {
     return findObject( parentObj ? parentObj->registry() : nullptr, objectPath, pObject );
   }

◆ findObject() [3/6]

virtual StatusCode IDataProviderSvc::findObject	(	IRegistry *	pDirectory,
		std::string_view	path,
		DataObject *&	pObject
	)

pure virtual

Find object identified by its directory entry.

The result will be returned in the second argument. In case the object is not present the pointer will be set to NULL. ** FASTEST ACCESS TO THE DATA STORE **

Parameters

pDirectory	Pointer to the object.
path	String with relative path to directory. Ideally ""!
pObject	Reference to the pointer of the object to be returned.

Returns: Status code indicating success or failure.

◆ findObject() [4/6]

virtual StatusCode IDataProviderSvc::findObject	(	std::string_view	fullPath,
		DataObject *&	pObject
	)

pure virtual

Find object identified by its full path in the data store.

The result will be returned in the second argument. In case the object is not present the pointer will be set to NULL.

Parameters

fullPath	Path name of the object.
pObject	Pointer to the object to be connected.

Returns: Status code indicating success or failure.

◆ findObject() [5/6]

StatusCode IDataProviderSvc::findObject	(	std::string_view	parentPath,
		int	item,
		DataObject *&	pObject
	)

inline

Find object identified by its parent object and an integer identifier in the data store.

In case the object is not present the pointer will be set to NULL.

Parameters

parentPath	Path to parent node of the object.
item	Item identifier.
pObject	Reference to the pointer of the object to be returned.

Returns: Status code indicating success or failure.

Definition at line 348 of file IDataProviderSvc.h.

                                                                                      {
     return findObject( parentPath, itemToPath( item ), pObject );
   }

◆ findObject() [6/6]

StatusCode IDataProviderSvc::findObject	(	std::string_view	parentPath,
		std::string_view	objectPath,
		DataObject *&	pObject
	)

inline

Find object identified by its parent object and the path to the object relative to the parent.

The result will be returned in the second argument. In case the object is not present the pointer will be set to NULL.

Parameters

parentPath	Path to parent node of the object.
objectPath	Relative path name of the object.
pObject	Reference to the pointer of the object to be returned.

Returns: Status code indicating success or failure.

Definition at line 334 of file IDataProviderSvc.h.

                                                                                                       {
     DataObject* parent = nullptr;
     StatusCode  status = findObject( parentPath, parent );
     return status.isSuccess() ? findObject( parent, objectPath, pObject ) : status;
   }

◆ itemToPath()

static std::string IDataProviderSvc::itemToPath ( int item )

inlinestaticprivate

Helper function to convert item numbers to path strings.

Definition at line 57 of file IDataProviderSvc.h.

57 { return '/' + std::to_string( item ); }

◆ linkObject() [1/4]

StatusCode IDataProviderSvc::linkObject	(	DataObject *	fromObj,
		std::string_view	objPath,
		DataObject *	toObj
	)

inline

Add a link to another object.

Both objects must already be registered with the data store. Once linked, the object can only be unregistered after unlinking.

Parameters

fromObj	Pointer to the object the link originates.
objPath	Path of the entry to be linked relative to from.
toObj	Pointer to the object the link points to.

Returns: Status code indicating success or failure.

Definition at line 590 of file IDataProviderSvc.h.

                                                                                                                {
   if ( fromObj ) {
     IRegistry* from_entry = fromObj->registry();
     if ( from_entry ) return linkObject( from_entry, objPath, toObj );
   }
   return Status::INVALID_PARENT;
 }

◆ linkObject() [2/4]

virtual StatusCode IDataProviderSvc::linkObject	(	IRegistry *	from,
		std::string_view	objPath,
		DataObject *	toObj
	)

pure virtual

Add a link to another object.

Both objects must already be registered with the data store. Once linked, the object can only be unregistered after unlinking.

Parameters

from	Pointer to data directory the link originates.
objPath	Path of the entry to be linked relative to from.
toObj	Pointer to the object the link points to.

Returns: Status code indicating success or failure.

◆ linkObject() [3/4]

StatusCode IDataProviderSvc::linkObject	(	std::string_view	fromPath,
		std::string_view	objPath,
		DataObject *	toObj
	)

inline

Add a link to another object.

Both objects must already be registered with the data store. Once linked, the object can only be unregistered after unlinking.

Parameters

fromPath	Path to the object the link originates.
objPath	Path of the entry to be linked relative to from.
toObj	Pointer to the object the link points to.

Returns: Status code indicating success or failure.

Definition at line 489 of file IDataProviderSvc.h.

                                                                                               {
     DataObject* pO     = nullptr;
     StatusCode  status = retrieveObject( fromPath, pO );
     return status.isSuccess() ? linkObject( pO->registry(), objPath, toObj ) : status;
   }

◆ linkObject() [4/4]

virtual StatusCode IDataProviderSvc::linkObject	(	std::string_view	fullPath,
		DataObject *	toObj
	)

pure virtual

Add a link to another object.

Both objects must already be registered with the data store. Once linked, the object can only be unregistered after unlinking.

Parameters

fullPath	Full path of the entry to be linked.
toObj	Pointer to the object the link points to.

Returns: Status code indicating success or failure.

◆ preLoad()

virtual StatusCode IDataProviderSvc::preLoad ( )

pure virtual

Load all preload items of the list.

Returns: Status code indicating success or failure.

◆ registerObject() [1/5]

StatusCode IDataProviderSvc::registerObject	(	DataObject *	parentObj,
		int	item,
		DataObject *	pObject
	)

inline

Register object with the data store.

Connect the object identified by its pointer to the node object identified by its pointer.

Parameters

parentObj	Pointer to parent object.
item	item number of the object linked to the parent
pObject	Pointer to the object to be connected.

Returns: Status code indicating success or failure.

Definition at line 117 of file IDataProviderSvc.h.

                                                                                     {
     return registerObject( parentObj, itemToPath( item ), pObject );
   }

◆ registerObject() [2/5]

virtual StatusCode IDataProviderSvc::registerObject	(	DataObject *	parentObj,
		std::string_view	objectPath,
		DataObject *	pObject
	)

pure virtual

Register object with the data store.

Connect the object identified by its pointer to the parent object and the relative path of the object with respect to the parent.

Parameters

parentObj	Pointer to parent object.
objectPath	Path of the object relative to the parent node
pObject	Pointer to the object to be connected.

Returns: Status code indicating success or failure.

◆ registerObject() [3/5]

StatusCode IDataProviderSvc::registerObject	(	std::string_view	fullPath,
		DataObject *	pObject
	)

inline

Register object with the data store.

Connect the object identified by its pointer to the node object identified by its path.

Parameters

fullPath	Path to parent node of the object.
pObject	Pointer to the object to be registered.

Returns: Status code indicating success or failure.

Definition at line 72 of file IDataProviderSvc.h.

                                                                             {
     return registerObject( nullptr, fullPath, pObject );
   }

◆ registerObject() [4/5]

StatusCode IDataProviderSvc::registerObject	(	std::string_view	parentPath,
		int	item,
		DataObject *	pObject
	)

inline

Register object with the data store.

Connect the object identified by its pointer to the parent object and an integer identifier.

Parameters

parentPath	Path to parent node of the object.
item	item number of the object linked to the parent
pObject	Pointer to the object to be registered.

Returns: Status code indicating success or failure.

Definition at line 95 of file IDataProviderSvc.h.

                                                                                         {
     return registerObject( parentPath, itemToPath( item ), pObject );
   }

◆ registerObject() [5/5]

virtual StatusCode IDataProviderSvc::registerObject	(	std::string_view	parentPath,
		std::string_view	objectPath,
		DataObject *	pObject
	)

pure virtual

Register object with the data store.

Connect the object identified by the path to the parent object and the path of the object itself relative to the specified parent.

Parameters

parentPath	Path to parent node of the object.
objectPath	Path of the object relative to the parent node
pObject	Pointer to the object to be registered.

Returns: Status code indicating success or failure.

◆ removePreLoadItem() [1/2]

virtual StatusCode IDataProviderSvc::removePreLoadItem ( const DataStoreItem & item )

pure virtual

Remove an item from the preload list.

Parameters

item	Specs of item to be removed from the preload list

Returns: Status code indicating success or failure.

◆ removePreLoadItem() [2/2]

StatusCode IDataProviderSvc::removePreLoadItem ( std::string itemPath )

inline

Remove an item from the preload list.

Parameters

itemPath Path to the item to be preloaded.

Returns: Status code indicating success or failure.

Definition at line 457 of file IDataProviderSvc.h.

                                                      {
     return removePreLoadItem( DataStoreItem( std::move( itemPath ), 1 ) );
   }

◆ resetPreLoad()

virtual StatusCode IDataProviderSvc::resetPreLoad ( )

pure virtual

Clear the preload list.

Returns: Status code indicating success or failure.

◆ retrieveObject() [1/6]

StatusCode IDataProviderSvc::retrieveObject	(	DataObject *	parentObj,
		int	item,
		DataObject *&	pObject
	)

inline

Retrieve object from data store.

The object to be retrieved is identified by the pointer to the parent object and an integer identifier. In case the object is not present it will be loaded and converted if possible.

Parameters

parentObj	Pointer to parent node of the object.
item	Item identifier.
pObject	Reference to the pointer of the object to be returned.

Returns: Status code indicating success or failure.

Definition at line 301 of file IDataProviderSvc.h.

                                                                                      {
     return retrieveObject( parentObj, itemToPath( item ), pObject );
   }

◆ retrieveObject() [2/6]

StatusCode IDataProviderSvc::retrieveObject	(	DataObject *	parentObj,
		std::string_view	objectPath,
		DataObject *&	pObject
	)

inline

Retrieve object from data store.

The object to be retrieved is identified by the pointer to the parent object and the relative path with respect to the node. In case the object is not present it will be loaded and converted if possible.

Parameters

parentObj	Pointer to parent node of the object.
objectPath	Path of the object relative to the parent.
pObject	Reference to the pointer of the object to be returned.

Returns: Status code indicating success or failure.

Definition at line 287 of file IDataProviderSvc.h.

                                                                                                       {
     return retrieveObject( parentObj ? parentObj->registry() : nullptr, objectPath, pObject );
   }

◆ retrieveObject() [3/6]

virtual StatusCode IDataProviderSvc::retrieveObject	(	IRegistry *	pDirectory,
		std::string_view	path,
		DataObject *&	pObject
	)

pure virtual

Retrieve object identified by its directory entry.

The result will be returned in the second argument. In case the object is not present it will be loaded and converted if possible. ** FASTEST ACCESS TO THE DATA STORE **

Parameters

pDirectory	Pointer to the object.
path	String with relative path to directory. Ideally ""!
pObject	Reference to the pointer of the object to be returned.

Returns: Status code indicating success or failure.

◆ retrieveObject() [4/6]

StatusCode IDataProviderSvc::retrieveObject	(	std::string_view	fullPath,
		DataObject *&	pObject
	)

inline

Retrieve object identified by its full path from the data store.

The result will be returned in the second argument. In case the object is not present it will be loaded and converted if possible.

Parameters

fullPath	Path name of the object.
pObject	Reference to the pointer of the object to be returned.

Returns: Status code indicating success or failure.

Definition at line 243 of file IDataProviderSvc.h.

                                                                              {
     return retrieveObject( static_cast<IRegistry*>( nullptr ), fullPath, pObject );
   }

◆ retrieveObject() [5/6]

StatusCode IDataProviderSvc::retrieveObject	(	std::string_view	parentPath,
		int	item,
		DataObject *&	pObject
	)

inline

Retrieve object from data store.

The object to be retrieved is identified by the path to the parent object and an integer identifier. In case the object is not present it will be loaded and converted if possible.

Parameters

parentPath	Path to parent node of the object.
item	Item identifier.
pObject	Reference to the pointer of the object to be returned.

Returns: Status code indicating success or failure.

Definition at line 273 of file IDataProviderSvc.h.

                                                                                          {
     return retrieveObject( parentPath, itemToPath( item ), pObject );
   }

◆ retrieveObject() [6/6]

StatusCode IDataProviderSvc::retrieveObject	(	std::string_view	parentPath,
		std::string_view	objectPath,
		DataObject *&	pObject
	)

inline

Retrieve object from data store.

The object to be retrieved is identified by the path of the parent object and the relative path with respect to the node. In case the object is not present it will be loaded and converted if possible.

Parameters

parentPath	Path to parent node of the object.
objectPath	Path of the object relative to the parent.
pObject	Reference to the pointer of the object to be returned.

Returns: Status code indicating success or failure.

Definition at line 257 of file IDataProviderSvc.h.

                                                                                                           {
     DataObject* parent = nullptr;
     StatusCode  status = retrieveObject( parentPath, parent );
     return status.isSuccess() ? retrieveObject( parent, objectPath, pObject ) : status;
   }

◆ unlinkObject() [1/4]

virtual StatusCode IDataProviderSvc::unlinkObject	(	DataObject *	fromObj,
		std::string_view	objPath
	)

pure virtual

Remove a link to another object.

Both objects must be registered with the data store. This entry point can be used to unlink objects e.g. in order to unregister them.

Parameters

fromObj	Pointer to the object the link originates.
objPath	Path of the entry to be linked relative to from.

Returns: Status code indicating success or failure.

◆ unlinkObject() [2/4]

virtual StatusCode IDataProviderSvc::unlinkObject	(	IRegistry *	from,
		std::string_view	objPath
	)

pure virtual

Remove a link to another object.

Both objects must be registered with the data store. This entry point can be used to unlink objects e.g. in order to unregister them.

Parameters

from	Pointer to data directory the link originates.
objPath	Path of the entry to be linked relative to from.

Returns: Status code indicating success or failure.

◆ unlinkObject() [3/4]

StatusCode IDataProviderSvc::unlinkObject	(	std::string_view	fromPath,
		std::string_view	objPath
	)

inline

Remove a link to another object.

Both objects must be registered with the data store. This entry point can be used to unlink objects e.g. in order to unregister them.

Parameters

fromPath	Path to the object the link originates.
objPath	Path of the entry to be linked relative to from.

Returns: Status code indicating success or failure.

Definition at line 532 of file IDataProviderSvc.h.

                                                                              {
     DataObject* pObject = nullptr;
     StatusCode  status  = findObject( fromPath, pObject );
     return status.isSuccess() ? unlinkObject( pObject->registry(), objPath ) : status;
   }

◆ unlinkObject() [4/4]

virtual StatusCode IDataProviderSvc::unlinkObject ( std::string_view fullPath )

pure virtual

Remove a link to another object.

Both objects must be registered with the data store. This entry point can be used to unlink objects e.g. in order to unregister them.

Parameters

fullPath Full path of the entry to be linked.

Returns: Status code indicating success or failure.

◆ unregisterObject() [1/6]

virtual StatusCode IDataProviderSvc::unregisterObject ( DataObject * pObject )

pure virtual

Unregister object from the data store.

On registration the client gives up ownership of the object and may no longer delete the object. unregistering the object is the opposite: ownership is claimed back by the user. But note:

All depending objects will be deleted, ie. all leaves "below" the entry in question; NOT the object itself, the object itself must be destroyed by the user.

The object is identified by its pointer. The object must previously have been registered with the data store.

Parameters

pObject Pointer to the object.

Returns: Status code indicating success or failure.

◆ unregisterObject() [2/6]

StatusCode IDataProviderSvc::unregisterObject	(	DataObject *	pParent,
		int	item
	)

inline

Unregister object from the data store.

On registration the client gives up ownership of the object and may no longer delete the object. unregistering the object is the opposite: ownership is claimed back by the user. But note:

All depending objects will be deleted, ie. all leaves "below" the entry in question; NOT the object itself, the object itself must be destroyed by the user.

The object is identified by parent object and an integer identifier of the object itself.

Parameters

pParent	Pointer to parent object.
item	Integer identifier of the object item.

Returns: Status code indicating success or failure.

Definition at line 219 of file IDataProviderSvc.h.

                                                                {
     return unregisterObject( pParent, itemToPath( item ) );
   }

◆ unregisterObject() [3/6]

virtual StatusCode IDataProviderSvc::unregisterObject	(	DataObject *	pParent,
		std::string_view	objPath
	)

pure virtual

Unregister object from the data store.

On registration the client gives up ownership of the object and may no longer delete the object. unregistering the object is the opposite: ownership is claimed back by the user. But note:

All depending objects will be deleted, ie. all leaves "below" the entry in question; NOT the object itself, the object itself must be destroyed by the user.

The object is identified by parent object and the path of the object relative to the parent.

Parameters

pParent	Pointer to parent object.
objPath	Path name of the object relative to the parent.

Returns: Status code indicating success or failure.

◆ unregisterObject() [4/6]

virtual StatusCode IDataProviderSvc::unregisterObject ( std::string_view fullPath )

pure virtual

Unregister object from the data store.

On registration the client gives up ownership of the object and may no longer delete the object. unregistering the object is the opposite: ownership is claimed back by the user. But note:

All depending objects will be deleted, ie. all leaves "below" the entry in question; NOT the object itself, the object itself must be destroyed by the user.

The object is identified by full path name.

Parameters

fullPath Path name of the object.

Returns: Status code indicating success or failure.

◆ unregisterObject() [5/6]

StatusCode IDataProviderSvc::unregisterObject	(	std::string_view	parentPath,
		int	item
	)

inline

Unregister object from the data store.

On registration the client gives up ownership of the object and may no longer delete the object. unregistering the object is the opposite: ownership is claimed back by the user. But note:

All depending objects will be deleted, ie. all leaves "below" the entry in question; NOT the object itself, the object itself must be destroyed by the user.

The object is identified by parent path name and an integer identifier of the object itself.

Parameters

parentPath	Path name of the parent object.
item	Integer identifier of the object item.

Returns: Status code indicating success or failure.

Definition at line 170 of file IDataProviderSvc.h.

                                                                      {
     return unregisterObject( parentPath, itemToPath( item ) );
   }

◆ unregisterObject() [6/6]

StatusCode IDataProviderSvc::unregisterObject	(	std::string_view	parentPath,
		std::string_view	objPath
	)

inline

Unregister object from the data store.

On registration the client gives up ownership of the object and may no longer delete the object. unregistering the object is the opposite: ownership is claimed back by the user. But note:

All depending objects will be deleted, ie. all leaves "below" the entry in question; NOT the object itself, the object itself must be destroyed by the user.

The object is identified by parent path name and the path of the object relative to the parent.

Parameters

parentPath	Path name of the parent object.
objPath	Path name of the object relative to the parent.

Returns: Status code indicating success or failure.

Definition at line 150 of file IDataProviderSvc.h.

                                                                                    {
     DataObject* pO     = nullptr;
     StatusCode  status = findObject( parentPath, pO );
     return status.isSuccess() ? unregisterObject( pO, objPath ) : status;
   }

◆ updateObject() [1/5]

StatusCode IDataProviderSvc::updateObject	(	DataObject *	pParent,
		std::string_view	updatePath
	)

inline

Update object identified by its parent's pointer and the path relative to the parent.

If found, the object update will be initiated. In case the object is not present the entry point returns an error.

Parameters

pParent	Pointer to the parent object.
updatePath	Path to the object relative to the parent.

Returns: Status code indicating success or failure.

Definition at line 426 of file IDataProviderSvc.h.

                                                                             {
     DataObject* pObject = nullptr;
     StatusCode  status  = findObject( pParent, updatePath, pObject );
     return status.isSuccess() ? updateObject( pObject ) : status;
   }

◆ updateObject() [2/5]

virtual StatusCode IDataProviderSvc::updateObject ( DataObject * toUpdate )

pure virtual

Update object identified by its pointer.

If found, the object update will be initiated. In case the object is not present the entry point returns an error.

Parameters

toUpdate Pointer to the object.

Returns: Status code indicating success or failure.

◆ updateObject() [3/5]

virtual StatusCode IDataProviderSvc::updateObject ( IRegistry * pDirectory )

pure virtual

Update object identified by its directory entry.

** FASTEST ACCESS TO THE DATA STORE **

Parameters

pDirectory Pointer to the directory entry.

Returns: Status code indicating success or failure.

◆ updateObject() [4/5]

StatusCode IDataProviderSvc::updateObject ( std::string_view fullPath )

inline

Update object identified by its full path in the data store.

If found, the object update will be initiated. In case the object is not present the entry point returns an error.

Parameters

fullPath Path name of the object.

Returns: Status code indicating success or failure.

Definition at line 390 of file IDataProviderSvc.h.

                                                      {
     DataObject* pO     = nullptr;
     StatusCode  status = findObject( fullPath, pO );
     return status.isSuccess() ? updateObject( pO ) : retrieveObject( fullPath, pO );
   }

◆ updateObject() [5/5]

StatusCode IDataProviderSvc::updateObject	(	std::string_view	parentPath,
		std::string_view	updatePath
	)

inline

Update object identified by its parent's path and the path relative to the parent.

If found, the object update will be initiated. In case the object is not present the entry point returns an error.

Parameters

parentPath	Path name of the parent object.
updatePath	Path to the object relative to the parent.

Returns: Status code indicating success or failure.

Definition at line 412 of file IDataProviderSvc.h.

                                                                                   {
     DataObject* pParent = nullptr;
     StatusCode  status  = findObject( parentPath, pParent );
     return status.isSuccess() ? updateObject( pParent, updatePath ) : status;
   }

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

GaudiKernel/include/GaudiKernel/IDataProviderSvc.h

Public Types

Public Member Functions

Static Private Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ Status

Member Function Documentation

◆ addPreLoadItem() [1/2]

◆ addPreLoadItem() [2/2]

◆ DeclareInterfaceID()

◆ findObject() [1/6]

◆ findObject() [2/6]

◆ findObject() [3/6]

◆ findObject() [4/6]

◆ findObject() [5/6]

◆ findObject() [6/6]

◆ itemToPath()

◆ linkObject() [1/4]

◆ linkObject() [2/4]

◆ linkObject() [3/4]

◆ linkObject() [4/4]

◆ preLoad()

◆ registerObject() [1/5]

◆ registerObject() [2/5]

◆ registerObject() [3/5]

◆ registerObject() [4/5]

◆ registerObject() [5/5]

◆ removePreLoadItem() [1/2]

◆ removePreLoadItem() [2/2]

◆ resetPreLoad()

◆ retrieveObject() [1/6]

◆ retrieveObject() [2/6]

◆ retrieveObject() [3/6]

◆ retrieveObject() [4/6]

◆ retrieveObject() [5/6]

◆ retrieveObject() [6/6]

◆ unlinkObject() [1/4]

◆ unlinkObject() [2/4]

◆ unlinkObject() [3/4]

◆ unlinkObject() [4/4]

◆ unregisterObject() [1/6]

◆ unregisterObject() [2/6]

◆ unregisterObject() [3/6]

◆ unregisterObject() [4/6]

◆ unregisterObject() [5/6]

◆ unregisterObject() [6/6]

◆ updateObject() [1/5]

◆ updateObject() [2/5]

◆ updateObject() [3/5]

◆ updateObject() [4/5]

◆ updateObject() [5/5]