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

"Generic" Container implementation More...

#include <StorageSvc/TechContainerBase.h>

Inheritance diagram for TechContainerBase:
Collaboration diagram for TechContainerBase:

Classes

struct  DbAction
 List of actions to execute at commit. More...

Public Member Functions

 TechContainerBase (const std::string &name)
virtual void release () override
 Release instance (Abstract interfaces do not expose destructor!).
virtual uint64_t size () override
 Size of the container.
virtual std::string name () const override
 Get container name.
virtual uint64_t nextRecordId () override
 Number of next record in the container (=size if no delete is allowed).
virtual void useNextRecordId (uint64_t) override
 Suggest next Record ID for tbe next object written - used only with synced indexes.
virtual StatusCode close () override
 Close the container and deallocate resources.
virtual StatusCode getOption (DbOption &opt) override
 Access options.
virtual StatusCode setOption (const DbOption &opt) override
 Set options.
virtual StatusCode transAct (Transaction::Action) override
 Execute Transaction Action.
virtual StatusCode store (const void *object, DbContainer &cntH, const DbTypeInfo *tinfo) override
 Store object in location.
virtual StatusCode allocate (DbContainer &cntH, const void *object, const DbTypeInfo *tinfo, Token::OID_t &oid) override
 In place allocation of object location.
virtual StatusCode next (Token::OID_t &linkH) override
 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) override
 Find object within the container and load it into memory.
virtual StatusCode loadObject (void **ptr, const DbTypeInfo *tinfo, Token::OID_t &oid)=0
 Find object by object identifier and load it into memory.
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.
bool msgLvl (const MSG::Level lvl) const
 Test the output level.
MsgStream & msg () const
 The standard message stream.
MsgStream & msg (const MSG::Level lvl) const
 The standard message stream.
void setLevel (MSG::Level lvl)
 Change the current logging level.

Protected Types

typedef std::vector< DbAction > ActionList

Protected Member Functions

virtual ~TechContainerBase ()=default
 Standard destructor.
virtual StatusCode writeObject (ActionList::value_type &)
 Commit single entry to container.
virtual StatusCode commitTransaction ()
 Execute object modification requests during a transaction.

Protected Attributes

std::string m_name
 Container name.

Private Member Functions

void initMessaging () const
 Initialize our message level and MessageSvc.

Private Attributes

ActionList m_writeStack
 Transaction fifo storage for writing.
size_t m_size
 Current size of the transaction stack.
std::string m_nm
 Message source name.
boost::thread_specific_ptr< MsgStream > m_msg_tls
 MsgStream instance (a std::cout like with print-out levels).
std::atomic< IMessageSvc * > m_imsg { nullptr }
 MessageSvc pointer.
std::atomic< MSG::Level > m_lvl { MSG::NIL }
 Current logging level.
std::atomic_flag m_initialized ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT
 Messaging initialized (initMessaging).

Detailed Description

"Generic" Container implementation

Description: Generic helper class to implement stuff common to all existing Database containers. The base implementations can allways be overwritten.

Author
M.Frank

Definition at line 30 of file TechContainerBase.h.

Member Typedef Documentation

◆ ActionList

typedef std::vector< DbAction > TechContainerBase::ActionList
protected

Definition at line 49 of file TechContainerBase.h.

Constructor & Destructor Documentation

◆ ~TechContainerBase()

virtual TechContainerBase::~TechContainerBase ( )
protectedvirtualdefault

Standard destructor.

◆ TechContainerBase()

TechContainerBase::TechContainerBase ( const std::string & name)
explicit

Member Function Documentation

◆ allocate()

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

In place allocation of object location.

Implements ITechContainer.

◆ checkAccess()

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

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

Implemented in RNTupleContainer, RootKeyContainer, and RootTreeContainer.

◆ close()

virtual StatusCode TechContainerBase::close ( )
overridevirtual

Close the container and deallocate resources.

Implements ITechContainer.

Reimplemented in RNTupleContainer, RootKeyContainer, and RootTreeContainer.

◆ commitTransaction()

