ATLAS Offline Software
Loading...
Searching...
No Matches
DbDatabase Class Reference

Description: Handle managing a DbDatabaseObj, a generic Database object. More...

#include <StorageSvc/DbDatabase.h>

Inheritance diagram for DbDatabase:
Collaboration diagram for DbDatabase:

Public Member Functions

 DbDatabase (const DbType &typ=pool::POOL_StorageType)
 Constructor with initializing arguments.
 DbDatabase (const DbDatabase &cp)
 Copy constructor.
 DbDatabase (DbDatabaseObj *obj)
 Constructor.
virtual ~DbDatabase ()
 Standard destructor.
DbDatabase & operator= (const DbDatabase &copy)
 Assignment (copy) operator.
DbDatabase & operator= (const int)
 Assignment operator to reset handle using 0.
 DbDatabase (DbDatabase &&cp)
DbDatabase & operator= (DbDatabase &&cp)
int refCount () const
 Access reference counter.
Io::IoFlag openMode () const
 Access to access mode member.
const std::string & name () const
 Access to db name (FID).
void setName (const std::string &nam)
 Set db name (FID) after opening in case opening happened by PFN.
const std::string & logon () const
 Access to db logon string.
long long int size () const
 Access the size of the database: May be undefined for some technologies.
ITechFactory * techFactory ()
 Allow access to the Database implementation.
const ITechFactory * techFactory () const
StatusCode add (const std::string &name, DbContainerObj *cnt)
 Add domain to session.
StatusCode remove (const DbContainerObj *cnt)
 Find domain in session.
const DbContainerObj * find (const std::string &nam) const
 Select container object in Database.
DbContainerObj * find (const std::string &nam)
 Select container object in Database.
const Token * token () const
 Access the token of the database object.
const DbDomain & containedIn () const
 Access to domain object.
DbDomain & containedIn ()
bool exist (DbDomain &domH, const std::string &nam) const
 Check for existence of Database within domain.
StatusCode open (DbDomain &domH, const std::string &pfn, const std::string &fid, Io::IoFlag mode=Io::READ)
 Open Database using given domain.
StatusCode close ()
 Close Database.
StatusCode retire ()
 End database access, but still leave database accessible.
bool isOpen () const
 Check if the database was opened.
StatusCode transAct (Transaction::Action action)
 Commit Database Transaction.
StatusCode setOption (const DbOption &refOpt)
 Set options.
StatusCode getOption (DbOption &refOpt)
 Access options.
StatusCode addParam (const std::string &nam, const std::string &val)
 Add a persistent parameter to the file.
StatusCode param (const std::string &nam, std::string &val) const
 Retrieve existing parameter by name.
StatusCode read (const Token &token, const DbTypeInfo *tinfo, void **object)
 read an object referenced by the token
std::string cntName (Token &token) const
 Retrieve container name from link container (using token oid, rather than contID).
StatusCode makeLink (Token *pToken, Token::OID_t &linkH)
 Add association link to link container.
StatusCode addShape (const DbTypeInfo *tinfo)
 Add persistent type to the Database.
const DbTypeInfo * objectShape (const RootType &typeH) const
 Retrieve persistent type information by class handle.
const DbTypeInfo * objectShape (const Guid &nam) const
 Retrieve persistent type information by name.
const DbTypeInfo * contShape (const std::string &nam) const
 Retrieve persistent type information by container.
const Token * cntToken (const std::string &cntName)
 Access local container token (if container exists).
StatusCode containers (std::vector< const Token * > &conts, bool intern=false)
 Allow access to all known containers.
StatusCode containers (std::vector< ITechContainer * > &conts, bool intern=false)
ITechDatabase * info ()
 Let the implementation access the internals.
const ITechDatabase * info () const
void setAge (int value)
 Update database age.
int age () const
 Access age value.
DbDatabaseObj * operator-> ()
 Dereference operator.
bool operator! () const
 Validity check through operator NOT.
const DbDatabaseObj * ptr () const
 Access to underlying object.
