ATLAS Offline Software
Loading...
Searching...
No Matches
DbDatabaseObj.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 STORAGESVC_DBDATABASEOBJ_H
5#define STORAGESVC_DBDATABASEOBJ_H 1
6
7// We need the definition of the domain for defining the Database
12#include "StorageSvc/DbPrint.h"
13#include "DbAccessObj.h"
14
15// STL include files
16#include <map>
17#include <string>
18#include <vector>
19
27class DbDatabaseObj : public DbAccessObj<std::string, DbContainerObj >, public APRMessaging {
28 private:
30 typedef std::pair<std::string, std::string> Parameter;
32 typedef std::vector< Parameter > Parameters;
34 typedef std::vector< DbContainerObj > Containers;
36 typedef std::map<std::string, std::string, std::less<>> ParamMap;
38 typedef std::map< Guid , Token* > LinkMap;
40 typedef std::vector<Token*> LinkVector;
42 typedef std::map< Guid , const DbTypeInfo* > ShapeMap;
44 typedef std::map< long long int , int > IndexMap;
47
69 std::map<RootType, const DbTypeInfo*> m_classMap;
75 std::string m_logon;
80
81 private:
83 void cleanup();
84
85 public:
88 const std::string& pfn,
89 const std::string& fid,
90 Io::IoFlag mode = Io::READ);
92 virtual ~DbDatabaseObj();
94 const std::string& logon() const { return m_logon; }
96 long long int size() const;
98 ITechDatabase* info() { return m_info; }
99 const ITechDatabase* info() const { return m_info; }
101 DbDomain& domain() { return m_dom; }
102 const DbDomain& domain() const { return m_dom; }
104 int age() const { return m_fileAge; }
106 const Token* token() const { return m_token; }
107
109 StatusCode open();
111 StatusCode close();
113 StatusCode retire();
115 StatusCode transAct(Transaction::Action action);
116
118 StatusCode read(const Token& token, const DbTypeInfo* tinfo, void** object);
120 std::string cntName(Token& token) const;
122 StatusCode makeLink(Token* pToken, Token::OID_t& refLink);
124 const DbTypeInfo* objectShape(const RootType& classH) const;
126 const DbTypeInfo* objectShape(const Guid& nam) const;
128 const DbTypeInfo* contShape(const std::string& nam) const;
130 StatusCode addShape (const DbTypeInfo* pType);
132 const Token* cntToken(const std::string& cntName);
134 StatusCode containers(std::vector<const Token*>& conts, bool intern);
135 StatusCode containers(std::vector<ITechContainer*>& conts, bool intern);
137 StatusCode addParam(const std::string& nam, const std::string& val);
139 StatusCode param(const std::string& nam, std::string& val) const;
141 StatusCode setOption(const DbOption& refOpt);
143 StatusCode getOption(DbOption& refOpt);
144
146 void setAge(int value);
147};
148
149#endif
This file contains the class definition for the Guid class (migrated from POOL).
TTypeAdapter RootType
Definition RootType.h:211
APRMessaging(const std::string &name)
Description:
Description: This class is a handle managing access and lifetime for the Container implementation obj...
Definition DbContainer.h:31
std::pair< std::string, std::string > Parameter
Database parameter definition.
DbAccessObj< std::string, DbContainerObj > Base
Base class convenience typdef.
Containers m_retiredConts
Collection of retired database containers.
DbContainer m_links
Handle to link container.
std::string m_logon
Physical Database login.
DbContainer m_shapes
Handle to tinfos container.
StatusCode retire()
End database access, but still leave database accessible.
ITechDatabase * info()
Access to technology dependent implementation.
const Token * cntToken(const std::string &cntName)
Access local container token (if container exists).
std::vector< Token * > LinkVector
Definition of array with link elements.
StatusCode transAct(Transaction::Action action)
Execute Database Transaction action.
const ITechDatabase * info() const
StatusCode param(const std::string &nam, std::string &val) const
Retrieve existing parameter by name.
const DbTypeInfo * m_string_t
Internal string representation type.
std::map< long long int, int > IndexMap
Definition of map with index elements.
std::vector< Parameter > Parameters
Database parameter container definition.
const DbDomain & domain() const
std::map< Guid, const DbTypeInfo * > ShapeMap
Definition of map with tinfo elements.
int age() const
Access age value.
ParamMap m_paramMap
Map with all cached file properties.
StatusCode open()
Open Database object.
LinkVector m_linkVec
Random access array containing all links.
const Token * token() const
Access the token of the database object.
long long int size() const
Access the size of the database: May be undefined for some technologies.
ShapeMap m_shapeMap
Map containing all tinfos.
std::map< std::string, std::string, std::less<> > ParamMap
Parameter map definition.
const std::string & logon() const
Access to the logon string.
const DbTypeInfo * objectShape(const Guid &nam) const
Retrieve persistent type information by tinfo identifier.
DbDatabaseObj(DbDomain &dom, const std::string &pfn, const std::string &fid, Io::IoFlag mode=Io::READ)
Standard constructor of a Database obejct.
DbContainer m_params
Handle to the parameter container.
StatusCode close()
Close database object.
IndexMap m_indexMap
Map containing all index.
std::map< RootType, const DbTypeInfo * > m_classMap
Map with all cached mappings between known reflection classes.
virtual ~DbDatabaseObj()
Standard Destructor.
StatusCode addParam(const std::string &nam, const std::string &val)
Add a persistent parameter to the file.
ITechDatabase * m_info
Technology dependent implementation block.
int m_fileAge
File age counter.
DbDomain & domain()
Access to domain handle (CONST).
StatusCode addShape(const DbTypeInfo *pType)
Add persistent type to the Database.
std::string cntName(Token &token) const
Retrieve container name from link container (using token oid, rather than contID).
void cleanup()
Perform cleanup of internal data structures.
StatusCode containers(std::vector< const Token * > &conts, bool intern)
Allow access to all known containers.
const DbTypeInfo * contShape(const std::string &nam) const
Retrieve persistent type information by container.
StatusCode read(const Token &token, const DbTypeInfo *tinfo, void **object)
read an object referenced by the token
LinkMap m_linkMap
Map containing all links.
const DbTypeInfo * objectShape(const RootType &classH) const
Retrieve persistent type information by class handle.
StatusCode getOption(DbOption &refOpt)
Access options.
Token * m_token
Token describing the object.
StatusCode containers(std::vector< ITechContainer * > &conts, bool intern)
DbDomain m_dom
Handle to domain.
StatusCode setOption(const DbOption &refOpt)
Set options.
std::vector< DbContainerObj > Containers
Collection of retired database containers.
void setAge(int value)
Update database age.
StatusCode makeLink(Token *pToken, Token::OID_t &refLink)
Add association link to link container.
std::map< Guid, Token * > LinkMap
Definition of map with link elements.
Description:
Definition DbDomain.h:33
Description: Definition an option to be supplied to database objects.
Definition DbOption.h:22
Definition of class DbTypeInfo.
Definition DbTypeInfo.h:31
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 a Database object.
This class provides a token that identifies in a unique way objects on the persistent storage.
Definition Token.h:22