Definition of the IAIDATupleSvc interface class. More...

#include <GaudiKernel/IAIDATupleSvc.h>

Inheritance diagram for IAIDATupleSvc:

[legend]

Collaboration diagram for IAIDATupleSvc:

[legend]

Public Member Functions
	DeclareInterfaceID (IAIDATupleSvc, 3, 0)
	InterfaceID.

virtual AIDA::ITuple *	book (const std::string &fullPath, const std::string &title, const std::string &columns)=0

virtual StatusCode	registerObject (const std::string &dirPath, const std::string &objPath, AIDA::ITuple *tObj)=0

virtual StatusCode	registerObject (DataObject pParent, const std::string &objPath, AIDA::ITuple tObj)=0

virtual StatusCode	unregisterObject (AIDA::ITuple *tObj)=0

virtual StatusCode	unregisterObject (AIDA::ITuple *tObj, const std::string &objectPath)=0

virtual StatusCode	retrieveObject (const std::string &fullPath, AIDA::ITuple *&tObj)=0

virtual StatusCode	retrieveObject (const std::string &parentPath, const std::string &objPath, AIDA::ITuple *&tObj)=0

virtual StatusCode	retrieveObject (DataObject parentObj, const std::string &objPath, AIDA::ITuple &tObj)=0

virtual StatusCode	findObject (const std::string &fullPath, AIDA::ITuple *&tObj)=0

virtual StatusCode	findObject (IRegistry pDirectory, const std::string &path, AIDA::ITuple &tObj)=0

virtual StatusCode	findObject (const std::string &parentPath, const std::string &objPath, AIDA::ITuple *&tObj)=0

virtual StatusCode	findObject (DataObject parentObj, const std::string &objPath, AIDA::ITuple &tObj)=0

virtual void	setCriteria (AIDA::ITuple *&tObj, const std::string &criteria)=0
	Set criteria for reading, filtering the input.

virtual DataObject *	createPath (const std::string &newPath)=0

virtual DataObject *	createDirectory (const std::string &parentDir, const std::string &subDir)=0

virtual StatusCode	myTest ()=0

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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.

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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.

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.

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

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

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

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

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Public Member Functions inherited from IInterface
template<Gaudi::IsInterface TARGET>
TARGET *	cast ()

template<Gaudi::IsInterface TARGET>
TARGET const *	cast () const

template<typename TARGET> requires ( !Gaudi::IsInterface<TARGET> )
TARGET *	cast ()

template<typename TARGET> requires ( !Gaudi::IsInterface<TARGET> )
TARGET const *	cast () const

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

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

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

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

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

virtual	~IInterface ()=default
	Virtual destructor.

virtual void const *	i_cast (const InterfaceID &) const =0

void *	i_cast (const InterfaceID &iid)

Additional Inherited Members
Public Types inherited from IDataProviderSvc
enum	{ SEPARATOR = '/' }

enum class	Status : 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 }
	Status code definitions. More...

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

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

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

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

Protected Member Functions inherited from IInterface
virtual unsigned long	decRef () const =0
	Decrement reference count and return the new reference count.

Detailed Description

Definition of the IAIDATupleSvc interface class.

Author: Manuel Domenech Saavedra

Date: 2005-05-23

Definition at line 35 of file IAIDATupleSvc.h.

Member Function Documentation

◆ book()

virtual AIDA::ITuple * IAIDATupleSvc::book	(	const std::string &	fullPath,
		const std::string &	title,
		const std::string &	columns )

pure virtual

◆ createDirectory()

virtual DataObject * IAIDATupleSvc::createDirectory	(	const std::string &	parentDir,
		const std::string &	subDir )

pure virtual

◆ createPath()

virtual DataObject * IAIDATupleSvc::createPath ( const std::string & newPath )

pure virtual

◆ DeclareInterfaceID()

IAIDATupleSvc::DeclareInterfaceID	(	IAIDATupleSvc	,
		3	,
		0	)

InterfaceID.

◆ findObject() [1/10]

virtual StatusCode IAIDATupleSvc::findObject	(	const std::string &	fullPath,
		AIDA::ITuple *&	tObj )

pure virtual

◆ findObject() [2/10]

virtual StatusCode IAIDATupleSvc::findObject	(	const std::string &	parentPath,
		const std::string &	objPath,
		AIDA::ITuple *&	tObj )

pure virtual

◆ findObject() [3/10]

virtual StatusCode IAIDATupleSvc::findObject	(	DataObject *	parentObj,
		const std::string &	objPath,
		AIDA::ITuple *&	tObj )

pure virtual

◆ findObject() [4/10]

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 368 of file IDataProviderSvc.h.

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

◆ findObject() [5/10]

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 356 of file IDataProviderSvc.h.

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

◆ findObject() [6/10]

virtual StatusCode IAIDATupleSvc::findObject	(	IRegistry *	pDirectory,
		const std::string &	path,
		AIDA::ITuple *&	tObj )

pure virtual

◆ findObject() [7/10]

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

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.

Implements IDataProviderSvc.

◆ findObject() [8/10]

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

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.

