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

#include <src/RootTreeContainer.h>

Inheritance diagram for pool::RootTreeContainer:

Collaboration diagram for pool::RootTreeContainer:

Classes
struct	BranchDesc
	Definiton of a branch descriptor. More...

Public Member Functions
	RootTreeContainer (const std::string &name)
virtual	~RootTreeContainer ()
virtual DbStatus	close () override
	Close the container and deallocate resources.
virtual DbStatus	open (DbDatabase &dbH, const std::string &nam, const DbTypeInfo *info, DbAccessMode mod) override
	Open the container for object access.
virtual DbStatus	checkAccess (DbDatabase &dbH, const std::string &nam) const override final
	Check if we can access the container for reading with the given type.
virtual DbStatus	getOption (DbOption &opt) override
	Access options.
virtual DbStatus	setOption (const DbOption &opt) override
	Set options.
virtual uint64_t	size () override
	Number of entries within the container.
TTree *	getTTree ()
	return the TTree in which this container is stored
const std::string &	getName () const
	return the name of the container
bool	isBranchContainer () const
	is this a container in a TBranch? (regular ones take the whole TTree)
void	setTreeFillMode (bool mode)
	set Tree Filling mode (true/false) for branch containers
bool	usingTreeFillMode () const
	return true if this branch container is using TTree Filling mode
bool	isDirty () const
	return true if this branch container was updated and it's TTree needs to be Filled
void	clearDirty ()
	clear the dirty status (used after containing TTree was Filled)
virtual DbStatus	loadObject (void **ptr, ShapeH shape, Token::OID_t &oid) override
	Find object by object identifier and load it into memory.
virtual DbStatus	writeObject (ActionList::value_type &) override
	Commit single entry to container.
virtual DbStatus	transAct (Transaction::Action action) override
	Execute Transaction action.
virtual void	release () override
	Release instance (Abstract interfaces do not expose destructor!)
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 DbStatus	store (const void *object, DbContainer &cntH, ShapeH shape) override
	Store object in location.
virtual DbStatus	allocate (DbContainer &cntH, const void *object, ShapeH shape, Token::OID_t &oid) override
	In place allocation of object location.
virtual DbStatus	next (Token::OID_t &linkH) override
	Fetch next object address to set token.
virtual DbStatus	load (void **ptr, ShapeH shape, const Token::OID_t &lnkH, Token::OID_t &oid, bool any_next) override
	Find object within the container and load it into memory.
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< BranchDesc >	Branches
	Definition of the branch container.
typedef std::vector< DbAction >	ActionList

Protected Member Functions
virtual DbStatus	commitTransaction ()
	Execute object modification requests during a transaction.

Protected Attributes
TTree *	m_tree
	Reference to the root tree object.
const DbTypeInfo *	m_type
	reference to exact type description
Branches	m_branches
	Branch map.
DbDatabase	m_dbH
	Parent Database handle.
RootDatabase *	m_rootDb
	Root database file reference.
std::string	m_branchName
	Branch name, if branch is specified by user.
int	m_ioBytes
	Number of bytes written/read during last operation. Set to -1 if it failed.
bool	m_treeFillMode
	if True, branch container will not use Branch->Fill() but will be filled with its Tree by the database instance
bool	m_isDirty
	flag set when a branch container was updated (but the branch was not Filled)
std::unique_ptr< RootAuxDynIO::IFactoryTool >	m_auxDynTool
	Factory object from AuxDynIO plugin that creates AuxDyn readers and writers.
std::string	m_name
	Container name.

Private Member Functions
DbStatus	addBranch (const DbColumn *col, BranchDesc &dsc, const std::string &desc)
	Add item branch.
DbStatus	addObject (DbDatabase &dbH, const DbColumn *col, BranchDesc &dsc, const std::string &desc, int splitLevel, int bufferSize, int branchOffsetTabLen)
	Add BLOB.
