In This Package:

INTupleSvc Class Reference

#include <GaudiKernel/INTupleSvc.h>

Inheritance diagram for INTupleSvc:

[legend]Collaboration diagram for INTupleSvc:[legend]List of all members.


Public Types
	SEPARATOR = '/'
	IID_IDataProviderSvc_NO_ERROR = 1
	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 availible.
	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.
enum	{ SEPARATOR = '/' }
enum	Status { IID_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...
	SUCCESS = 1
	Normal successful completion.
	NO_INTERFACE
	Requested interface is not available.
	VERSMISMATCH
	Requested interface version is incompatible.
	LAST_ERROR
	Last error.
Public Member Functions
virtual StatusCode	create (const CLID &typ, const std::string &title, NTuple::Tuple *&refpTuple)=0
	Create requested N tuple (Hide constructor).
virtual NTuple::Tuple *	book (const std::string &fullPath, const CLID &type, const std::string &title)=0
	Book Ntuple and register it with the data store.
virtual NTuple::Tuple *	book (const std::string &dirPath, const std::string &relPath, const CLID &type, const std::string &title)=0
	Book Ntuple and register it with the data store.
virtual NTuple::Tuple *	book (const std::string &dirPath, long id, const CLID &type, const std::string &title)=0
	Book Ntuple and register it with the data store.
virtual NTuple::Tuple *	book (DataObject *pParent, const std::string &relPath, const CLID &type, const std::string &title)=0
	Book Ntuple and register it with the data store.
virtual NTuple::Tuple *	book (DataObject *pParent, long id, const CLID &type, const std::string &title)=0
	Book Ntuple and register it with the data store.
virtual NTuple::Directory *	createDirectory (DataObject *pParent, const std::string &title)=0
	Create Ntuple directory and register it with the data store.
virtual NTuple::Directory *	createDirectory (DataObject *pParent, long id)=0
	Create Ntuple directory and register it with the data store.
virtual NTuple::Directory *	createDirectory (const std::string &dirPath, long id)=0
	Create Ntuple directory and register it with the data store.
virtual NTuple::Directory *	createDirectory (const std::string &dirPath, const std::string &title)=0
	Create Ntuple directory and register it with the data store.
virtual NTuple::Directory *	createDirectory (const std::string &fullPath)=0
	Create Ntuple directory and register it with the data store.
virtual NTuple::Tuple *	access (const std::string &fullPath, const std::string &filename)=0
	Access N tuple on disk.
virtual StatusCode	save (const std::string &fullPath)=0
	Save N tuple to disk.
virtual StatusCode	save (NTuple::Tuple *tuple)=0
	Save N tuple to disk.
virtual StatusCode	save (DataObject *pParent, const std::string &relPath)=0
	Save N tuple to disk.
virtual StatusCode	writeRecord (NTuple::Tuple *tuple)=0
	Write single record to N tuple.
virtual StatusCode	writeRecord (const std::string &fullPath)=0
	Write single record to N tuple.
virtual StatusCode	writeRecord (DataObject *pParent, const std::string &relPath)=0
	Write single record to N tuple.
virtual StatusCode	readRecord (NTuple::Tuple *tuple)=0
	Read single record from N tuple.
virtual StatusCode	readRecord (const std::string &fullPath)=0
	Read single record from N tuple.
virtual StatusCode	readRecord (DataObject *pParent, const std::string &relPath)=0
	Read single record from N tuple.
virtual StatusCode	registerObject (const std::string &fullPath, DataObject *pObject)=0
	Register object with the data store.
virtual StatusCode	registerObject (const std::string &parentPath, const std::string &objectPath, DataObject *pObject)=0
	Register object with the data store.
virtual StatusCode	registerObject (const std::string &parentPath, int item, DataObject *pObject)=0
	Register object with the data store.
virtual StatusCode	registerObject (DataObject parentObj, const std::string &objectPath, DataObject pObject)=0
	Register object with the data store.
virtual StatusCode	registerObject (DataObject parentObj, int item, DataObject pObject)=0
	Register object with the data store.
virtual StatusCode	unregisterObject (const std::string &fullPath)=0
	Unregister object from the data store.
virtual StatusCode	unregisterObject (const std::string &parentPath, const std::string &objPath)=0
	Unregister object from the data store.
virtual StatusCode	unregisterObject (const std::string &parentPath, int item)=0
	Unregister object from the data store.
virtual StatusCode	unregisterObject (DataObject *pObject)=0
	Unregister object from the data store.
virtual StatusCode	unregisterObject (DataObject *pParent, const std::string &objPath)=0
	Unregister object from the data store.
virtual StatusCode	unregisterObject (DataObject *pParent, int item)=0
	Unregister object from the data store.
virtual StatusCode	retrieveObject (IRegistry pDirectory, const std::string &path, DataObject &pObject)=0
	Retrieve object identified by its directory entry.
virtual StatusCode	retrieveObject (const std::string &fullPath, DataObject *&pObject)=0
	Retrieve object identified by its full path from the data store.
virtual StatusCode	retrieveObject (const std::string &parentPath, const std::string &objectPath, DataObject *&pObject)=0
	Retrieve object from data store.
virtual StatusCode	retrieveObject (const std::string &parentPath, int item, DataObject *&pObject)=0
	Retrieve object from data store.
virtual StatusCode	retrieveObject (DataObject parentObj, const std::string &objectPath, DataObject &pObject)=0
	Retrieve object from data store.
virtual StatusCode	retrieveObject (DataObject parentObj, int item, DataObject &pObject)=0
	Retrieve object from data store.
virtual StatusCode	findObject (IRegistry pDirectory, const std::string &path, DataObject &pObject)=0
	Find object identified by its directory entry.
virtual StatusCode	findObject (const std::string &fullPath, DataObject *&pObject)=0
	Find object identified by its full path in the data store.
virtual StatusCode	findObject (const std::string &parentPath, const std::string &objectPath, DataObject *&pObject)=0
	Find object identified by its parent object and the path to the object relative to the parent.
virtual StatusCode	findObject (const std::string &parentPath, int item, DataObject *&pObject)=0
	Find object identified by its parent object and an integer identifier in the data store.
virtual StatusCode	findObject (DataObject pNode, const std::string &objectPath, DataObject &pObject)=0
	Find object identified by its parent object and the path to the object relative to the parent.
virtual StatusCode	findObject (DataObject parentObj, int item, DataObject &pObject)=0
	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.
virtual StatusCode	updateObject (const std::string &fullPath)=0
	Update object identified by its full path in the data store.
virtual StatusCode	updateObject (DataObject *toUpdate)=0
	Update object identified by its pointer.
virtual StatusCode	updateObject (const std::string &parentPath, const std::string &updatePath)=0
	Update object identified by its parent's path and the path relative to the parent.
virtual StatusCode	updateObject (DataObject *pParent, const std::string &updatePath)=0
	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.
virtual StatusCode	addPreLoadItem (const std::string &itemPath)=0
	Add an item to the preload list.
virtual StatusCode	removePreLoadItem (const DataStoreItem &item)=0
	Remove an item from the preload list.
virtual StatusCode	removePreLoadItem (const std::string &itemPath)=0
	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, const std::string &objPath, DataObject toObj)=0
	Add a link to another object.
