---

IDataManagerSvc Class Reference

The data manager interface of the service allows to:

• Discard sub-trees or the entire data stored. More...

  #include <GaudiKernel/IDataManagerSvc.h>

  Inheritance diagram for IDataManagerSvc:

  List of all members.

  Public Types
  enum	Status { IID_IDataManagerSvc_NO_ERROR = IInterface::SUCCESS }
  	Status code definitions. More...
  Public Methods
  virtual StatusCode	clearSubTree ( const std::string& sub_tree_path ) = 0
  	Remove all data objects below the sub tree identified by its full path name. More...
  virtual StatusCode	clearSubTree ( DataObject* pObject ) = 0
  	Remove all data objects below the sub tree identified by the object. More...
  virtual StatusCode	clearStore () = 0
  	Remove all data objects in the data store. More...
  virtual StatusCode	traverseSubTree ( const std::string& sub_tree_path,IDataStoreAgent* pAgent ) = 0
  	Analyse by traversing all data objects below the sub tree identified by its full path name. More...
  virtual StatusCode	traverseSubTree ( DataObject* pObject,IDataStoreAgent* pAgent ) = 0
  	Analyse by traversing all data objects below the sub tree identified by the object. More...
  virtual StatusCode	traverseTree (IDataStoreAgent* pAgent) = 0
  	Analyse by traversing all data objects in the data store. More...
  virtual StatusCode	setRoot (const std::string& root_name, DataObject* pRootObj ) = 0
  	Initialize data store for new event by giving new event path. More...
  virtual StatusCode	setRoot (const std::string& root_path, IOpaqueAddress* pRootAddr) = 0
  	Initialize data store for new event by giving new event path. More...
  virtual CLID	rootEventCLID () const = 0
  virtual std::string	rootEventName () const = 0
  virtual StatusCode	setDataLoader ( IConversionSvc* svc ) = 0
  	Pass a default data loader to the service. More...
  Static Public Methods
  const InterfaceID&	interfaceID ()
  	Retrieve interface ID. More...

  ---

  Detailed Description

  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.

    Author(s):

    Markus Frank

    Version:

    1.0

    Definition at line 35 of file IDataManagerSvc.h.

    ---

    Member Enumeration Documentation

    enum IDataManagerSvc::Status

    Status code definitions. Enumeration values: IID_IDataManagerSvc_NO_ERROR   Success. Reimplemented from IInterface. Definition at line 106 of file IDataManagerSvc.h.

    ---

    Member Function Documentation

    StatusCode IDataManagerSvc::clearStore ( ) [pure virtual]

    Remove all data objects in the data store. Returns: Status code indicating success or failure Reimplemented in DataSvc.

    StatusCode IDataManagerSvc::clearSubTree ( DataObject * pObject ) [pure virtual]

    Remove all data objects below the sub tree identified by the object. The object itself is removed as well. Parameters: pObject   Pointer to object Returns: Status code indicating success or failure Reimplemented in DataSvc.

    StatusCode IDataManagerSvc::clearSubTree ( const std::string & sub_tree_path ) [pure virtual]

    Remove all data objects below the sub tree identified by its full path name. Parameters: sub_tree_path   Path to sub-tree node. Returns: Status code indicating success or failure. Reimplemented in DataSvc.

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

    Retrieve interface ID. Reimplemented from IInterface. Definition at line 38 of file IDataManagerSvc.h.

    virtual CLID IDataManagerSvc::rootEventCLID ( ) const [pure virtual]

    Reimplemented in DataSvc.

    virtual std::string IDataManagerSvc::rootEventName ( ) const [pure virtual]

    Reimplemented in DataSvc.

    StatusCode IDataManagerSvc::setDataLoader ( IConversionSvc * pDataLoader ) [pure virtual]

    Pass a default data loader to the service. This service will be asked to load non existant data items. Parameters: svc   pointer to persistency service instance Returns: Status code indicating success or failure Reimplemented in DataSvc.

    StatusCode IDataManagerSvc::setRoot ( const std::string & root_path, IOpaqueAddress * pRootAddr ) [pure virtual]

    Initialize data store for new event by giving new event path. Implicitly this clears the entire data store. Parameters: root_name   String containing root path name pRootAddr   Pointer to opaque root node address Returns: Status code indicating success or failure Reimplemented in DataSvc.

    StatusCode IDataManagerSvc::setRoot ( const std::string & root_path, DataObject * pRootObj ) [pure virtual]

    Initialize data store for new event by giving new event path. Implicitly this clears the entire data store. Parameters: root_name   String containing root path name pRootObject   Pointer to root node object Returns: Status code indicating success or failure Reimplemented in DataSvc.

    StatusCode IDataManagerSvc::traverseSubTree ( DataObject * pObject, IDataStoreAgent * pAgent ) [pure virtual]

    Analyse by traversing all data objects below the sub tree identified by the object. The object itself is removed as well. Parameters: pObject   Pointer to object Returns: Status code indicating success or failure Reimplemented in DataSvc.

    StatusCode IDataManagerSvc::traverseSubTree ( const std::string & sub_tree_path, IDataStoreAgent * pAgent ) [pure virtual]

    Analyse by traversing all data objects below the sub tree identified by its full path name. Parameters: sub_tree_path   Path to sub-tree node. Returns: Status code indicating success or failure. Reimplemented in DataSvc.

    StatusCode IDataManagerSvc::traverseTree ( IDataStoreAgent * pAgent ) [pure virtual]

    Analyse by traversing all data objects in the data store. Returns: Status code indicating success or failure Reimplemented in DataSvc.

    ---

    The documentation for this class was generated from the following file:
    • IDataManagerSvc.h

    ---