RegistryEntry.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2024 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_REGISTRYENTRY_H
#define GAUDIKERNEL_REGISTRYENTRY_H
 
// Framework include files
#include <GaudiKernel/IRegistry.h>
#include <GaudiKernel/Kernel.h>
#include <GaudiKernel/StatusCode.h>
 
// STL include files
#include <string_view>
#include <vector>
 
// Forward declarations
class DataSvc;
// DP add this fwd decl for thread safety
class TsDataSvc;
class DataObject;
class IDataProviderSvc;
class IOpaqueAddress;
class IDataStoreAgent;
 
namespace DataSvcHelpers {
  class GAUDI_API RegistryEntry final : public IRegistry {
  private:
    typedef std::vector<IRegistry*> Store;
 
  public:
    friend class ::DataSvc;
    // DP add friend class: the thread safe version of the DataSvc
    friend class ::TsDataSvc;
    typedef Store::const_iterator Iterator;
 
  private:
    unsigned long m_refCount = 0;
    bool m_isSoft = false;
    std::string m_fullpath;
    std::string m_path;
    RegistryEntry* m_pParent = nullptr;
    IOpaqueAddress* m_pAddress = nullptr;
    DataObject* m_pObject = nullptr;
    IDataProviderSvc* m_pDataProviderSvc = nullptr;
    Store m_store;
 
  private:
    void assemblePath( std::string& buffer ) const;
    IRegistry* i_find( const IRegistry* pDirectory ) const;
    RegistryEntry* i_find( std::string_view path ) const;
    RegistryEntry* i_find( const DataObject* pObject ) const;
    RegistryEntry* i_create( std::string name );
    long i_add( RegistryEntry* entry );
    void setParent( RegistryEntry* pParent );
    void setDataSvc( IDataProviderSvc* s ) { m_pDataProviderSvc = s; }
    RegistryEntry* parentEntry() { return m_pParent; }
    RegistryEntry* findLeaf( std::string_view path ) const { return i_find( path ); }
    RegistryEntry* findLeaf( const DataObject* key ) const { return i_find( key ); }
    void makeHard( DataObject* pObject );
    void makeHard( IOpaqueAddress* pAddress );
    void makeSoft( DataObject* pObject );
    void makeSoft( IOpaqueAddress* pAddress );
 
  public:
    RegistryEntry( std::string path, RegistryEntry* parent = nullptr );
    ~RegistryEntry() override;
    unsigned long release() override;
    unsigned long addRef() override { return ++m_refCount; }
    const std::string& name() const override { return m_path; }
    const std::string& identifier() const override { return m_fullpath; }
    IDataProviderSvc* dataSvc() const override { return m_pDataProviderSvc; }
    DataObject* object() const override { return m_pObject; }
    IOpaqueAddress* address() const override { return m_pAddress; }
    IRegistry* parent() const { return m_pParent; }
    bool isSoft() const { return m_isSoft; }
    const Store& leaves() const { return m_store; }
    size_t size() const { return m_store.size(); }
    bool isEmpty() const { return m_store.size() == 0; }
    Iterator begin() const { return m_store.begin(); }
    Iterator end() const { return m_store.end(); }
    IRegistry* find( const IRegistry* obj ) const { return i_find( obj ); }
    IRegistry* find( std::string_view path ) const { return i_find( path ); }
    void setAddress( IOpaqueAddress* pAddress ) override;
    void setObject( DataObject* obj );
 
    StatusCode add( std::string name, DataObject* pObject, bool is_soft = false );
    StatusCode add( std::string name, IOpaqueAddress* pAddress, bool is_soft = false );
    StatusCode remove( std::string_view name );
    long add( IRegistry* obj );
    long remove( IRegistry* obj );
    long deleteElements();
    StatusCode traverseTree( IDataStoreAgent* pAgent, int level = 0 );
  };
} // namespace DataSvcHelpers
#endif // GAUDIKERNEL_REGISTRYENTRY_H