virtual StatusCode	linkObject (const std::string &fromPath, const std::string &objPath, DataObject *toObj)=0
	Add a link to another object.
virtual StatusCode	linkObject (DataObject fromObj, const std::string &objPath, DataObject toObj)=0
	Add a link to another object.
virtual StatusCode	linkObject (const std::string &fullPath, DataObject *toObj)=0
	Add a link to another object.
virtual StatusCode	unlinkObject (IRegistry *from, const std::string &objPath)=0
	Remove a link to another object.
virtual StatusCode	unlinkObject (const std::string &fromPath, const std::string &objPath)=0
	Remove a link to another object.
virtual StatusCode	unlinkObject (DataObject *fromObj, const std::string &objPath)=0
	Remove a link to another object.
virtual StatusCode	unlinkObject (const std::string &fullPath)=0
	Remove a link to another object.
virtual StatusCode	queryInterface (const InterfaceID &riid, void **ppvInterface)=0
	Query interfaces of Interface.
virtual unsigned long	addRef ()=0
	Increment the reference count of Interface instance.
virtual unsigned long	release ()=0
	Release Interface instance.
Static Public Member Functions
static const InterfaceID &	interfaceID ()
	Retrieve interface ID.

Detailed Description

The ntuple service interface allows to:

Export the data provider's functionality.
Extend the functionality in order to book abstract N tuples:
- Book COLUMN WISE N tuples.
- Book ROW WISE N tuples.
- Access a persistent N tuple within a file
- Save the N tuple after filling.
- Write individual records from to a N tuple.
- Read individual records from an existing N tuple.
created N tuples are automatically put onto the N tuple data store.