virtual StatusCode TechContainerBase::commitTransaction ( )
protectedvirtual

Execute object modification requests during a transaction.

◆ getOption()

virtual StatusCode TechContainerBase::getOption ( DbOption & opt)
overridevirtual

Access options.

Parameters
opt[IN] Reference to option object.
Returns
StatusCode code indicating success or failure.

Implements ITechContainer.

Reimplemented in RNTupleContainer, RootKeyContainer, and RootTreeContainer.

◆ initMessaging()

void AthMessaging::initMessaging ( ) const
privateinherited

Initialize our message level and MessageSvc.

This method should only be called once.

Definition at line 39 of file AthMessaging.cxx.

40{
42 // If user did not set an explicit level, set a default
43 if (m_lvl == MSG::NIL) {
44 m_lvl = m_imsg ?
45 static_cast<MSG::Level>( m_imsg.load()->outputLevel(m_nm) ) :
46 MSG::INFO;
47 }
48}
std::string m_nm
Message source name.
std::atomic< IMessageSvc * > m_imsg
MessageSvc pointer.
std::atomic< MSG::Level > m_lvl
Current logging level.
IMessageSvc * getMessageSvc(bool quiet=false)
int outputLevel(const IMessageSvc *ims, const std::string &source)

◆ load()

virtual StatusCode TechContainerBase::load ( void ** ptr,
const DbTypeInfo * tinfo,
const Token::OID_t & lnkH,
Token::OID_t & oid,
bool any_next )
overridevirtual

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.

Implements ITechContainer.

Reimplemented in RootKeyContainer.

◆ loadObject()

virtual StatusCode TechContainerBase::loadObject ( void ** ptr,
const DbTypeInfo * tinfo,
Token::OID_t & oid )
pure virtual

Find object by object identifier and load it into memory.

Parameters
ptr[IN/OUT] ROOT-style address of the pointer to object
tinfo[IN] Object type
oid[OUT] Object OID
Returns
Status code indicating success or failure.

Implemented in RNTupleContainer, RootKeyContainer, RootTreeContainer, and RootTreeIndexContainer.

◆ msg() [1/2]

MsgStream & AthMessaging::msg ( ) const
inlineinherited

The standard message stream.

Returns a reference to the default message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 167 of file AthMessaging.h.

168{
169 MsgStream* ms = m_msg_tls.get();
170 if (!ms) {
171 if (!m_initialized.test_and_set()) initMessaging();
172 ms = new MsgStream(m_imsg,m_nm);
173 m_msg_tls.reset( ms );
174 }
175
176 ms->setLevel (m_lvl);
177 return *ms;
178}
boost::thread_specific_ptr< MsgStream > m_msg_tls
MsgStream instance (a std::cout like with print-out levels).
void initMessaging() const
Initialize our message level and MessageSvc.

◆ msg() [2/2]

MsgStream & AthMessaging::msg ( const MSG::Level lvl) const
inlineinherited

The standard message stream.

Returns a reference to the default message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 182 of file AthMessaging.h.

183{ return msg() << lvl; }
MsgStream & msg() const
The standard message stream.

◆ msgLvl()

bool AthMessaging::msgLvl ( const MSG::Level lvl) const
inlineinherited

Test the output level.

Parameters
lvlThe message level to test against
Returns
boolean Indicating if messages at given level will be printed
Return values
trueMessages at level "lvl" will be printed

Definition at line 151 of file AthMessaging.h.

152{
153 // If user did not set explicit message level we have to initialize
154 // the messaging and retrieve the default via the MessageSvc.
155 if (m_lvl==MSG::NIL && !m_initialized.test_and_set()) initMessaging();
156
157 if (m_lvl <= lvl) {
158 msg() << lvl;
159 return true;
160 } else {
161 return false;
162 }
163}

◆ name()

virtual std::string TechContainerBase::name ( ) const
inlineoverridevirtual

Get container name.

Implements ITechContainer.

Definition at line 75 of file TechContainerBase.h.

76 { return m_name; }
std::string m_name
Container name.

◆ next()

