IOVRegistrationSvc.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/

 
#ifndef REGISTRATIONSERVICES_IOVREGISTRATIONSVC_H
# define REGISTRATIONSERVICES_IOVREGISTRATIONSVC_H
 
//<<<<<< INCLUDES                                                       >>>>>>
 
#include "RegistrationServices/IIOVRegistrationSvc.h"
#include "AthenaBaseComps/AthService.h"
#include "AthenaKernel/IOVTime.h"
#include "GaudiKernel/ServiceHandle.h"
#include "GaudiKernel/ClassID.h"
#include "CoolKernel/StorageType.h"
 
//<<<<<< FORWARD DECLARATIONS                                             >>>>>>
 
class IIOVCondDbSvc;
class StoreGateSvc;
class IAddressCreator;   
class IClassIDSvc;   
 
 
//<<<<<< CLASS DECLARATIONS                                             >>>>>>

class IOVRegistrationSvc : public extends<AthService, IIOVRegistrationSvc>
{
 
public:    
  
    IOVRegistrationSvc( const std::string& name, ISvcLocator* svc );
 
    virtual ~IOVRegistrationSvc();

    virtual const InterfaceID& type() const;

    virtual StatusCode registerIOV( const std::string& typeName ) const;
    
    virtual StatusCode registerIOV( const std::string& typeName, const std::string& tag ) const;
    
    virtual StatusCode registerIOV( const std::string& typeName, const std::string& key,
                    const std::string& tag ) const;
    
    virtual StatusCode registerIOV( const std::string& typeName, 
                    const std::string& tag,
                    unsigned int beginRun, 
                    unsigned int endRun, 
                    unsigned int beginLB, 
                    unsigned int endLB ) const;
    

    virtual StatusCode registerIOV( const std::string& typeName, 
                    const std::string& tag,
                    uint64_t beginTime, 
                    uint64_t endTime ) const;

    virtual StatusCode registerIOV( const std::string& typeName,
                    const std::string& key,
                    const std::string& tag,
                    unsigned int beginRun, 
                    unsigned int endRun, 
                    unsigned int beginLB, 
                    unsigned int endLB ) const;
    
    virtual StatusCode registerIOV( const std::string& typeName,
                    const std::string& key,
                    const std::string& tag,
                    uint64_t beginTime, 
                    uint64_t endTime ) const;

    virtual StatusCode registerIOV( const std::string& typeName,
                    const std::string& key,
                    const std::string& folder,
                    const std::string& tag,
                    unsigned int beginRun, 
                    unsigned int endRun, 
                    unsigned int beginLB, 
                    unsigned int endLB ) const;

    virtual StatusCode registerIOV( const std::string& typeName,
                    const std::string& key,
                    const std::string& folder,
                    const std::string& tag,
                    uint64_t beginTime, 
                    uint64_t endTime ) const;

    virtual StatusCode initialize();

    virtual StatusCode finalize();
 
 
private:
    
    // Allow SvcFactory to instantiate the service.
    friend class SvcFactory<IOVRegistrationSvc>;
 
    StatusCode registerIOV(const std::string& typeName,
               const std::string& key,
               const std::string& folder,
               const std::string& tag,
               const IOVTime&     begin,
               const IOVTime&     end) const;
    
    StatusCode registerIOVCOOL(const std::string& typeName,
                   const std::string& key,
                   const std::string& folderName,
                   const std::string& tag,
                   const IOVTime&     begin,
                   const IOVTime&     end) const;
 
    cool::StorageType::TypeId coralToCoolType(const std::string& parname,
                   const std::string& coralName) const;
 
    StatusCode getStringAddress(const CLID& clid,
                const std::string& key,
                std::string& saddr) const;
 
    uint64_t timeToNano(const unsigned long int timesec) const;

    virtual StatusCode buildDescription(const std::string&  identifier,
                    const std::string&  value,
                    std::string& description) const;

    StatusCode splitAddress(const std::string& address,
                std::string& address_header,
                std::string& address_data) const;
 
    Gaudi::Property<bool>         m_recreateFolders{this, "RecreateFolders", false};
    Gaudi::Property<unsigned int> m_beginRun{this, "BeginRun", IOVTime::MINRUN};
    Gaudi::Property<unsigned int> m_endRun{this, "EndRun", IOVTime::MAXRUN};
    Gaudi::Property<unsigned int> m_beginLB{this, "BeginLB", IOVTime::MINEVENT};
    Gaudi::Property<unsigned int> m_endLB{this, "EndLB", IOVTime::MAXEVENT};
    
    Gaudi::Property<unsigned long> m_beginTime{this, "BeginTime", IOVTime::MINTIMESTAMP};
    Gaudi::Property<unsigned long> m_endTime{this, "EndTime", IOVTime::MAXEVENT}; // as the time parameter is only 32bit
 
    Gaudi::Property<std::string>   m_tag{this, "IOVDbTag", ""};
    Gaudi::Property<bool>          m_timeStamp{this, "IOVDbTimeStamp", false};
    Gaudi::Property<std::string>   m_tagDescription{this, "TagDescription", "Athena IOVRegistrationSvc"};
    Gaudi::Property<bool>          m_writeKeyInfo{this, "writeKeyInfo", true};
    Gaudi::Property<bool>          m_userTags{this, "userTags", true};
    Gaudi::Property<bool>          m_userTagsUH{this, "userTagsUpdateHead", false};
    Gaudi::Property<bool>          m_svFolder{this, "SVFolder", false};
    Gaudi::Property<bool>          m_payloadTable{this, "PayloadTable", false};
    Gaudi::Property<bool>          m_forceGlobalIOV{this, "UseGlobalIOVForCollections", false};
    Gaudi::Property<std::vector<std::string>> m_overrideName{this, "OverrideNames", {}};
    Gaudi::Property<std::vector<std::string>> m_overrideType{this, "OverrideTypes", {}};
 
    ServiceHandle<IIOVCondDbSvc> m_iov_db;
    ServiceHandle<StoreGateSvc>    m_detStore;
    ServiceHandle<IAddressCreator> m_persSvc;
    ServiceHandle<IClassIDSvc>     m_clidSvc;   
    
};
 
 
//<<<<<< INLINE PUBLIC FUNCTIONS                                        >>>>>>
//<<<<<< INLINE MEMBER FUNCTIONS                                        >>>>>>
 
#endif //  REGISTRATIONSERVICES_IOVREGISTRATIONSVC_H