Author:: Markus Frank

Version:: 1.0

Definition at line 41 of file INTupleSvc.h.

Member Enumeration Documentation

anonymous enum [inherited]

Enumerator:

SEPARATOR

Definition at line 55 of file IDataProviderSvc.h.

00055 { SEPARATOR = '/' };

enum IDataProviderSvc::Status [inherited]

Status code definitions.

Enumerator:

IID_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 availible.
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.

Reimplemented from IInterface.

Definition at line 534 of file IDataProviderSvc.h.

00534                {
00536     IID_IDataProviderSvc_NO_ERROR = 1,
00538     DOUBL_OBJ_PATH,
00540     INVALID_OBJ_PATH,
00542     INVALID_ROOT,
00544     INVALID_OBJECT,
00546     INVALID_PARENT,
00548     OBJ_NOT_LOADED,
00550     NO_DATA_LOADER,
00552     INVALID_OBJ_ADDR,
00554     DIR_NOT_EMPTY,
00556     NO_MORE_LEVELS,
00558     NO_ACCESS,
00560     LAST
00561   };

Member Function Documentation

static const InterfaceID& INTupleSvc::interfaceID ( ) [inline, static]

Retrieve interface ID.

Reimplemented from IDataProviderSvc.

Definition at line 44 of file INTupleSvc.h.

00044 { return IID_INTupleSvc; }

virtual StatusCode INTupleSvc::create	(	const CLID &	typ,
		const std::string &	title,
		NTuple::Tuple *&	refpTuple
	)			`[pure virtual]`

Create requested N tuple (Hide constructor).

virtual NTuple::Tuple* INTupleSvc::book	(	const std::string &	fullPath,
		const CLID &	type,
		const std::string &	title
	)			`[pure virtual]`

Book Ntuple and register it with the data store.

Connects the object identified by its full path to the parent object identified by the base name of the full path.

Parameters:

	fullPath	Full path to the node of the object.
	type	Class ID of the N tuple: Column or row wise.
	title	Title property of the N tuple.
	refpTuple	Reference to pointer to the N tuple to be booled and registered.

Returns:: Status code indicating success or failure.

virtual NTuple::Tuple* INTupleSvc::book	(	const std::string &	dirPath,
		const std::string &	relPath,
		const CLID &	type,
		const std::string &	title
	)			`[pure virtual]`

Book Ntuple and register it with the data store.

Connects the object identified by its relative path to the parent object identified by the base name.

Parameters:

	dirPath	Path to parent node of the object.
	relPath	Relative path to the object with respect to the parent node. The relative path is the identifier of the tuple.
	title	Title property of the N tuple.
	type	Class ID of the N tuple: Column or row wise.
	refpTuple	Reference to pointer to the N tuple to be booled and registered.

Returns:: Status code indicating success or failure.

virtual NTuple::Tuple* INTupleSvc::book	(	const std::string &	dirPath,
		long	id,
		const CLID &	type,
		const std::string &	title
	)			`[pure virtual]`

Book Ntuple and register it with the data store.

Connects the object identified by an identifier to the parent object identified by the base name.

Parameters:

	dirPath	Path to parent node of the object.
	id	Identifier of the tuple within the parent's directory.
	type	Class ID of the N tuple: Column or row wise.
	title	Title property of the N tuple.
	refpTuple	Reference to pointer to the N tuple to be booled and registered.

