IDataManagerSvc.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2019 CERN for the benefit of the LHCb and ATLAS collaborations *
*                                                                                   *
* This software is distributed under the terms of the Apache version 2 licence,     *
* copied verbatim in the file "LICENSE".                                            *
*                                                                                   *
* In applying this licence, CERN does not waive the privileges and immunities       *
* granted to it by virtue of its status as an Intergovernmental Organization        *
* or submit itself to any jurisdiction.                                             *
\***********************************************************************************/
#ifndef GAUDIKERNEL_IDATAMANAGERSVC_H
#define GAUDIKERNEL_IDATAMANAGERSVC_H

// Include files
#include "GaudiKernel/ClassID.h"
#include "GaudiKernel/IDataStoreAgent.h"
#include "GaudiKernel/IInterface.h"
#include <string>
#include <string_view>
#include <vector>

// Forward declarations
// Generic interface to data object class
#include "GaudiKernel/DataObject.h"
// Interface to persistency service
class IConversionSvc;
// Opaque addresses
class IOpaqueAddress;
// Registry entry definition
class IRegistry;
// Data provider svc
class IDataProviderSvc;

struct GAUDI_API IDataManagerSvc : extend_interfaces<IInterface> {
  DeclareInterfaceID( IDataManagerSvc, 4, 0 );

  virtual CLID rootCLID() const = 0;

  virtual const std::string& rootName() const = 0;

  virtual StatusCode setDataLoader( IConversionSvc* svc, IDataProviderSvc* dpsvc = nullptr ) = 0;

  virtual StatusCode objectParent( const DataObject* pObject, IRegistry*& refpParent ) = 0;

  virtual StatusCode objectParent( const IRegistry* pRegistry, IRegistry*& refpParent ) = 0;

  virtual StatusCode objectLeaves( const DataObject* pObject, std::vector<IRegistry*>& refLeaves ) = 0;

  virtual StatusCode objectLeaves( const IRegistry* pRegistry, std::vector<IRegistry*>& refLeaves ) = 0;

  virtual StatusCode clearSubTree( std::string_view sub_path ) = 0;

  virtual StatusCode clearSubTree( DataObject* pObject ) = 0;

  virtual StatusCode clearStore() = 0;

  virtual StatusCode traverseSubTree( std::string_view sub_tree_path, IDataStoreAgent* pAgent ) = 0;

  template <typename F, typename = std::enable_if_t<!std::is_convertible_v<F, IDataStoreAgent*>>>
  StatusCode traverseSubTree( std::string_view sub_path, F&& f ) {
    auto agent = makeDataStoreAgent( std::forward<F>( f ) );
    return traverseSubTree( sub_path, &agent );
  }

  virtual StatusCode traverseSubTree( DataObject* pObject, IDataStoreAgent* pAgent ) = 0;

  template <typename F, typename = std::enable_if_t<!std::is_convertible_v<F, IDataStoreAgent*>>>
  StatusCode traverseSubTree( DataObject* pObject, F&& f ) {
    auto agent = makeDataStoreAgent( std::forward<F>( f ) );
    return traverseSubTree( pObject, &agent );
  }

  virtual StatusCode traverseTree( IDataStoreAgent* pAgent ) = 0;

  template <typename F, typename = std::enable_if_t<!std::is_convertible_v<F, IDataStoreAgent*>>>
  StatusCode traverseTree( F&& f ) {
    auto agent = makeDataStoreAgent( std::forward<F>( f ) );
    return traverseTree( &agent );
  }

  virtual StatusCode setRoot( std::string root_name, DataObject* pObject ) = 0;

  virtual StatusCode setRoot( std::string root_path, IOpaqueAddress* pRootAddr ) = 0;

  virtual StatusCode registerAddress( std::string_view fullPath, IOpaqueAddress* pAddress ) = 0;

  StatusCode registerAddress( DataObject* parentObj, std::string_view objectPath, IOpaqueAddress* pAddress ) {
    return registerAddress( parentObj ? parentObj->registry() : nullptr, objectPath, pAddress );
  }

  virtual StatusCode registerAddress( IRegistry* parentObj, std::string_view objectPath, IOpaqueAddress* pAddress ) = 0;

  virtual StatusCode unregisterAddress( std::string_view fullPath ) = 0;

  StatusCode unregisterAddress( DataObject* pParent, std::string_view objPath ) {
    return unregisterAddress( pParent ? pParent->registry() : nullptr, objPath );
  }

  virtual StatusCode unregisterAddress( IRegistry* pParent, std::string_view objPath ) = 0;
};

#endif // GAUDIKERNEL_IDATAMANAGERSVC_H