DbContainerImp.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
//====================================================================
//
//  Package    : StorageSvc (The POOL project)
//
//  @author      M.Frank
//====================================================================
#ifndef POOL_DBCONTAINERIMP_H
#define POOL_DBCONTAINERIMP_H 1

#include "PersistentDataModel/Token.h"
#include "StorageSvc/pool.h"
#include "StorageSvc/IDbContainer.h"
#include "POOLCore/DbPrint.h"
#include "GaudiKernel/StatusCode.h"
 
// STL include files
#include <map>
#include <vector>
#include <utility>
 
/*
 * POOL namespace declaration
 */
namespace pool    {
 
  // Forward declarations
  class IDbContainer;

  class DbContainerImp : virtual public IDbContainer, public APRMessaging
  {
  protected:

    struct DbAction {
      const void*         object;
      const Shape*        shape;
      Token::OID_t        link;
 
      DbAction() : object(nullptr), shape(nullptr) { }
      DbAction(const void* obj, const Shape* s, const Token::OID_t&  l)
            : object(obj), shape(s), link(l) { }
 
      const void*       dataAtOffset(size_t offset) {
         return static_cast<const char*>(object) + offset;
      }
    };
    
    typedef std::vector< DbAction > ActionList;
    
  private:
    ActionList            m_writeStack;
    size_t                m_size;
  protected:
    std::string           m_name;

    virtual ~DbContainerImp();
    virtual StatusCode writeObject(ActionList::value_type& /* entry */)  
    { return StatusCode::FAILURE;                                                   }

    virtual StatusCode commitTransaction();
 
  public:
    explicit DbContainerImp(const std::string& name);
    virtual void release() override                    { delete this;           }
    virtual uint64_t size() override;
    virtual std::string name() const override
    { return m_name; }

    virtual uint64_t nextRecordId() override;
    virtual void useNextRecordId(uint64_t) override {};
    virtual StatusCode close() override;


    virtual StatusCode getOption(DbOption& opt) override;


    virtual StatusCode setOption(const DbOption& opt) override;

    virtual StatusCode transAct(Transaction::Action) override;
    virtual StatusCode store(      const void* object,
                                 DbContainer&  cntH,
                                 ShapeH shape) override;
    virtual StatusCode allocate(DbContainer& cntH,
                              const void* object,
                              ShapeH shape,
                              Token::OID_t& oid) override;
    virtual StatusCode next(Token::OID_t& linkH) override;


    virtual StatusCode load( void** ptr, ShapeH shape,
                           const Token::OID_t& lnkH,
                           Token::OID_t&       oid,
                           bool                any_next) override;


    virtual StatusCode loadObject(void** ptr, ShapeH shape, Token::OID_t& oid) = 0;
 
  };
}       // End namespace pool
#endif  // POOL_DBCONTAINERIMP_H