Returns:: Status code indicating success or failure.

virtual NTuple::Tuple* INTupleSvc::book	(	DataObject *	pParent,
		const std::string &	relPath,
		const CLID &	type,
		const std::string &	title
	)			`[pure virtual]`

Book Ntuple and register it with the data store.

Connects the object identified by an identifier (id) to the parent object identified by the parent's pointer.

Parameters:

	pParent	Pointer to parent object.
	relPath	Relative path to the object with respect to the parent node. The relative path is the identifier of the tuple.
	type	Class ID of the N tuple: Column or row wise.
	title	Title property of the N tuple.
	refpTuple	Reference to pointer to the N tuple to be booled and registered.

Returns:: Status code indicating success or failure.

virtual NTuple::Tuple* INTupleSvc::book	(	DataObject *	pParent,
		long	id,
		const CLID &	type,
		const std::string &	title
	)			`[pure virtual]`

Book Ntuple and register it with the data store.

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

Parameters:

	pParent	Pointer to parent object.
	id	Identifier of the tuple within the parent's directory.
	type	Class ID of the N tuple: Column or row wise.
	title	Title property of the N tuple.

Returns:: Status code indicating success or failure.

virtual NTuple::Directory* INTupleSvc::createDirectory	(	DataObject *	pParent,
		const std::string &	title
	)			`[pure virtual]`

Create Ntuple directory and register it with the data store.

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

Parameters:

	pParent	Pointer to parent object.
	title	Directory identifier.

Returns:: Status code indicating success or failure.

virtual NTuple::Directory* INTupleSvc::createDirectory	(	DataObject *	pParent,
		long	id
	)			`[pure virtual]`

Create Ntuple directory and register it with the data store.

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

Parameters:

	pParent	Pointer to parent object.
	id	Identifier of the tuple within the parent's directory.

Returns:: Status code indicating success or failure.

virtual NTuple::Directory* INTupleSvc::createDirectory	(	const std::string &	dirPath,
		long	id
	)			`[pure virtual]`

Create Ntuple directory and register it with the data store.

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

Parameters:

	dirPath	Full directory path to parent
	id	Identifier of the tuple within the parent's directory.

Returns:: Status code indicating success or failure.

virtual NTuple::Directory* INTupleSvc::createDirectory	(	const std::string &	dirPath,
		const std::string &	title
	)			`[pure virtual]`

Create Ntuple directory and register it with the data store.

Connects the object identified by its path to the parent object identified by the parent's path.

Parameters:

	dirPath	Full directory path to parent
	title	Directory identifier.

Returns:: Status code indicating success or failure.

virtual NTuple::Directory* INTupleSvc::createDirectory ( const std::string & fullPath ) [pure virtual]

Create Ntuple directory and register it with the data store.

Parameters:

fullPath

Full directory path

Returns:: Status code indicating success or failure.

virtual NTuple::Tuple* INTupleSvc::access	(	const std::string &	fullPath,
		const std::string &	filename
	)			`[pure virtual]`

Access N tuple on disk.

Parameters:

	fullPath	Full path to the N tuple within the transient store
	filename	Name of the file the ntuple resides in.

Returns:: Status code indicating success or failure.

virtual StatusCode INTupleSvc::save ( const std::string & fullPath ) [pure virtual]

Save N tuple to disk.

Must be called in order to close the ntuple file properly

Parameters:

fullPath

Full path to the N tuple in memory.

Returns:: Status code indicating success or failure.

virtual StatusCode INTupleSvc::save ( NTuple::Tuple * tuple ) [pure virtual]

Save N tuple to disk.

Must be called in order to close the ntuple file properly

Parameters:

tuple

Pointer to the Ntuple in memory

Returns:: Status code indicating success or failure.

virtual StatusCode INTupleSvc::save	(	DataObject *	pParent,
		const std::string &	relPath
	)			`[pure virtual]`

Save N tuple to disk.

Must be called in order to close the ntuple file properly

Parameters:

	pParent	Parent object of the N tuple
	relPath	Relative path to the N tuple in memory with respect to the parent object.

Returns:: Status code indicating success or failure.

