Description: ROOT specific implementation of Database container. More...

#include <src/RootKeyContainer.h>

Inheritance diagram for pool::RootKeyContainer:

Collaboration diagram for pool::RootKeyContainer:

Public Member Functions
	RootKeyContainer (const std::string &name)
virtual	~RootKeyContainer ()
	RootKeyContainer (const RootKeyContainer &)=delete
RootKeyContainer &	operator= (const RootKeyContainer &)=delete
virtual StatusCode	close () override
	Close the container and deallocate resources.
virtual StatusCode	open (DbDatabase &dbH, const std::string &nam, const DbTypeInfo *info, DbAccessMode mod) override
	Open the container for object access.
virtual StatusCode	checkAccess (DbDatabase &dbH, const std::string &nam) const override final
	Check if we can access the container for reading with the given type.
virtual uint64_t	size () override
	Number of entries within the container.
virtual uint64_t	nextRecordId () override
	Number of record in the container.
virtual StatusCode	next (Token::OID_t &linkH) override
	Fetch next object address to set token.
virtual StatusCode	loadObject (void **ptr, ShapeH shape, Token::OID_t &oid) override
	Find object by object identifier and load it into memory.
virtual StatusCode	load (void **ptr, ShapeH shape, const Token::OID_t &linkH, Token::OID_t &oid, bool any_next) override
	Interface Implementation: Find entry in container.
virtual StatusCode	getOption (DbOption &opt) override
	Access options.
virtual StatusCode	setOption (const DbOption &opt) override
	Set options.
virtual StatusCode	transAct (Transaction::Action action) override
	Execute end of object modification requests during a transaction.
virtual void	release () override
	Release instance (Abstract interfaces do not expose destructor!)
virtual std::string	name () const override
	Get container name.
virtual void	useNextRecordId (uint64_t) override
	Suggest next Record ID for tbe next object written - used only with synced indexes.
virtual StatusCode	store (const void *object, DbContainer &cntH, ShapeH shape) override
	Store object in location.
virtual StatusCode	allocate (DbContainer &cntH, const void *object, ShapeH shape, Token::OID_t &oid) override
	In place allocation of object location.
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 StatusCode	writeObject (ActionList::value_type &) override
	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
TDirectory *	m_dir
	Reference to the root tree object.
DbDatabase	m_dbH
	Parent Database handle.
RootDatabase *	m_rootDb
	Root database file reference.
RootKeyIOHandler *	m_ioHandler
	CINT IO handler to allow user overloads....
int	m_policy
	Policy flag.
int	m_ioBytes
	Number of bytes written/read during last operation. Set to -1 if it failed.
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

Description: ROOT specific implementation of Database container.

Since objects in root are stored in "trees with branches", this object corresponds top a tuple (Tree/Branch), where each object type (determined by the location of the transient object within the data store) is accessed by the "Event" number inside its tree.

Author: M.Frank

Date: 1/8/2002

Version: 1.0

Definition at line 45 of file RootKeyContainer.h.

Member Typedef Documentation

◆ ActionList

typedef std::vector< DbAction > pool::DbContainerImp::ActionList

protectedinherited

Definition at line 64 of file DbContainerImp.h.

Constructor & Destructor Documentation

◆ RootKeyContainer() [1/2]

pool::RootKeyContainer::RootKeyContainer ( const std::string & name )

explicit

◆ ~RootKeyContainer()

virtual pool::RootKeyContainer::~RootKeyContainer ( )

virtual

◆ RootKeyContainer() [2/2]

pool::RootKeyContainer::RootKeyContainer ( const RootKeyContainer & )

delete

Member Function Documentation

◆ allocate()

virtual StatusCode pool::DbContainerImp::allocate	(	DbContainer &	cntH,
		const void *	object,
		ShapeH	shape,
		Token::OID_t &	oid )

overridevirtualinherited

In place allocation of object location.

Implements pool::IDbContainer.

◆ checkAccess()

virtual StatusCode pool::RootKeyContainer::checkAccess	(	DbDatabase &	dbH,
		const std::string &	nam ) const

finaloverridevirtual

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

Implements pool::IDbContainer.

◆ close()

virtual StatusCode pool::RootKeyContainer::close ( )

overridevirtual

Close the container and deallocate resources.

Reimplemented from pool::DbContainerImp.

◆ commitTransaction()

virtual StatusCode pool::DbContainerImp::commitTransaction ( )

protectedvirtualinherited

Execute object modification requests during a transaction.

◆ getOption()

virtual StatusCode pool::RootKeyContainer::getOption ( DbOption & opt )

overridevirtual

Access options.

Parameters

opt	[IN] Reference to option object.

Returns: StatusCode code indicating success or failure.

Reimplemented from pool::DbContainerImp.

◆ 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.

{
  m_imsg = Athena::getMessageSvc();
  // If user did not set an explicit level, set a default
  if (m_lvl == MSG::NIL) {
    m_lvl = m_imsg ?
      static_cast<MSG::Level>( m_imsg.load()->outputLevel(m_nm) ) :
      MSG::INFO;
  }
}

◆ load()

virtual StatusCode pool::RootKeyContainer::load	(	void **	ptr,
		ShapeH	shape,
		const Token::OID_t &	linkH,
		Token::OID_t &	oid,
		bool	any_next )

overridevirtual

Interface Implementation: Find entry in container.

Reimplemented from pool::DbContainerImp.

◆ loadObject()

virtual StatusCode pool::RootKeyContainer::loadObject	(	void **	ptr,
		ShapeH	shape,
		Token::OID_t &	oid )

overridevirtual

Find object by object identifier and load it into memory.

Parameters

ptr	[IN/OUT] ROOT-style address of the pointer to object
shape	[IN] Object type
oid	[OUT] Object OID

Returns: Status code indicating success or failure.

Implements pool::DbContainerImp.

◆ 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.

{
  MsgStream* ms = m_msg_tls.get();
  if (!ms) {
    if (!m_initialized.test_and_set()) initMessaging();
    ms = new MsgStream(m_imsg,m_nm);
    m_msg_tls.reset( ms );
  }
 
  ms->setLevel (m_lvl);
  return *ms;
}

◆ 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; }

AthMessaging::msg

MsgStream & msg() const

The standard message stream.

Definition AthMessaging.h:167

◆ msgLvl()

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

inlineinherited

Test the output level.

Parameters

lvl	The message level to test against

Returns: boolean Indicating if messages at given level will be printed

Return values

true	Messages at level "lvl" will be printed

Definition at line 151 of file AthMessaging.h.

{
  // If user did not set explicit message level we have to initialize
  // the messaging and retrieve the default via the MessageSvc.
  if (m_lvl==MSG::NIL && !m_initialized.test_and_set()) initMessaging();
 
  if (m_lvl <= lvl) {
    msg() << lvl;
    return true;
  } else {
    return false;
  }
}

◆ name()

virtual std::string pool::DbContainerImp::name ( ) const

inlineoverridevirtualinherited

Get container name.

Implements pool::IDbContainer.

Definition at line 90 of file DbContainerImp.h.

91 { return m_name; }

pool::DbContainerImp::m_name

std::string m_name

Container name.

Definition DbContainerImp.h:73

◆ next()

virtual StatusCode pool::RootKeyContainer::next ( Token::OID_t & linkH )

overridevirtual

Fetch next object address to set token.

Reimplemented from pool::DbContainerImp.

◆ nextRecordId()

virtual uint64_t pool::RootKeyContainer::nextRecordId ( )

overridevirtual

Number of record in the container.

Reimplemented from pool::DbContainerImp.

◆ open()

virtual StatusCode pool::RootKeyContainer::open	(	DbDatabase &	dbH,
		const std::string &	nam,
		const DbTypeInfo *	info,
		DbAccessMode	mod )

overridevirtual

Open the container for object access.

Implements pool::IDbContainer.

◆ operator=()

RootKeyContainer & pool::RootKeyContainer::operator= ( const RootKeyContainer & )

delete

◆ release()

virtual void pool::DbContainerImp::release ( )

inlineoverridevirtualinherited

Release instance (Abstract interfaces do not expose destructor!)

Implements pool::IDbContainer.

Definition at line 86 of file DbContainerImp.h.

86{ 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.

{
  m_lvl = lvl;
}

◆ setOption()

virtual StatusCode pool::RootKeyContainer::setOption ( const DbOption & opt )

overridevirtual

Set options.

Parameters

opt	[IN] Reference to option object.

Returns: StatusCode code indicating success or failure.

Reimplemented from pool::DbContainerImp.

◆ size()

virtual uint64_t pool::RootKeyContainer::size ( )

overridevirtual

Number of entries within the container.

Reimplemented from pool::DbContainerImp.

◆ store()

virtual StatusCode pool::DbContainerImp::store	(	const void *	object,
		DbContainer &	cntH,
		ShapeH	shape )

overridevirtualinherited

Store object in location.

Implements pool::IDbContainer.

Reimplemented in RNTupleContainer.

◆ transAct()

virtual StatusCode pool::RootKeyContainer::transAct ( Transaction::Action action )

overridevirtual

Execute end of object modification requests during a transaction.

Parameters

refTr [IN] Transaction reference

Returns: StatusCode code indicating success or failure. Execute transaction action

Reimplemented from pool::DbContainerImp.

◆ useNextRecordId()

virtual void pool::DbContainerImp::useNextRecordId ( uint64_t )

inlineoverridevirtualinherited

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

Implements pool::IDbContainer.

Reimplemented in pool::RootTreeIndexContainer, and RNTupleContainer.

Definition at line 95 of file DbContainerImp.h.

95{};

◆ writeObject()

virtual StatusCode pool::RootKeyContainer::writeObject ( ActionList::value_type & )

overrideprotectedvirtual

Commit single entry to container.

Reimplemented from pool::DbContainerImp.

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_dbH

DbDatabase pool::RootKeyContainer::m_dbH

private

Parent Database handle.

Definition at line 49 of file RootKeyContainer.h.

◆ m_dir

TDirectory* pool::RootKeyContainer::m_dir

private

Reference to the root tree object.

Definition at line 47 of file RootKeyContainer.h.

◆ m_imsg

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

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

135{ nullptr };

◆ m_ioBytes

int pool::RootKeyContainer::m_ioBytes

private

Number of bytes written/read during last operation. Set to -1 if it failed.

Definition at line 57 of file RootKeyContainer.h.

◆ m_ioHandler

RootKeyIOHandler* pool::RootKeyContainer::m_ioHandler

private

CINT IO handler to allow user overloads....

Definition at line 53 of file RootKeyContainer.h.

◆ 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 pool::DbContainerImp::m_name

protectedinherited

Container name.

Definition at line 73 of file DbContainerImp.h.

◆ m_nm

std::string AthMessaging::m_nm

privateinherited

Message source name.

Definition at line 129 of file AthMessaging.h.

◆ m_policy

int pool::RootKeyContainer::m_policy

private

Policy flag.

Definition at line 55 of file RootKeyContainer.h.

◆ m_rootDb

RootDatabase* pool::RootKeyContainer::m_rootDb

private

Root database file reference.

Definition at line 51 of file RootKeyContainer.h.

◆ m_size

size_t pool::DbContainerImp::m_size

privateinherited

Current size of the transaction stack.

Definition at line 70 of file DbContainerImp.h.

◆ m_writeStack

ActionList pool::DbContainerImp::m_writeStack

privateinherited

Transaction fifo storage for writing.

Definition at line 68 of file DbContainerImp.h.

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

RootKeyContainer.h

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ActionList

Constructor & Destructor Documentation

◆ RootKeyContainer() [1/2]

◆ ~RootKeyContainer()

◆ RootKeyContainer() [2/2]

Member Function Documentation

◆ allocate()

◆ checkAccess()

◆ close()

◆ commitTransaction()

◆ getOption()

◆ initMessaging()

◆ load()

◆ loadObject()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ name()

◆ next()

◆ nextRecordId()

◆ open()

◆ operator=()

◆ release()

◆ setLevel()

◆ setOption()

◆ size()

◆ store()

◆ transAct()

◆ useNextRecordId()

◆ writeObject()

Member Data Documentation

◆ ATLAS_THREAD_SAFE

◆ m_dbH

◆ m_dir

◆ m_imsg

◆ m_ioBytes

◆ m_ioHandler

◆ m_lvl

◆ m_msg_tls

◆ m_name

◆ m_nm

◆ m_policy

◆ m_rootDb

◆ m_size

◆ m_writeStack