IPoolSvc.h

Go to the documentation of this file.

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

 
#include "GaudiKernel/IService.h"
#include "CollectionSvc/ICollection.h"
#include "PersistencySvc/ITransaction.h"
#include "StorageSvc/DbType.h"
#include "DataModelRoot/RootType.h"
 
#include <string>
 
// Forward declarations
namespace pool {
   class IFileCatalog;
}
namespace coral {
   class Context;
}
class Placement;
class StatusCode;
class Token;
 

class IPoolSvc : virtual public IService {
 
public: // static members
   enum PoolStream { kInputStream, kOutputStream };
 
public: // Non-static members
   DeclareInterfaceID(IPoolSvc, 1, 0);

   virtual Token* registerForWrite(const Placement* placement,
                                   const void* obj,
                                   const RootType& classDesc) = 0;

   virtual void setObjPtr(void*& obj, const Token* token) = 0;

   virtual unsigned int getOutputContext(const std::string& label) = 0;

   virtual unsigned int getInputContext(const std::string& label, unsigned int maxFile = 0) = 0;

   virtual std::map<std::string, unsigned int> getInputContextMap() const  = 0;

   virtual unsigned int getInputContextMapSize() const = 0;

   virtual const coral::Context* context() const = 0;

   virtual void loadComponent(const std::string& compName) = 0;

   virtual void setShareMode(bool shareCat) = 0;

   virtual const pool::IFileCatalog* catalog() const = 0;

   virtual void lookupBestPfn(const std::string& token, std::string& pfn, std::string& type) const = 0;

   virtual void renamePfn(const std::string& pf, const std::string& newpf) = 0;

   virtual pool::ICollection* createCollection(const std::string& connection,
       const std::string& collectionName,
       const pool::DbType& collectionType = pool::POOL_StorageType.type(),
       unsigned int contextId = IPoolSvc::kInputStream) const = 0;

   virtual Token* getToken(const std::string& connection,
       const std::string& collection,
       const unsigned long ientry) const = 0;

   virtual StatusCode connect(pool::ITransaction::Type type,
       unsigned int contextId = IPoolSvc::kInputStream) = 0;

   virtual StatusCode commit(unsigned int contextId = IPoolSvc::kInputStream) const = 0;

   virtual StatusCode commitAndHold(unsigned int contextId = IPoolSvc::kInputStream) const = 0;

   virtual StatusCode disconnect(unsigned int contextId = IPoolSvc::kInputStream) const = 0;

   virtual StatusCode disconnectDb(const std::string& connection,
       unsigned int contextId = IPoolSvc::kInputStream) const = 0;

   virtual StatusCode getAttribute(const std::string& optName,
       std::string& data,
       long tech,
       unsigned int contextId = IPoolSvc::kInputStream) const = 0;

   virtual StatusCode getAttribute(const std::string& optName,
       std::string& data,
       long tech,
       const std::string& dbName,
       const std::string& contName = "",
       unsigned int contextId = IPoolSvc::kInputStream) const = 0;

   virtual StatusCode setAttribute(const std::string& optName,
       const std::string& data,
       long tech,
       unsigned int contextId = IPoolSvc::kOutputStream) const = 0;

   virtual StatusCode setAttribute(const std::string& optName,
       const std::string& data,
       long tech,
       const std::string& dbName,
       const std::string& contName = "",
       unsigned int contextId = IPoolSvc::kOutputStream) const = 0;

   virtual StatusCode setFrontierCache(const std::string& conn) = 0;
};
 
#endif