bool isValid () const
 Validity check (Objy like).
const DbType & type () const
 Inquire storage type of the handle.

Protected Types

typedef std::pair< std::string, std::string > Parameter
 Parameter definition.
typedef std::vector< Parameter > Parameters
 Parameter container definition.
typedef DbDatabaseObj _DataType
 Data type definition.
typedef DbHandleBase< _DataType > Base
 Data type definition.

Protected Member Functions

void switchPtr (DbDatabaseObj *obj)
 Assign transient object properly (including reference counting).
void setType (const DbType &typ)
 Set handle type.
void setPtr (DbDatabaseObj *ptr)
 Set data pointer.

Protected Attributes

DbDatabaseObj * m_ptr
 Data member: Object pointer. Sub-classes need access on re-assignment.
DbType m_type
 Data member: Technology type. Sub-classes need access on re-assignment.

Detailed Description

Description: Handle managing a DbDatabaseObj, a generic Database object.

Author
M.Frank

Definition at line 39 of file DbDatabase.h.

Member Typedef Documentation

◆ _DataType

typedef DbDatabaseObj DbHandleBase< DbDatabaseObj >::_DataType
protectedinherited

Data type definition.

Definition at line 20 of file DbHandleBase.h.

◆ Base

typedef DbHandleBase<_DataType> DbHandleBase< DbDatabaseObj >::Base
protectedinherited

Data type definition.

Definition at line 22 of file DbHandleBase.h.

◆ Parameter

typedef std::pair<std::string, std::string> DbDatabase::Parameter
protected

Parameter definition.

Definition at line 42 of file DbDatabase.h.

◆ Parameters

typedef std::vector< Parameter > DbDatabase::Parameters
protected

Parameter container definition.

Definition at line 44 of file DbDatabase.h.

Constructor & Destructor Documentation

◆ DbDatabase() [1/4]

DbDatabase::DbDatabase ( const DbType & typ = pool::POOL_StorageType)
inlineexplicit

Constructor with initializing arguments.

Definition at line 50 of file DbDatabase.h.

50{ m_type = typ; }

◆ DbDatabase() [2/4]

DbDatabase::DbDatabase ( const DbDatabase & cp)
inline

Copy constructor.

Definition at line 52 of file DbDatabase.h.

52: Base() { switchPtr(cp.m_ptr); }
void switchPtr(DbDatabaseObj *obj)
Assign transient object properly (including reference counting).
DbHandleBase< _DataType > Base

◆ DbDatabase() [3/4]

DbDatabase::DbDatabase ( DbDatabaseObj * obj)
inline

Constructor.

Definition at line 54 of file DbDatabase.h.

54{ switchPtr(obj); }

◆ ~DbDatabase()

virtual DbDatabase::~DbDatabase ( )
inlinevirtual

Standard destructor.

Definition at line 56 of file DbDatabase.h.

56{ switchPtr(0); }

◆ DbDatabase() [4/4]

DbDatabase::DbDatabase ( DbDatabase && cp)
inline

Definition at line 72 of file DbDatabase.h.

73 {
74 setPtr (cp.m_ptr);
75 setType (cp.m_type);
76 cp.setPtr (nullptr);
77 cp.setType(DbType(0));
78 }
void setType(const DbType &typ)
void setPtr(DbDatabaseObj *ptr)

Member Function Documentation

◆ add()

StatusCode DbDatabase::add ( const std::string & name,
DbContainerObj * cnt )

Add domain to session.

◆ addParam()

StatusCode DbDatabase::addParam ( const std::string & nam,
const std::string & val )

Add a persistent parameter to the file.

◆ addShape()

StatusCode DbDatabase::addShape ( const DbTypeInfo * tinfo)

Add persistent type to the Database.

◆ age()

int DbDatabase::age ( ) const

Access age value.

◆ close()

StatusCode DbDatabase::close ( )

Close Database.

◆ cntName()

std::string DbDatabase::cntName ( Token & token) const

