IDataManagerSvc

class IDataManagerSvc : public IInterface

IDataManagerSvc interface definition

Inheritance:

Public

Interface calls

virtual StatusCode clearSubTree( const string& sub_tree_path ) throw(exception): Remove all data objects below the sub tree identified by its full path name
virtual StatusCode clearSubTree( IDataObject* pObject ) throw(exception): Remove all data objects below the sub tree identified by the object
virtual StatusCode clearStore() throw(exception): Remove all data objects in the data store
virtual StatusCode setRoot( IDataObject* pRootObj, const string& top_path) throw(exception): Initialize data store for new event by giving new event path
virtual StatusCode setDataLoader( IPersistencySvc* svc ) throw(exception): Pass a default data loader to the service

Interface Specific stuff

enum Status

Status code definitions

NO_ERROR: Success
INVALID_OBJ_PATH: Invalid path from root to object request failed.
INVALID_ROOT: Invalid root path object cannot be retrieved or stored.

Documentation

IDataManagerSvc interface definition.
System: The LHCb Offline System
Package: DataProviderSvc
The data manager interface of the service allows to:

Discard sub-trees or the entire data stored.
Initialize the top level root used for navigation.
Dependencies:

STL exception mechanism: "std/exception"
Generic return code class: "Kernel/StatusCode.h"
Experiment Kernel definitions: "Kernel/Kernel.h"
Generic Interface definition: "Kernel/IInterface.h"
History:
+---------+----------------------------------------------+---------+
|    Date |                 Comment                      | Who     |
+---------+----------------------------------------------+---------+
| 3/11/98 | Initial version                              | M.Frank |
+---------+----------------------------------------------+---------+

Interface calls

virtual StatusCode clearSubTree( const string& sub_tree_path ) throw(exception)
Remove all data objects below the sub tree identified by its full path name
Throws:
exception (Standard STL) on occurence of fatal errors.
Returns:
Status code indicating success or failure.
Parameters:
sub_tree_path - Path to sub-tree node.

virtual StatusCode clearSubTree( IDataObject* pObject ) throw(exception)
Remove all data objects below the sub tree identified by the object. The object itself is removed as well.
Throws:
exception (Standard STL) on occurence of fatal errors.
Returns:
Status code indicating success or failure
Parameters:
pObject - Pointer to object

virtual StatusCode clearStore() throw(exception)
Remove all data objects in the data store
Throws:
exception (Standard STL) on occurence of fatal errors.
Returns:
Status code indicating success or failure

virtual StatusCode setRoot( IDataObject* pRootObj, const string& top_path) throw(exception)
Initialize data store for new event by giving new event path. Implicitly this clears the entire data store.
Throws:
exception (Standard STL) on occurence of fatal errors.
Returns:
Status code indicating success or failure
Parameters:
pRootObject - Pointer to root node object
top_path - top level path name

virtual StatusCode setDataLoader( IPersistencySvc* svc ) throw(exception)
Pass a default data loader to the service. This service will be asked to load non existant data items.
Throws:
exception (Standard STL) on occurence of fatal errors.
Returns:
Status code indicating success or failure
Parameters:
svc - pointer to persistency service instance
Interface Specific stuff enum Status Status code definitions NO_ERROR Success INVALID_OBJ_PATH Invalid path from root to object request failed. INVALID_ROOT Invalid root path object cannot be retrieved or stored.

This class has no child classes.

Author:: Markus Frank
Version:: 1.0

The New Software