virtual StatusCode INTupleSvc::writeRecord ( NTuple::Tuple * tuple ) [pure virtual]

Write single record to N tuple.

Parameters:

tuple

Pointer to the Ntuple in memory

Returns:: Status code indicating success or failure.

virtual StatusCode INTupleSvc::writeRecord ( const std::string & fullPath ) [pure virtual]

Write single record to N tuple.

Parameters:

fullPath

Full path to the N tuple in memory.

Returns:: Status code indicating success or failure.

virtual StatusCode INTupleSvc::writeRecord	(	DataObject *	pParent,
		const std::string &	relPath
	)			`[pure virtual]`

Write single record to N tuple.

Parameters:

	pParent	Parent object of the N tuple
	relPath	Relative path to the N tuple in memory with respect to the parent object.

Returns:: Status code indicating success or failure.

virtual StatusCode INTupleSvc::readRecord ( NTuple::Tuple * tuple ) [pure virtual]

Read single record from N tuple.

Parameters:

tuple

Pointer to the Ntuple in memory

Returns:: Status code indicating success or failure.

virtual StatusCode INTupleSvc::readRecord ( const std::string & fullPath ) [pure virtual]

Read single record from N tuple.

Parameters:

fullPath

Full path to the N tuple in memory.

Returns:: Status code indicating success or failure.

virtual StatusCode INTupleSvc::readRecord	(	DataObject *	pParent,
		const std::string &	relPath
	)			`[pure virtual]`

Read single record from N tuple.

Parameters:

	pParent	Parent object of the N tuple
	relPath	Relative path to the N tuple in memory with respect to the parent object.

Returns:: Status code indicating success or failure.

virtual StatusCode IDataProviderSvc::registerObject	(	const std::string &	fullPath,
		DataObject *	pObject
	)			`[pure virtual, inherited]`

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.

Implemented in DataSvc, and IHistogramSvc.

virtual StatusCode IDataProviderSvc::registerObject	(	const std::string &	parentPath,
		const std::string &	objectPath,
		DataObject *	pObject
	)			`[pure virtual, inherited]`

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.

Implemented in DataSvc, and IHistogramSvc.

virtual StatusCode IDataProviderSvc::registerObject	(	const std::string &	parentPath,
		int	item,
		DataObject *	pObject
	)			`[pure virtual, inherited]`

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.

Implemented in DataSvc, and IHistogramSvc.

virtual StatusCode IDataProviderSvc::registerObject	(	DataObject *	parentObj,
		const std::string &	objectPath,
		DataObject *	pObject
	)			`[pure virtual, inherited]`

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.

Implemented in DataSvc, and IHistogramSvc.

virtual StatusCode IDataProviderSvc::registerObject	(	DataObject *	parentObj,
		int	item,
		DataObject *	pObject
	)			`[pure virtual, inherited]`

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.

Implemented in DataSvc, and IHistogramSvc.

virtual StatusCode IDataProviderSvc::unregisterObject ( const std::string & fullPath ) [pure virtual, inherited]

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.

Implemented in DataSvc, and IHistogramSvc.

virtual StatusCode IDataProviderSvc::unregisterObject	(	const std::string &	parentPath,
		const std::string &	objPath
	)			`[pure virtual, inherited]`

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.

Implemented in DataSvc, and IHistogramSvc.

virtual StatusCode IDataProviderSvc::unregisterObject	(	const std::string &	parentPath,
		int	item
	)			`[pure virtual, inherited]`

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.

Implemented in DataSvc, and IHistogramSvc.

virtual StatusCode IDataProviderSvc::unregisterObject ( DataObject * pObject ) [pure virtual, inherited]

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.

Implemented in DataSvc, and IHistogramSvc.

virtual StatusCode IDataProviderSvc::unregisterObject	(	DataObject *	pParent,
		const std::string &	objPath
	)			`[pure virtual, inherited]`

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.

Implemented in DataSvc, and IHistogramSvc.

virtual StatusCode IDataProviderSvc::unregisterObject	(	DataObject *	pParent,
		int	item
	)			`[pure virtual, inherited]`

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.

Implemented in DataSvc, and IHistogramSvc.