Retrieve container name from link container (using token oid, rather than contID).

◆ cntToken()

const Token * DbDatabase::cntToken ( const std::string & cntName)

Access local container token (if container exists).

◆ containedIn() [1/2]

DbDomain & DbDatabase::containedIn ( )

◆ containedIn() [2/2]

const DbDomain & DbDatabase::containedIn ( ) const

Access to domain object.

◆ containers() [1/2]

StatusCode DbDatabase::containers ( std::vector< const Token * > & conts,
bool intern = false )

Allow access to all known containers.

◆ containers() [2/2]

StatusCode DbDatabase::containers ( std::vector< ITechContainer * > & conts,
bool intern = false )

◆ contShape()

const DbTypeInfo * DbDatabase::contShape ( const std::string & nam) const

Retrieve persistent type information by container.

◆ exist()

bool DbDatabase::exist ( DbDomain & domH,
const std::string & nam ) const

Check for existence of Database within domain.

◆ find() [1/2]

DbContainerObj * DbDatabase::find ( const std::string & nam)

Select container object in Database.

◆ find() [2/2]

const DbContainerObj * DbDatabase::find ( const std::string & nam) const

Select container object in Database.

◆ getOption()

StatusCode DbDatabase::getOption ( DbOption & refOpt)

Access options.

Parameters
refOpt[IN] Reference to option object.
Returns
Status code indicating success or failure.

◆ info() [1/2]

ITechDatabase * DbDatabase::info ( )

Let the implementation access the internals.

◆ info() [2/2]

const ITechDatabase * DbDatabase::info ( ) const

◆ isOpen()

bool DbDatabase::isOpen ( ) const

Check if the database was opened.

◆ isValid()

bool DbHandleBase< DbDatabaseObj >::isValid ( ) const
inlineinherited

Validity check (Objy like).

Definition at line 54 of file DbHandleBase.h.

54{ return 0 != m_ptr; }

◆ logon()

const std::string & DbDatabase::logon ( ) const

Access to db logon string.

◆ makeLink()

StatusCode DbDatabase::makeLink ( Token * pToken,
Token::OID_t & linkH )

Add association link to link container.

◆ name()

const std::string & DbDatabase::name ( ) const

Access to db name (FID).

◆ objectShape() [1/2]

const DbTypeInfo * DbDatabase::objectShape ( const Guid & nam) const

Retrieve persistent type information by name.

◆ objectShape() [2/2]

const DbTypeInfo * DbDatabase::objectShape ( const RootType & typeH) const

Retrieve persistent type information by class handle.

◆ open()

StatusCode DbDatabase::open ( DbDomain & domH,
const std::string & pfn,
const std::string & fid,
Io::IoFlag mode = Io::READ )

Open Database using given domain.

Parameters
domH[IN] Valid handle to domain object.
pfn[IN] Physical file name of the database.
lfn[IN] Logical file name of the database.
mode[IN] Open mode (Default=READ).
Returns
Status code indicating success or failure.

◆ openMode()

Io::IoFlag DbDatabase::openMode ( ) const

Access to access mode member.

◆ operator!()

bool DbHandleBase< DbDatabaseObj >::operator! ( ) const
inlineinherited

Validity check through operator NOT.

Definition at line 49 of file DbHandleBase.h.

49{ return !isValid(); }

◆ operator->()

DbDatabaseObj * DbHandleBase< DbDatabaseObj >::operator-> ( )
inlineinherited

Dereference operator.

Definition at line 46 of file DbHandleBase.h.

46{ return m_ptr; }

◆ operator=() [1/3]

DbDatabase & DbDatabase::operator= ( const DbDatabase & copy)
inline

Assignment (copy) operator.

Definition at line 58 of file DbDatabase.h.

58 {
59 if ( &copy != this ) {
60 m_type = copy.m_type;
61 switchPtr( copy.m_ptr );
62 }
63 return *this;
64 }
bool copy
Definition calibdata.py:26

◆ operator=() [2/3]

