The Gaudi Framework  master (594c33fa)
IAIDATupleSvc Class Referenceabstract

#include <GaudiKernel/IAIDATupleSvc.h>

Inheritance diagram for IAIDATupleSvc:
Collaboration diagram for IAIDATupleSvc:

Public Member Functions

 DeclareInterfaceID (IAIDATupleSvc, 3, 0)
 InterfaceID. More...
 
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. More...
 
virtual DataObjectcreatePath (const std::string &newPath)=0
 
virtual DataObjectcreateDirectory (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. 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...
 
- Public Member Functions inherited from IDataProviderSvc
 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::stringgetInterfaceNames () 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...
 

Additional Inherited Members

- Public Types inherited from IDataProviderSvc
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...
 
- Static Public Member Functions inherited from IInterface
static const InterfaceIDinterfaceID ()
 Return an instance of InterfaceID identifying the interface. More...
 

Detailed Description

Definition of the IAIDATupleSvc interface class

Author
Manuel Domenech Saavedra
Date
2005-05-23

Definition at line 38 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  ,
,
 
)

◆ 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
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
parentObjPointer to parent node of the object.
itemItem identifier.
pObjectReference to the pointer of the object to be returned.
Returns
Status code indicating success or failure.

Definition at line 373 of file IDataProviderSvc.h.

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

◆ findObject() [5/10]

StatusCode IDataProviderSvc::findObject
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
parentObjPointer to parent node of the object.
objectPathRelative path name of the object.
pObjectReference to the pointer of the object to be returned.
Returns
Status code indicating success or failure.

Definition at line 361 of file IDataProviderSvc.h.

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

◆ 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

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
pDirectoryPointer to the object.
pathString with relative path to directory. Ideally ""!
pObjectReference to the pointer of the object to be returned.
Returns
Status code indicating success or failure.

◆ findObject() [8/10]

virtual StatusCode IDataProviderSvc::findObject

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
fullPathPath name of the object.
pObjectPointer to the object to be connected.
Returns
Status code indicating success or failure.

◆ findObject() [9/10]

StatusCode IDataProviderSvc::findObject
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
parentPathPath to parent node of the object.
itemItem identifier.
pObjectReference to the pointer of the object to be returned.
Returns
Status code indicating success or failure.

Definition at line 348 of file IDataProviderSvc.h.

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

◆ findObject() [10/10]

StatusCode IDataProviderSvc::findObject
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
parentPathPath to parent node of the object.
objectPathRelative path name of the object.
pObjectReference to the pointer of the object to be returned.
Returns
Status code indicating success or failure.

Definition at line 334 of file IDataProviderSvc.h.

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

◆ 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
inline

Register object with the data store.

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

Parameters
parentObjPointer to parent object.
itemitem number of the object linked to the parent
pObjectPointer to the object to be connected.
Returns
Status code indicating success or failure.

Definition at line 117 of file IDataProviderSvc.h.

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

◆ registerObject() [3/7]

virtual StatusCode IDataProviderSvc::registerObject

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
parentObjPointer to parent object.
objectPathPath of the object relative to the parent node
pObjectPointer to the object to be connected.
Returns
Status code indicating success or failure.

◆ registerObject() [4/7]

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

◆ registerObject() [5/7]

StatusCode IDataProviderSvc::registerObject
inline

Register object with the data store.

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

Parameters
fullPathPath to parent node of the object.
pObjectPointer to the object to be registered.
Returns
Status code indicating success or failure.

Definition at line 72 of file IDataProviderSvc.h.

72  {
73  return registerObject( nullptr, fullPath, pObject );
74  }

◆ registerObject() [6/7]

StatusCode IDataProviderSvc::registerObject
inline

Register object with the data store.

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

Parameters
parentPathPath to parent node of the object.
itemitem number of the object linked to the parent
pObjectPointer to the object to be registered.
Returns
Status code indicating success or failure.

Definition at line 95 of file IDataProviderSvc.h.

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

◆ registerObject() [7/7]

virtual StatusCode IDataProviderSvc::registerObject

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
parentPathPath to parent node of the object.
objectPathPath of the object relative to the parent node
pObjectPointer to the object to be registered.
Returns
Status code indicating success or failure.