DbStatus	finishTransAct ()
TBranch *	branch (const std::string &nam) const
	Access branch by name.
void	setBranchOffsetTabLen (TBranch *b, int offsettab_len)
	Recursively set Offset Table length for a branch and it's subbranches.
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

Description: ROOT specific implementation of Database container.

Since objects in root are stored in "trees with branches", this object corresponds to 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 M.Nowak

Definition at line 59 of file RootTreeContainer.h.

Member Typedef Documentation

◆ ActionList

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

protectedinherited

Definition at line 63 of file DbContainerImp.h.

◆ Branches

typedef std::vector<BranchDesc> pool::RootTreeContainer::Branches

protected

Definition of the branch container.

Definition at line 93 of file RootTreeContainer.h.

Constructor & Destructor Documentation

◆ RootTreeContainer()

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

explicit

◆ ~RootTreeContainer()

virtual pool::RootTreeContainer::~RootTreeContainer ( )

virtual

Member Function Documentation

◆ addBranch()

DbStatus pool::RootTreeContainer::addBranch	(	const DbColumn *	col,
		BranchDesc &	dsc,
		const std::string &	desc )

private

Add item branch.

◆ addObject()

DbStatus pool::RootTreeContainer::addObject	(	DbDatabase &	dbH,
		const DbColumn *	col,
		BranchDesc &	dsc,
		const std::string &	desc,
		int	splitLevel,
		int	bufferSize,
		int	branchOffsetTabLen )

private

Add BLOB.

◆ allocate()

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

overridevirtualinherited

In place allocation of object location.

Implements pool::IDbContainer.

◆ branch()

TBranch * pool::RootTreeContainer::branch ( const std::string & nam ) const

private

Access branch by name.

◆ checkAccess()

virtual DbStatus pool::RootTreeContainer::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.

◆ clearDirty()

void pool::RootTreeContainer::clearDirty ( )

inline

clear the dirty status (used after containing TTree was Filled)

Definition at line 195 of file RootTreeContainer.h.

195{ m_isDirty = false; }

pool::RootTreeContainer::m_isDirty

bool m_isDirty

flag set when a branch container was updated (but the branch was not Filled)

Definition RootTreeContainer.h:112

◆ close()

virtual DbStatus pool::RootTreeContainer::close ( )

overridevirtual

Close the container and deallocate resources.

Reimplemented from pool::DbContainerImp.

◆ commitTransaction()

virtual DbStatus pool::DbContainerImp::commitTransaction ( )

protectedvirtualinherited

Execute object modification requests during a transaction.

◆ finishTransAct()

DbStatus pool::RootTreeContainer::finishTransAct ( )

private

◆ getName()

const std::string & pool::RootTreeContainer::getName ( ) const

inline

return the name of the container

Definition at line 180 of file RootTreeContainer.h.

180{ return m_name; }

pool::DbContainerImp::m_name

std::string m_name

Container name.

Definition DbContainerImp.h:72

◆ getOption()

virtual DbStatus pool::RootTreeContainer::getOption ( DbOption & opt )

overridevirtual

Access options.

Parameters

opt	[IN] Reference to option object.

Returns: DbStatus code indicating success or failure.

Reimplemented from pool::DbContainerImp.

◆ getTTree()

TTree * pool::RootTreeContainer::getTTree ( )

inline

return the TTree in which this container is stored

Definition at line 177 of file RootTreeContainer.h.

177{ return m_tree; }

pool::RootTreeContainer::m_tree

TTree * m_tree

Reference to the root tree object.

Definition RootTreeContainer.h:96

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

◆ isBranchContainer()

bool pool::RootTreeContainer::isBranchContainer ( ) const

inline

is this a container in a TBranch? (regular ones take the whole TTree)

Definition at line 183 of file RootTreeContainer.h.

183{ return !m_branchName.empty(); }

pool::RootTreeContainer::m_branchName

std::string m_branchName

Branch name, if branch is specified by user.

Definition RootTreeContainer.h:106

◆ isDirty()

bool pool::RootTreeContainer::isDirty ( ) const

inline

return true if this branch container was updated and it's TTree needs to be Filled

Definition at line 192 of file RootTreeContainer.h.

192{ return m_isDirty; }

◆ load()

virtual DbStatus pool::DbContainerImp::load	(	void **	ptr,
		ShapeH	shape,
		const Token::OID_t &	lnkH,
		Token::OID_t &	oid,
		bool	any_next )

overridevirtualinherited

Find object within the container and load it into memory.

Parameters

ptr	[IN/OUT] ROOT-style address of the pointer to object
shape	[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 pool::IDbContainer.

Reimplemented in pool::RootKeyContainer.

◆ loadObject()

virtual DbStatus pool::RootTreeContainer::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.

Reimplemented in pool::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 163 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 178 of file AthMessaging.h.

179{ return msg() << lvl; }

AthMessaging::msg

MsgStream & msg() const

The standard message stream.

Definition AthMessaging.h:163

◆ 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 (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 89 of file DbContainerImp.h.

90 { return m_name; }

◆ next()

virtual DbStatus pool::DbContainerImp::next ( Token::OID_t & linkH )

overridevirtualinherited

Fetch next object address to set token.

Implements pool::IDbContainer.

Reimplemented in pool::RootKeyContainer.

◆ nextRecordId()

virtual uint64_t pool::DbContainerImp::nextRecordId ( )

overridevirtualinherited

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

Implements pool::IDbContainer.

Reimplemented in pool::RootKeyContainer, pool::RootTreeIndexContainer, and RNTupleContainer.

◆ open()

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

overridevirtual

Open the container for object access.

Implements pool::IDbContainer.

Reimplemented in pool::RootTreeIndexContainer.

◆ release()

virtual void pool::DbContainerImp::release ( )

inlineoverridevirtualinherited

Release instance (Abstract interfaces do not expose destructor!)

Implements pool::IDbContainer.

Definition at line 85 of file DbContainerImp.h.

85{ delete this; }

◆ setBranchOffsetTabLen()

void pool::RootTreeContainer::setBranchOffsetTabLen	(	TBranch *	b,
		int	offsettab_len )

private

Recursively set Offset Table length for a branch and it's subbranches.

◆ 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 DbStatus pool::RootTreeContainer::setOption ( const DbOption & opt )

overridevirtual

Set options.

Parameters

opt	[IN] Reference to option object.

Returns: DbStatus code indicating success or failure.

Reimplemented from pool::DbContainerImp.

◆ setTreeFillMode()

void pool::RootTreeContainer::setTreeFillMode ( bool mode )

set Tree Filling mode (true/false) for branch containers

◆ size()

virtual uint64_t pool::RootTreeContainer::size ( )

overridevirtual

Number of entries within the container.

Reimplemented from pool::DbContainerImp.

◆ store()

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

overridevirtualinherited

Store object in location.

Implements pool::IDbContainer.

Reimplemented in RNTupleContainer.

◆ transAct()

virtual DbStatus pool::RootTreeContainer::transAct ( Transaction::Action action )

overridevirtual

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 94 of file DbContainerImp.h.

94{};

◆ usingTreeFillMode()

bool pool::RootTreeContainer::usingTreeFillMode ( ) const

inline

return true if this branch container is using TTree Filling mode

Definition at line 189 of file RootTreeContainer.h.

189{ return m_treeFillMode; }

pool::RootTreeContainer::m_treeFillMode

bool m_treeFillMode

if True, branch container will not use Branch->Fill() but will be filled with its Tree by the databas...

Definition RootTreeContainer.h:110

◆ writeObject()

virtual DbStatus pool::RootTreeContainer::writeObject ( ActionList::value_type & )

overridevirtual

Commit single entry to container.

Reimplemented from pool::DbContainerImp.

Reimplemented in pool::RootTreeIndexContainer.

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_auxDynTool

std::unique_ptr<RootAuxDynIO::IFactoryTool> pool::RootTreeContainer::m_auxDynTool

protected

Factory object from AuxDynIO plugin that creates AuxDyn readers and writers.

Definition at line 115 of file RootTreeContainer.h.

◆ m_branches

Branches pool::RootTreeContainer::m_branches

protected

Branch map.

Definition at line 100 of file RootTreeContainer.h.

◆ m_branchName

std::string pool::RootTreeContainer::m_branchName

protected

Branch name, if branch is specified by user.

Definition at line 106 of file RootTreeContainer.h.

◆ m_dbH

DbDatabase pool::RootTreeContainer::m_dbH

protected

Parent Database handle.

Definition at line 102 of file RootTreeContainer.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::RootTreeContainer::m_ioBytes

protected

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

Definition at line 108 of file RootTreeContainer.h.

◆ m_isDirty

bool pool::RootTreeContainer::m_isDirty

protected

flag set when a branch container was updated (but the branch was not Filled)

Definition at line 112 of file RootTreeContainer.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 72 of file DbContainerImp.h.

◆ m_nm

std::string AthMessaging::m_nm

privateinherited

Message source name.

Definition at line 129 of file AthMessaging.h.

◆ m_rootDb

RootDatabase* pool::RootTreeContainer::m_rootDb

protected

Root database file reference.

Definition at line 104 of file RootTreeContainer.h.

◆ m_size

size_t pool::DbContainerImp::m_size

privateinherited

Current size of the transaction stack.

Definition at line 69 of file DbContainerImp.h.

◆ m_tree

TTree* pool::RootTreeContainer::m_tree

protected

Reference to the root tree object.

Definition at line 96 of file RootTreeContainer.h.

◆ m_treeFillMode

bool pool::RootTreeContainer::m_treeFillMode

protected

if True, branch container will not use Branch->Fill() but will be filled with its Tree by the database instance

Definition at line 110 of file RootTreeContainer.h.

◆ m_type

const DbTypeInfo* pool::RootTreeContainer::m_type

protected

reference to exact type description

Definition at line 98 of file RootTreeContainer.h.

◆ m_writeStack

ActionList pool::DbContainerImp::m_writeStack

privateinherited

Transaction fifo storage for writing.

Definition at line 67 of file DbContainerImp.h.

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

RootTreeContainer.h

Classes

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ActionList

◆ Branches

Constructor & Destructor Documentation

◆ RootTreeContainer()

◆ ~RootTreeContainer()

Member Function Documentation

◆ addBranch()

◆ addObject()

◆ allocate()

◆ branch()

◆ checkAccess()

◆ clearDirty()

◆ close()

◆ commitTransaction()

◆ finishTransAct()

◆ getName()

◆ getOption()

◆ getTTree()

◆ initMessaging()

◆ isBranchContainer()

◆ isDirty()

◆ load()

◆ loadObject()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ name()

◆ next()

◆ nextRecordId()

◆ open()

◆ release()

◆ setBranchOffsetTabLen()

◆ setLevel()

◆ setOption()

◆ setTreeFillMode()

◆ size()

◆ store()

◆ transAct()

◆ useNextRecordId()

◆ usingTreeFillMode()

◆ writeObject()

Member Data Documentation

◆ ATLAS_THREAD_SAFE

◆ m_auxDynTool

◆ m_branches

◆ m_branchName

◆ m_dbH

◆ m_imsg

◆ m_ioBytes

◆ m_isDirty

◆ m_lvl

◆ m_msg_tls

◆ m_name

◆ m_nm

◆ m_rootDb

◆ m_size

◆ m_tree

◆ m_treeFillMode

◆ m_type

◆ m_writeStack