virtual StatusCode TechContainerBase::next ( Token::OID_t & linkH)
overridevirtual

Fetch next object address to set token.

Implements ITechContainer.

Reimplemented in RootKeyContainer.

◆ nextRecordId()

virtual uint64_t TechContainerBase::nextRecordId ( )
overridevirtual

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

Implements ITechContainer.

Reimplemented in RNTupleContainer, RootKeyContainer, and RootTreeIndexContainer.

◆ open()

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

Open the container.

Implemented in RNTupleContainer, RootKeyContainer, RootTreeContainer, and RootTreeIndexContainer.

◆ release()

virtual void TechContainerBase::release ( )
inlineoverridevirtual

Release instance (Abstract interfaces do not expose destructor!).

Implements ITechContainer.

Definition at line 71 of file TechContainerBase.h.

71{ delete this; }

◆ setLevel()

void AthMessaging::setLevel ( MSG::Level lvl)
inherited

Change the current logging level.

Use this rather than msg().setLevel() for proper operation with MT.

Definition at line 28 of file AthMessaging.cxx.

29{
30 m_lvl = lvl;
31}

◆ setOption()

virtual StatusCode TechContainerBase::setOption ( const DbOption & opt)
overridevirtual

Set options.

Parameters
opt[IN] Reference to option object.
Returns
StatusCode code indicating success or failure.

Implements ITechContainer.

Reimplemented in RNTupleContainer, RootKeyContainer, and RootTreeContainer.

◆ size()

virtual uint64_t TechContainerBase::size ( )
overridevirtual

Size of the container.

Implements ITechContainer.

Reimplemented in RNTupleContainer, RootKeyContainer, and RootTreeContainer.

◆ store()

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

Store object in location.

Implements ITechContainer.

Reimplemented in RNTupleContainer.

◆ transAct()

virtual StatusCode TechContainerBase::transAct ( Transaction::Action )
overridevirtual

Execute Transaction Action.

Implements ITechContainer.

Reimplemented in RNTupleContainer, RootKeyContainer, and RootTreeContainer.

◆ useNextRecordId()

virtual void TechContainerBase::useNextRecordId ( uint64_t )
inlineoverridevirtual

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

Implements ITechContainer.

Reimplemented in RNTupleContainer, and RootTreeIndexContainer.

Definition at line 80 of file TechContainerBase.h.

80{};

◆ writeObject()

virtual StatusCode TechContainerBase::writeObject ( ActionList::value_type & )
inlineprotectedvirtual

Commit single entry to container.

Reimplemented in RNTupleContainer, RootKeyContainer, RootTreeContainer, and RootTreeIndexContainer.

Definition at line 63 of file TechContainerBase.h.

64 { return StatusCode::FAILURE; }

Member Data Documentation

◆ ATLAS_THREAD_SAFE

std::atomic_flag m_initialized AthMessaging::ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT
mutableprivateinherited

Messaging initialized (initMessaging).

Definition at line 141 of file AthMessaging.h.

◆ m_imsg

std::atomic<IMessageSvc*> AthMessaging::m_imsg { nullptr }
mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

135{ nullptr };

◆ m_lvl

std::atomic<MSG::Level> AthMessaging::m_lvl { MSG::NIL }
mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.h.

138{ MSG::NIL };

◆ m_msg_tls

boost::thread_specific_ptr<MsgStream> AthMessaging::m_msg_tls
mutableprivateinherited

MsgStream instance (a std::cout like with print-out levels).

Definition at line 132 of file AthMessaging.h.

◆ m_name

std::string TechContainerBase::m_name
protected

Container name.

Definition at line 58 of file TechContainerBase.h.

◆ m_nm

std::string AthMessaging::m_nm
privateinherited

Message source name.

Definition at line 129 of file AthMessaging.h.

◆ m_size

size_t TechContainerBase::m_size
private

Current size of the transaction stack.

Definition at line 55 of file TechContainerBase.h.

◆ m_writeStack

ActionList TechContainerBase::m_writeStack
private

Transaction fifo storage for writing.

Definition at line 53 of file TechContainerBase.h.


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