DbDatabase & DbDatabase::operator= ( const int )
inline

Assignment operator to reset handle using 0.

Definition at line 66 of file DbDatabase.h.

66 {
67 switchPtr(0);
68 return *this;
69 }

◆ operator=() [3/3]

DbDatabase & DbDatabase::operator= ( DbDatabase && cp)
inline

Definition at line 79 of file DbDatabase.h.

80 {
81 if (&cp != this) {
82 switchPtr (nullptr);
83 setPtr (cp.m_ptr);
84 setType (cp.m_type);
85 cp.setPtr (nullptr);
86 cp.setType(DbType(0));
87 }
88 return *this;
89 }

◆ param()

StatusCode DbDatabase::param ( const std::string & nam,
std::string & val ) const

Retrieve existing parameter by name.

◆ ptr()

const DbDatabaseObj * DbHandleBase< DbDatabaseObj >::ptr ( ) const
inlineinherited

Access to underlying object.

Definition at line 51 of file DbHandleBase.h.

51{ return m_ptr; }

◆ read()

StatusCode DbDatabase::read ( const Token & token,
const DbTypeInfo * tinfo,
void ** object )

read an object referenced by the token

◆ refCount()

int DbDatabase::refCount ( ) const

Access reference counter.

◆ remove()

StatusCode DbDatabase::remove ( const DbContainerObj * cnt)

Find domain in session.

◆ retire()

StatusCode DbDatabase::retire ( )

End database access, but still leave database accessible.

◆ setAge()

void DbDatabase::setAge ( int value)

Update database age.

◆ setName()

void DbDatabase::setName ( const std::string & nam)

Set db name (FID) after opening in case opening happened by PFN.

◆ setOption()

StatusCode DbDatabase::setOption ( const DbOption & refOpt)

Set options.

Parameters
refOpt[IN] Reference to option object.
Returns
Status code indicating success or failure.

◆ setPtr()

void DbHandleBase< DbDatabaseObj >::setPtr ( DbDatabaseObj * ptr)
inlineprotectedinherited

Set data pointer.

Definition at line 42 of file DbHandleBase.h.

42{ m_ptr=ptr; }
const DbDatabaseObj * ptr() const

◆ setType()

void DbHandleBase< DbDatabaseObj >::setType ( const DbType & typ)
inlineprotectedinherited

Set handle type.

Definition at line 40 of file DbHandleBase.h.

40{ m_type=typ; }
Description: Definition of the generic database object handle.

◆ size()

long long int DbDatabase::size ( ) const

Access the size of the database: May be undefined for some technologies.

◆ switchPtr()

void DbDatabase::switchPtr ( DbDatabaseObj * obj)
protected

Assign transient object properly (including reference counting).

◆ techFactory() [1/2]

ITechFactory * DbDatabase::techFactory ( )

Allow access to the Database implementation.

◆ techFactory() [2/2]

const ITechFactory * DbDatabase::techFactory ( ) const

◆ token()

const Token * DbDatabase::token ( ) const

Access the token of the database object.

◆ transAct()

StatusCode DbDatabase::transAct ( Transaction::Action action)

Commit Database Transaction.

Parameters
action[IN] action to perform
Returns
Status code indicating success or failure.

◆ type()

const DbType & DbHandleBase< DbDatabaseObj >::type ( ) const
inlineinherited

Inquire storage type of the handle.

Definition at line 56 of file DbHandleBase.h.

56{ return m_type; }

Member Data Documentation

◆ m_ptr

DbDatabaseObj* DbHandleBase< DbDatabaseObj >::m_ptr
protectedinherited

Data member: Object pointer. Sub-classes need access on re-assignment.

Definition at line 24 of file DbHandleBase.h.

◆ m_type

DbType DbHandleBase< DbDatabaseObj >::m_type
protectedinherited

Data member: Technology type. Sub-classes need access on re-assignment.

Definition at line 26 of file DbHandleBase.h.


The documentation for this class was generated from the following file: