DbContainer.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
//====================================================================
//  DbContainer handle definitions
//--------------------------------------------------------------------
//
//  Package    : StorageSvc  (The POOL project)
//  @author      M.Frank
//====================================================================
#ifndef POOL_DBCONTAINER_H
#define POOL_DBCONTAINER_H
 
// Framework include files
#include "PersistentDataModel/Token.h"
#include "StorageSvc/DbHandleBase.h"
#include "StorageSvc/pool.h"
#include "StorageSvc/Transaction.h"
 
#include <cstdint>
 
class StatusCode;
 
/*
 * POOL namespace declaration
 */
namespace pool  {
 
  // Forward declarations
  class IDbContainer;
  class DbDatabase;
  class DbTypeInfo;
  class DbContainerObj;
  class DbOption;
 
  typedef const class Shape        *ShapeH;

  class DbContainer : public DbHandleBase<DbContainerObj>  {
  private:
    void switchPtr( DbContainerObj* obj);
 
  public:
    explicit DbContainer(const DbType& typ=POOL_StorageType) { m_type=typ;          }
    DbContainer(const DbContainer& c) : Base()  { switchPtr(c.m_ptr);      }
    DbContainer (DbContainerObj* ptr)           { switchPtr(ptr);          }
    virtual ~DbContainer()                      { switchPtr(0);            }
    DbContainer& operator=(const DbContainer& copy) {
      if ( &copy != this )  {
        m_type = copy.m_type;
        switchPtr( copy.m_ptr );
      }
      return *this;
    }

    DbContainer& operator=(const int /* nuller */ ) {
      switchPtr(0);
      return *this;
    }

    int refCount() const;
    const std::string& name() const;
    DbAccessMode openMode() const;
    uint64_t size();
    DbDatabase& containedIn();
    const IDbContainer* info()  const;
    IDbContainer* info();
    const DbTypeInfo* objectShape(const Guid& nam);
    const Token* token() const;
    StatusCode close();


    StatusCode open(DbDatabase&         dbH,
                    const std::string&  nam,
                    const DbTypeInfo*   typ,
                    const DbType&       dbtyp,
                    DbAccessMode        mod);


    StatusCode checkAccess(DbDatabase&        dbH,
                           const std::string& nam,
                           const DbType&      dbtyp);

    bool isOpen() const;
    StatusCode transAct(Transaction::Action action);
    StatusCode setOption(const DbOption& refOpt);
    StatusCode getOption(DbOption& refOpt);


    StatusCode next(Token::OID_t& linkH);


    StatusCode allocate(const void* object, ShapeH shape, Token::OID_t& oid);
    StatusCode load(void** ptr, ShapeH shape, const Token::OID_t& lH);


    StatusCode store(const void* object, const DbTypeInfo* typ);
  };
}       // End namespace pool
 
#endif  // POOL_DBCONTAINER_H