◆ 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
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
parentObjPointer to parent node of the object.
itemItem identifier.
pObjectReference to the pointer of the object to be returned.
Returns
Status code indicating success or failure.

Definition at line 301 of file IDataProviderSvc.h.

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

◆ retrieveObject() [5/9]

StatusCode IDataProviderSvc::retrieveObject
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
parentObjPointer to parent node of the object.
objectPathPath of the object relative to the parent.
pObjectReference to the pointer of the object to be returned.
Returns
Status code indicating success or failure.

Definition at line 287 of file IDataProviderSvc.h.

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

◆ retrieveObject() [6/9]

virtual StatusCode IDataProviderSvc::retrieveObject

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
pDirectoryPointer to the object.
pathString with relative path to directory. Ideally ""!
pObjectReference to the pointer of the object to be returned.
Returns
Status code indicating success or failure.

◆ retrieveObject() [7/9]

StatusCode IDataProviderSvc::retrieveObject
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
fullPathPath name of the object.
pObjectReference to the pointer of the object to be returned.
Returns
Status code indicating success or failure.

Definition at line 243 of file IDataProviderSvc.h.

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

◆ retrieveObject() [8/9]

StatusCode IDataProviderSvc::retrieveObject
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
parentPathPath to parent node of the object.
itemItem identifier.
pObjectReference to the pointer of the object to be returned.
Returns
Status code indicating success or failure.

Definition at line 273 of file IDataProviderSvc.h.

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

◆ retrieveObject() [9/9]

StatusCode IDataProviderSvc::retrieveObject
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
parentPathPath to parent node of the object.
objectPathPath of the object relative to the parent.
pObjectReference to the pointer of the object to be returned.
Returns
Status code indicating success or failure.

Definition at line 257 of file IDataProviderSvc.h.

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

◆ 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

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
pObjectPointer to the object.
Returns
Status code indicating success or failure.

◆ unregisterObject() [4/8]

StatusCode IDataProviderSvc::unregisterObject
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
pParentPointer to parent object.
itemInteger identifier of the object item.
Returns
Status code indicating success or failure.

Definition at line 219 of file IDataProviderSvc.h.

219  {
220  return unregisterObject( pParent, itemToPath( item ) );
221  }

◆ unregisterObject() [5/8]

virtual StatusCode IDataProviderSvc::unregisterObject

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
pParentPointer to parent object.
objPathPath name of the object relative to the parent.
Returns
Status code indicating success or failure.

◆ unregisterObject() [6/8]

virtual StatusCode IDataProviderSvc::unregisterObject

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
fullPathPath name of the object.
Returns
Status code indicating success or failure.

◆ unregisterObject() [7/8]

StatusCode IDataProviderSvc::unregisterObject
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
parentPathPath name of the parent object.
itemInteger identifier of the object item.
Returns
Status code indicating success or failure.

Definition at line 170 of file IDataProviderSvc.h.

170  {
171  return unregisterObject( parentPath, itemToPath( item ) );
172  }

◆ unregisterObject() [8/8]

StatusCode IDataProviderSvc::unregisterObject
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
parentPathPath name of the parent object.
objPathPath name of the object relative to the parent.
Returns
Status code indicating success or failure.

Definition at line 150 of file IDataProviderSvc.h.

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

The documentation for this class was generated from the following file:
StatusCode::isSuccess
bool isSuccess() const
Definition: StatusCode.h:314
IAIDATupleSvc::retrieveObject
virtual StatusCode retrieveObject(const std::string &fullPath, AIDA::ITuple *&tObj)=0
IRegistry
Definition: IRegistry.h:32
IDataProviderSvc::itemToPath
static std::string itemToPath(int item)
Helper function to convert item numbers to path strings.
Definition: IDataProviderSvc.h:57
IAIDATupleSvc::unregisterObject
virtual StatusCode unregisterObject(AIDA::ITuple *tObj)=0
IAIDATupleSvc::findObject
virtual StatusCode findObject(const std::string &fullPath, AIDA::ITuple *&tObj)=0
StatusCode
Definition: StatusCode.h:65
IAIDATupleSvc::registerObject
virtual StatusCode registerObject(const std::string &dirPath, const std::string &objPath, AIDA::ITuple *tObj)=0
DataObject
Definition: DataObject.h:36