DbContainerObj.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
//====================================================================
//  DbContainerObj class definitions
//--------------------------------------------------------------------
//
//  Package    : StorageSvc  (The POOL project)
//  @author      M.Frank
//====================================================================
#ifndef POOL_DBCONTAINEROBJ_H
#define POOL_DBCONTAINEROBJ_H 1
 
// Framework include files
#include "PersistentDataModel/Token.h"
#include "StorageSvc/DbDatabase.h"
#include "StorageSvc/DbContainer.h"
#include "StorageSvc/DbPrint.h"
#include "DbAccessObj.h"
 
/*
 *  POOL namespace declaration
 */
namespace pool  {
 
  typedef const class Shape        *ShapeH;

  class DbContainerObj : public  DbAccessObjBase, public APRMessaging {
  private:
    IDbContainer*                 m_info;
    const Token*                  m_tokH;
    DbDatabase                    m_dbH;
    bool                          m_isOpen;

    bool hasAccess();
  public:

    DbContainerObj( DbDatabase&        dbH,
                    const std::string& nam,
                    const DbType&      dbtyp,
                    Io::IoFlag         mod);
    virtual ~DbContainerObj();
    const IDbContainer* info()  const       {  return m_info;         }
    IDbContainer* info()                    {  return m_info;         }
    const DbTypeInfo* objectShape(const Guid& nam);
    DbDatabase& database()                  {  return m_dbH;          }
    const Token* token() const              {  return m_tokH;         }
    bool isOpen() const                     {  return m_isOpen;       }
    bool isReadOnly() const      
    { return !(mode() == Io::WRITE || mode() == Io::APPEND);    }

    void cancelTransaction()                { }
    uint64_t size();
    StatusCode open(const DbTypeInfo* typ);
    StatusCode checkAccess();
    StatusCode close();
    StatusCode retire();
    StatusCode transAct(Transaction::Action);
    StatusCode setOption(const DbOption& opt);
    StatusCode getOption(DbOption& refOpt);


    StatusCode store(const void* object, DbContainer& cntH, ShapeH shape);

    StatusCode allocate(DbContainer& cntH, const void* object, ShapeH shape, Token::OID_t& oid);

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

    StatusCode next(Token::OID_t& linkH);
  };
}       // End namespace pool
#endif  // POOL_DBCONTAINEROBJ_H