IIOVDbSvc.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef ATHENAKERNEL_IIOVDBSVC_H
#define ATHENAKERNEL_IIOVDBSVC_H

 
#include "GaudiKernel/IInterface.h"
#include "GaudiKernel/StatusCode.h"
#include "GaudiKernel/ClassID.h"
 
#include "AthenaKernel/IOVRange.h"
 
#include <string>
#include <memory>
 
class IOVTime;
class IOpaqueAddress;
class EventContext;

class IIOVDbSvc  : virtual public IInterface  {
public:
    DeclareInterfaceID(IIOVDbSvc, 1, 0);

    struct KeyInfo {
        std::string folderName;
        std::string tag;
        IOVRange range;
        float readTime{0};
        unsigned long long bytesRead{0};
        bool retrieved{false};
        bool extensible{false};
    };

    virtual StatusCode getRange(const CLID& clid,
                                const std::string& dbKey,
                                const IOVTime& time,
                                IOVRange& range,
                                std::string& tag,
                                std::unique_ptr<IOpaqueAddress>& ioa) = 0;

    virtual StatusCode setRange(const CLID& clid,
                                const std::string& dbKey,
                                const IOVRange& range,
                                const std::string& tag ) = 0;

    virtual StatusCode signalBeginRun(const IOVTime& beginRunTime,
                                      const EventContext& ctx) = 0;

    virtual void signalEndProxyPreload() = 0;

    virtual void       postConditionsLoad() = 0;

    virtual StatusCode processTagInfo() = 0;

    virtual std::vector<std::string> getKeyList() = 0;

    virtual bool getKeyInfo(const std::string& key, IIOVDbSvc::KeyInfo& info) = 0;
 
    // drop an IOVDbSvc-managed object from Storegate, indicating we will
    // not read it again and can free up memory 
    // If resetCache=True, also drop the corresponding folder cache
    // so any subsequent reads will access the database again
    // returns False if key not known to IOVDbSvc
    virtual bool dropObject(const std::string& key,
                            const bool resetCache=false) = 0;
};
 
#endif