virtual StatusCode IDataProviderSvc::retrieveObject	(	IRegistry *	pDirectory,
		const std::string &	path,
		DataObject *&	pObject
	)			`[pure virtual, inherited]`

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.

Implemented in DataSvc, and IHistogramSvc.

virtual StatusCode IDataProviderSvc::retrieveObject	(	const std::string &	fullPath,
		DataObject *&	pObject
	)			`[pure virtual, inherited]`

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.

Implemented in DataSvc, and IHistogramSvc.

virtual StatusCode IDataProviderSvc::retrieveObject	(	const std::string &	parentPath,
		const std::string &	objectPath,
		DataObject *&	pObject
	)			`[pure virtual, inherited]`

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.

Implemented in DataSvc, and IHistogramSvc.

virtual StatusCode IDataProviderSvc::retrieveObject	(	const std::string &	parentPath,
		int	item,
		DataObject *&	pObject
	)			`[pure virtual, inherited]`

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.

Implemented in DataSvc, and IHistogramSvc.

virtual StatusCode IDataProviderSvc::retrieveObject	(	DataObject *	parentObj,
		const std::string &	objectPath,
		DataObject *&	pObject
	)			`[pure virtual, inherited]`

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.

Implemented in DataSvc, and IHistogramSvc.

virtual StatusCode IDataProviderSvc::retrieveObject	(	DataObject *	parentObj,
		int	item,
		DataObject *&	pObject
	)			`[pure virtual, inherited]`

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.

Implemented in DataSvc, and IHistogramSvc.

virtual StatusCode IDataProviderSvc::findObject	(	IRegistry *	pDirectory,
		const std::string &	path,
		DataObject *&	pObject
	)			`[pure virtual, inherited]`

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.

Implemented in DataSvc, and IHistogramSvc.

virtual StatusCode IDataProviderSvc::findObject	(	const std::string &	fullPath,
		DataObject *&	pObject
	)			`[pure virtual, inherited]`

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.

Implemented in DataSvc, and IHistogramSvc.

virtual StatusCode IDataProviderSvc::findObject	(	const std::string &	parentPath,
		const std::string &	objectPath,
		DataObject *&	pObject
	)			`[pure virtual, inherited]`

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.

Implemented in DataSvc, and IHistogramSvc.

virtual StatusCode IDataProviderSvc::findObject	(	const std::string &	parentPath,
		int	item,
		DataObject *&	pObject
	)			`[pure virtual, inherited]`

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.

Implemented in DataSvc, and IHistogramSvc.

virtual StatusCode IDataProviderSvc::findObject	(	DataObject *	pNode,
		const std::string &	objectPath,
		DataObject *&	pObject
	)			`[pure virtual, inherited]`

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.

Implemented in DataSvc, and IHistogramSvc.

virtual StatusCode IDataProviderSvc::findObject	(	DataObject *	parentObj,
		int	item,
		DataObject *&	pObject
	)			`[pure virtual, inherited]`

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.

Implemented in DataSvc, and IHistogramSvc.

virtual StatusCode IDataProviderSvc::updateObject ( IRegistry * pDirectory ) [pure virtual, inherited]

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.

Implemented in DataSvc.

virtual StatusCode IDataProviderSvc::updateObject ( const std::string & fullPath ) [pure virtual, inherited]

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.

Implemented in DataSvc.

virtual StatusCode IDataProviderSvc::updateObject ( DataObject * toUpdate ) [pure virtual, inherited]

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.

Implemented in DataSvc.

virtual StatusCode IDataProviderSvc::updateObject	(	const std::string &	parentPath,
		const std::string &	updatePath
	)			`[pure virtual, inherited]`

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.

Implemented in DataSvc.

virtual StatusCode IDataProviderSvc::updateObject	(	DataObject *	pParent,
		const std::string &	updatePath
	)			`[pure virtual, inherited]`

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.

Implemented in DataSvc.

virtual StatusCode IDataProviderSvc::addPreLoadItem ( const DataStoreItem & item ) [pure virtual, inherited]

Add an item to the preload list.

Parameters:

item

Specs of item to be preloaded

Returns:: Status code indicating success or failure.

Implemented in DataSvc.

virtual StatusCode IDataProviderSvc::addPreLoadItem ( const std::string & itemPath ) [pure virtual, inherited]

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.

Implemented in DataSvc.

virtual StatusCode IDataProviderSvc::removePreLoadItem ( const DataStoreItem & item ) [pure virtual, inherited]

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.

Implemented in DataSvc.

virtual StatusCode IDataProviderSvc::removePreLoadItem ( const std::string & itemPath ) [pure virtual, inherited]

Remove an item from the preload list.

Parameters:

itemPath

Path to the item to be preloaded.

Returns:: Status code indicating success or failure.

Implemented in DataSvc.

virtual StatusCode IDataProviderSvc::resetPreLoad ( ) [pure virtual, inherited]

Clear the preload list.

Returns:: Status code indicating success or failure.

Implemented in DataSvc.

virtual StatusCode IDataProviderSvc::preLoad ( ) [pure virtual, inherited]

Load all preload items of the list.

Returns:: Status code indicating success or failure.

Implemented in DataSvc.

virtual StatusCode IDataProviderSvc::linkObject	(	IRegistry *	from,
		const std::string &	objPath,
		DataObject *	toObj
	)			`[pure virtual, inherited]`

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.

Implemented in DataSvc.

virtual StatusCode IDataProviderSvc::linkObject	(	const std::string &	fromPath,
		const std::string &	objPath,
		DataObject *	toObj
	)			`[pure virtual, inherited]`

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.

Implemented in DataSvc.

virtual StatusCode IDataProviderSvc::linkObject	(	DataObject *	fromObj,
		const std::string &	objPath,
		DataObject *	toObj
	)			`[pure virtual, inherited]`

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.

Implemented in DataSvc.

virtual StatusCode IDataProviderSvc::linkObject	(	const std::string &	fullPath,
		DataObject *	toObj
	)			`[pure virtual, inherited]`

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.

Implemented in DataSvc.

virtual StatusCode IDataProviderSvc::unlinkObject	(	IRegistry *	from,
		const std::string &	objPath
	)			`[pure virtual, inherited]`

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.

Implemented in DataSvc.

virtual StatusCode IDataProviderSvc::unlinkObject	(	const std::string &	fromPath,
		const std::string &	objPath
	)			`[pure virtual, inherited]`

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.

Implemented in DataSvc.

virtual StatusCode IDataProviderSvc::unlinkObject	(	DataObject *	fromObj,
		const std::string &	objPath
	)			`[pure virtual, inherited]`

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.

Implemented in DataSvc.

virtual StatusCode IDataProviderSvc::unlinkObject ( const std::string & fullPath ) [pure virtual, inherited]

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.

Implemented in DataSvc.

virtual StatusCode IInterface::queryInterface	(	const InterfaceID &	riid,
		void **	ppvInterface
	)			`[pure virtual, inherited]`

Query interfaces of Interface.

Parameters:

	riid	ID of Interface to be retrieved
	ppvInterface	Pointer to Location for interface pointer

Implemented in Algorithm, AlgTool, Auditor, ConversionSvc, Converter, DataSvc, EventSelectorDataStream, MinimalEventLoopMgr, PropertyMgr, SelectStatement, and Service.

virtual unsigned long IInterface::addRef ( ) [pure virtual, inherited]

Increment the reference count of Interface instance.

Implemented in Algorithm, AlgTool, Auditor, Converter, EventSelectorDataStream, IFactory, PropertyMgr, SelectStatement, and Service.

virtual unsigned long IInterface::release ( ) [pure virtual, inherited]

Release Interface instance.

Implemented in Algorithm, AlgTool, Auditor, Converter, EventSelectorDataStream, IFactory, PropertyMgr, SelectStatement, and Service.

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

/home/dayabay/installs/trunk_2011_04_11_opt/NuWa-trunk/gaudi/GaudiKernel/GaudiKernel/INTupleSvc.h

Generated on Mon Apr 11 19:57:10 2011 for GaudiKernel by 1.4.7

In This Package:

INTupleSvc Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation