ATLAS Offline Software
Loading...
Searching...
No Matches
ITechContainer Class Referenceabstract

Description: Interface to the technology specific implementation of the Container object. More...

#include <StorageSvc/ITechContainer.h>

Inheritance diagram for ITechContainer:
Collaboration diagram for ITechContainer:

Public Member Functions

virtual void release ()=0
 Release the technology specific implementation.
virtual uint64_t size ()=0
 Access to container size.
virtual std::string name () const =0
 Get container name.
virtual StatusCode setOption (const DbOption &refOpt)=0
 Set options.
virtual StatusCode getOption (DbOption &refOpt)=0
 Access options.
virtual StatusCode store (const void *object, DbContainer &cntH, const DbTypeInfo *tinfo)=0
 Store object in location.
virtual StatusCode allocate (DbContainer &cntH, const void *object, const DbTypeInfo *tinfo, Token::OID_t &oid)=0
 In place allocation of object location.
virtual uint64_t nextRecordId ()=0
 Number of next record in the container (=size if no delete is allowed).
virtual void useNextRecordId (uint64_t)=0
 Suggest next Record ID for tbe next object written - used only with synced indexes.
virtual StatusCode close ()=0
 Close the container.
virtual StatusCode open (DbDatabase &dbH, const std::string &nam, const DbTypeInfo *info, Io::IoFlag mode)=0
 Open the container.
virtual StatusCode checkAccess (DbDatabase &dbH, const std::string &nam) const =0
 Check if we can access the container for reading with the given type.
virtual StatusCode next (Token::OID_t &linkH)=0
 Fetch next object address to set token.
virtual StatusCode load (void **ptr, const DbTypeInfo *tinfo, const Token::OID_t &lnkH, Token::OID_t &oid, bool any_next=false)=0
 Find object within the container and load it into memory.
virtual StatusCode transAct (Transaction::Action)=0
 Execute Transaction Action.

Protected Member Functions

virtual ~ITechContainer ()=default
 Destructor (called only by sub-classes).

Detailed Description

Description: Interface to the technology specific implementation of the Container object.

(usually defined in a separate dynamically loaded plugin package)

Author
M.Frank

Definition at line 29 of file ITechContainer.h.

Constructor & Destructor Documentation

◆ ~ITechContainer()

virtual ITechContainer::~ITechContainer ( )
protectedvirtualdefault

Destructor (called only by sub-classes).

Member Function Documentation

◆ allocate()

virtual StatusCode ITechContainer::allocate ( DbContainer & cntH,
const void * object,
const DbTypeInfo * tinfo,
Token::OID_t & oid )
pure virtual

In place allocation of object location.

Implemented in TechContainerBase.

◆ checkAccess()

virtual StatusCode ITechContainer::checkAccess ( DbDatabase & dbH,
const std::string & nam ) const
pure virtual

Check if we can access the container for reading with the given type.

Implemented in RNTupleContainer, RootKeyContainer, and RootTreeContainer.

◆ close()

virtual StatusCode ITechContainer::close ( )
pure virtual

Close the container.

Implemented in RNTupleContainer, RootKeyContainer, RootTreeContainer, and TechContainerBase.

◆ getOption()

virtual StatusCode ITechContainer::getOption ( DbOption & refOpt)
pure virtual

Access options.

Implemented in RNTupleContainer, RootKeyContainer, RootTreeContainer, and TechContainerBase.

◆ load()

virtual StatusCode ITechContainer::load ( void ** ptr,
const DbTypeInfo * tinfo,
const Token::OID_t & lnkH,
Token::OID_t & oid,
bool any_next = false )
pure virtual

Find object within the container and load it into memory.

Parameters
ptr[IN/OUT] ROOT-style address of the pointer to object
tinfo[IN] Object type
linkH[IN] Preferred object OID
oid[OUT] Actual object OID
any_next[IN] On selection, objects may be skipped. If objects are skipped, the actual oid will differ from the preferred oid.
Returns
Status code indicating success or failure.

Implemented in RootKeyContainer, and TechContainerBase.

◆ name()

virtual std::string ITechContainer::name ( ) const
pure virtual

Get container name.

Implemented in TechContainerBase.

◆ next()

virtual StatusCode ITechContainer::next ( Token::OID_t & linkH)
pure virtual

Fetch next object address to set token.

Implemented in RootKeyContainer, and TechContainerBase.

◆ nextRecordId()

virtual uint64_t ITechContainer::nextRecordId ( )
pure virtual

Number of next record in the container (=size if no delete is allowed).

Implemented in RNTupleContainer, RootKeyContainer, RootTreeIndexContainer, and TechContainerBase.

◆ open()

virtual StatusCode ITechContainer::open ( DbDatabase & dbH,
const std::string & nam,
const DbTypeInfo * info,
Io::IoFlag mode )
pure virtual

Open the container.

Implemented in RNTupleContainer, RootKeyContainer, RootTreeContainer, and RootTreeIndexContainer.

◆ release()

virtual void ITechContainer::release ( )
pure virtual

Release the technology specific implementation.

Implemented in TechContainerBase.

◆ setOption()

virtual StatusCode ITechContainer::setOption ( const DbOption & refOpt)
pure virtual

◆ size()

virtual uint64_t ITechContainer::size ( )
pure virtual

Access to container size.

Implemented in RNTupleContainer, RootKeyContainer, RootTreeContainer, and TechContainerBase.

◆ store()

virtual StatusCode ITechContainer::store ( const void * object,
DbContainer & cntH,
const DbTypeInfo * tinfo )
pure virtual

Store object in location.

Implemented in RNTupleContainer, and TechContainerBase.

◆ transAct()

virtual StatusCode ITechContainer::transAct ( Transaction::Action )
pure virtual

◆ useNextRecordId()

virtual void ITechContainer::useNextRecordId ( uint64_t )
pure virtual

Suggest next Record ID for tbe next object written - used only with synced indexes.

Implemented in RNTupleContainer, RootTreeIndexContainer, and TechContainerBase.


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