Implements IDataProviderSvc.

◆ findObject() [9/10]

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 343 of file IDataProviderSvc.h.

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

◆ findObject() [10/10]

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 329 of file IDataProviderSvc.h.

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

◆ myTest()

virtual StatusCode IAIDATupleSvc::myTest ( )

pure virtual

◆ registerObject() [1/7]

virtual StatusCode IAIDATupleSvc::registerObject	(	const std::string &	dirPath,
		const std::string &	objPath,
		AIDA::ITuple *	tObj )

pure virtual

◆ registerObject() [2/7]

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 112 of file IDataProviderSvc.h.

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

◆ registerObject() [3/7]

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

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.

Implements IDataProviderSvc.

◆ registerObject() [4/7]

virtual StatusCode IAIDATupleSvc::registerObject	(	DataObject *	pParent,
		const std::string &	objPath,
		AIDA::ITuple *	tObj )

pure virtual

◆ registerObject() [5/7]

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 67 of file IDataProviderSvc.h.

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

◆ registerObject() [6/7]

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 90 of file IDataProviderSvc.h.

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

◆ registerObject() [7/7]

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

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.

Implements IDataProviderSvc.

◆ retrieveObject() [1/9]

virtual StatusCode IAIDATupleSvc::retrieveObject	(	const std::string &	fullPath,
		AIDA::ITuple *&	tObj )

pure virtual

◆ retrieveObject() [2/9]

virtual StatusCode IAIDATupleSvc::retrieveObject	(	const std::string &	parentPath,
		const std::string &	objPath,
		AIDA::ITuple *&	tObj )

pure virtual

◆ retrieveObject() [3/9]

virtual StatusCode IAIDATupleSvc::retrieveObject	(	DataObject *	parentObj,
		const std::string &	objPath,
		AIDA::ITuple *&	tObj )

pure virtual

◆ retrieveObject() [4/9]

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 296 of file IDataProviderSvc.h.

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

◆ retrieveObject() [5/9]

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 282 of file IDataProviderSvc.h.

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

◆ retrieveObject() [6/9]

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

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.

Implements IDataProviderSvc.

◆ retrieveObject() [7/9]

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 238 of file IDataProviderSvc.h.

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

◆ retrieveObject() [8/9]

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 268 of file IDataProviderSvc.h.

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

◆ retrieveObject() [9/9]

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 252 of file IDataProviderSvc.h.

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

◆ setCriteria()

virtual void IAIDATupleSvc::setCriteria	(	AIDA::ITuple *&	tObj,
		const std::string &	criteria )

pure virtual

Set criteria for reading, filtering the input.

◆ unregisterObject() [1/8]

virtual StatusCode IAIDATupleSvc::unregisterObject ( AIDA::ITuple * tObj )

pure virtual

◆ unregisterObject() [2/8]

virtual StatusCode IAIDATupleSvc::unregisterObject	(	AIDA::ITuple *	tObj,
		const std::string &	objectPath )

pure virtual

◆ unregisterObject() [3/8]

virtual StatusCode IDataProviderSvc::unregisterObject ( DataObject * pObject )

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.

Implements IDataProviderSvc.

◆ unregisterObject() [4/8]

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 214 of file IDataProviderSvc.h.

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

◆ unregisterObject() [5/8]

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

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.

Implements IDataProviderSvc.

◆ unregisterObject() [6/8]

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

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.

Implements IDataProviderSvc.

◆ unregisterObject() [7/8]

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 165 of file IDataProviderSvc.h.

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

◆ unregisterObject() [8/8]

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 145 of file IDataProviderSvc.h.

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

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

GaudiKernel/include/GaudiKernel/IAIDATupleSvc.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ book()

◆ createDirectory()

◆ createPath()

◆ DeclareInterfaceID()

◆ findObject() [1/10]

◆ findObject() [2/10]

◆ findObject() [3/10]

◆ findObject() [4/10]

◆ findObject() [5/10]

◆ findObject() [6/10]

◆ findObject() [7/10]

◆ findObject() [8/10]

◆ findObject() [9/10]

◆ findObject() [10/10]

◆ myTest()

◆ registerObject() [1/7]

◆ registerObject() [2/7]

◆ registerObject() [3/7]

◆ registerObject() [4/7]

◆ registerObject() [5/7]

◆ registerObject() [6/7]

◆ registerObject() [7/7]

◆ retrieveObject() [1/9]

◆ retrieveObject() [2/9]

◆ retrieveObject() [3/9]

◆ retrieveObject() [4/9]

◆ retrieveObject() [5/9]

◆ retrieveObject() [6/9]

◆ retrieveObject() [7/9]

◆ retrieveObject() [8/9]

◆ retrieveObject() [9/9]

◆ setCriteria()

◆ unregisterObject() [1/8]

◆ unregisterObject() [2/8]

◆ unregisterObject() [3/8]

◆ unregisterObject() [4/8]

◆ unregisterObject() [5/8]

◆ unregisterObject() [6/8]

◆ unregisterObject() [7/8]

◆ unregisterObject() [8/8]