ATLAS Offline Software
Loading...
Searching...
No Matches
DbContainerObj.h
Go to the documentation of this file.
1/*
2 Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
3*/
4#ifndef DBCONTAINEROBJ_H
5#define DBCONTAINEROBJ_H 1
6
7// Framework include files
11#include "StorageSvc/DbPrint.h"
12#include "DbAccessObj.h"
13
30 private:
34 const Token* m_tokH;
39
41 bool hasAccess();
42 public:
44
52 const std::string& nam,
53 const DbType& dbtyp,
54 Io::IoFlag mod);
56 virtual ~DbContainerObj();
58 const ITechContainer* info() const { return m_info; }
59 ITechContainer* info() { return m_info; }
61 const DbTypeInfo* objectShape(const Guid& nam);
63 DbDatabase& database() { return m_dbH; }
65 const Token* token() const { return m_tokH; }
67 bool isOpen() const { return m_isOpen; }
69 bool isReadOnly() const
70 { return !(mode() == Io::WRITE || mode() == Io::APPEND); }
71
74 uint64_t size();
76 StatusCode open(const DbTypeInfo* typ);
78 StatusCode checkAccess();
80 StatusCode close();
82 StatusCode retire();
86 StatusCode setOption(const DbOption& opt);
88 StatusCode getOption(DbOption& refOpt);
89
91
93 StatusCode store(const void* object, DbContainer& cntH, const DbTypeInfo* tinfo);
94
96 StatusCode allocate(DbContainer& cntH, const void* object, const DbTypeInfo* tinfo, Token::OID_t& oid);
97
99 StatusCode load( void** ptr, const DbTypeInfo* tinfo,
100 const Token::OID_t& linkH,
101 Token::OID_t& oid,
102 bool any_next);
104
106 StatusCode next(Token::OID_t& linkH);
107};
108
109#endif
This file contains the class definition for the Token class (migrated from POOL).
APRMessaging(const std::string &name)
Io::IoFlag mode() const
Access mode.
Definition DbAccessObj.h:55
DbAccessObjBase(const std::string &n, Io::IoFlag m, const DbType &t, ITechFactory *s=0)
Constructor with initializing arguments.
Definition DbAccessObj.h:45
ITechContainer * m_info
Pointer to interface of the technology dependent part.
DbContainerObj(DbDatabase &dbH, const std::string &nam, const DbType &dbtyp, Io::IoFlag mod)
Standard constructor of a container object using the Database handle as a clustering hint.
StatusCode store(const void *object, DbContainer &cntH, const DbTypeInfo *tinfo)
Store object in location.
const Token * m_tokH
Container token.
DbDatabase & database()
Handle to Database (CONST).
StatusCode setOption(const DbOption &opt)
Pass options to the implementation.
StatusCode next(Token::OID_t &linkH)
Fetch next object address to set token.
bool isReadOnly() const
Check if database is in read-only mode.
StatusCode close()
Close the container.
StatusCode retire()
Retire the container.
StatusCode open(const DbTypeInfo *typ)
Open the container.
void cancelTransaction()
Cancel transaction flag.
bool hasAccess()
Check database access.
const DbTypeInfo * objectShape(const Guid &nam)
Retrieve persistent type information by name.
bool m_isOpen
Flag indication StatusCode of technology dependent container.
const Token * token() const
Access the token of the container object.
virtual ~DbContainerObj()
Standard destructor.
const ITechContainer * info() const
Access to internals.
ITechContainer * info()
StatusCode load(void **ptr, const DbTypeInfo *tinfo, const Token::OID_t &linkH, Token::OID_t &oid, bool any_next)
Select object in the container identified by its handle.
StatusCode transAct(Transaction::Action)
Execute Database Transaction Action.
StatusCode getOption(DbOption &refOpt)
Access options.
StatusCode checkAccess()
Check if we can access the container.
DbDatabase m_dbH
Handle to hosting Database.
StatusCode allocate(DbContainer &cntH, const void *object, const DbTypeInfo *tinfo, Token::OID_t &oid)
In place allocation of object location.
uint64_t size()
Size of the Database container (=# of objects).
bool isOpen() const
Flag if container was opened.
Description: This class is a handle managing access and lifetime for the Container implementation obj...
Definition DbContainer.h:31
Description: Handle managing a DbDatabaseObj, a generic Database object.
Definition DbDatabase.h:39
Description: Definition an option to be supplied to database objects.
Definition DbOption.h:22
Definition of class DbTypeInfo.
Definition DbTypeInfo.h:31
Keeps information about storage technology.
Definition DbType.h:15
This class provides a encapsulation of a GUID/UUID/CLSID/IID data structure (128 bit number).
Definition Guid.h:25
Description: Interface to the technology specific implementation of the Container object.
This class provides a token that identifies in a unique way objects on the persistent storage.
Definition Token.h:22