Manager for auxiliary branches created dynamically. More...

#include <TAuxBranchManager.h>

Inheritance diagram for xAOD::TAuxBranchManager:

Collaboration diagram for xAOD::TAuxBranchManager:

Public Types
typedef SG::auxid_t	auxid_t
	Definition of the auxiliary ID type. More...

Public Member Functions
	TAuxBranchManager (auxid_t auxid, ::TBranch br=0, THolder holder=0)
	Constructor getting hold of a possible branch. More...

	TAuxBranchManager (const TAuxBranchManager &parent)
	Copy constructor. More...

	~TAuxBranchManager ()
	Destructor. More...

TAuxBranchManager &	operator= (const TAuxBranchManager &rhs)
	Assignment operator. More...

::TBranch *	branch ()
	Accessor to the branch. More...

::TBranch **	branchPtr ()
	Pointer to the branch's pointer. More...

const THolder *	holder () const
	Accessor to the Holder object (constant version) More...

THolder *	holder ()
	Accessor to the Holder object. More...

virtual ::Int_t	getEntry (::Int_t getall=0) override
	Function for updating the object in memory if needed. More...

virtual const void *	object () const override
	Function getting a const pointer to the object being handled. More...

virtual void *	object () override
	Function getting a pointer to the object being handled. More...

virtual void	setObject (void *obj) override
	Function replacing the object being handled. More...

virtual ::Bool_t	create () override
	Create the object for the current event. More...

virtual ::Bool_t	isSet () const override
	Check if the object was set for the current event. More...

virtual void	reset () override
	Reset the object at the end of processing of an event. More...

Private Attributes
::TBranch *	m_branch
	Pointer keeping track of the branch. More...

THolder *	m_holder
	Holder object for the EDM object. More...

::Long64_t	m_entry
	The last entry that was loaded for this branch. More...

::Bool_t	m_isSet
	Was the object set for the current event? More...

auxid_t	m_auxId
	Auxiliary variable type. More...

SG::IAuxTypeVector *	m_vector
	Dummy auxiliary variable for the empty events. More...

Detailed Description

Manager for auxiliary branches created dynamically.

This manager class is meant to deal with "simple" auxiliary branches in the xAOD files.

Author: Attila Krasznahorkay Attil.nosp@m.a.Kr.nosp@m.aszna.nosp@m.hork.nosp@m.ay@ce.nosp@m.rn.c.nosp@m.h

Definition at line 34 of file TAuxBranchManager.h.

Member Typedef Documentation

◆ auxid_t

typedef SG::auxid_t xAOD::TAuxBranchManager::auxid_t

Definition of the auxiliary ID type.

Definition at line 38 of file TAuxBranchManager.h.

Constructor & Destructor Documentation

◆ TAuxBranchManager() [1/2]

xAOD::TAuxBranchManager::TAuxBranchManager	(	auxid_t	auxid,
		::TBranch *	br = `0`,
		THolder *	holder = `0`
	)

Constructor getting hold of a possible branch.

Definition at line 18 of file TAuxBranchManager.cxx.

       : m_branch( br ), m_holder( holder ), m_entry( -1 ),
         m_isSet( kTRUE ), m_auxId( auxid ), m_vector( nullptr ) {
    }

◆ TAuxBranchManager() [2/2]

xAOD::TAuxBranchManager::TAuxBranchManager ( const TAuxBranchManager & parent )

Copy constructor.

Definition at line 24 of file TAuxBranchManager.cxx.

       : TVirtualManager(), m_branch( parent.m_branch ), m_holder( nullptr ),
         m_entry( parent.m_entry ), m_isSet( parent.m_isSet ),
         m_auxId( parent.m_auxId ), m_vector( nullptr ) {
  
       if( parent.m_holder ) {
          m_holder = new THolder( *parent.m_holder );
       }
       if( parent.m_vector ) {
          m_vector =
             SG::AuxTypeRegistry::instance().makeVector( m_auxId,
                                                         ( size_t ) 0,
                                                         ( size_t ) 0 ).release();
       }
    }

◆ ~TAuxBranchManager()

xAOD::TAuxBranchManager::~TAuxBranchManager ( )

Destructor.

Definition at line 40 of file TAuxBranchManager.cxx.

                                          {
  
       if( m_holder ) {
          delete m_holder;
       }
       if( m_vector ) {
          delete m_vector;
       }
    }

Member Function Documentation

◆ branch()

TBranch * xAOD::TAuxBranchManager::branch ( )

Accessor to the branch.

Definition at line 82 of file TAuxBranchManager.cxx.

                                       {
  
       return m_branch;
    }

◆ branchPtr()

TBranch ** xAOD::TAuxBranchManager::branchPtr ( )

Pointer to the branch's pointer.

Definition at line 87 of file TAuxBranchManager.cxx.

                                           {
  
       return &m_branch;
    }

◆ create()

Bool_t xAOD::TAuxBranchManager::create ( )

overridevirtual

Create the object for the current event.

Implements xAOD::TVirtualManager.

Definition at line 168 of file TAuxBranchManager.cxx.

                                     {
  
       // If we already have it set, let's stop here:
       if( m_isSet ) return kTRUE;
  
       // Otherwise let's create a default object:
       m_isSet = kTRUE;
       if( ! m_vector ) {
          m_vector =
             SG::AuxTypeRegistry::instance().makeVector( m_auxId,
                                                         ( size_t ) 0,
                                                         ( size_t ) 0 ).release();
       }
       // ...and use it to fill the current event:
       m_holder->setOwner( kFALSE );
       m_holder->set( m_vector->toVector() );
  
       // We are now "set":
       return kTRUE;
    }

◆ getEntry()

Int_t xAOD::TAuxBranchManager::getEntry ( ::Int_t getall = 0 )

overridevirtual

Function for updating the object in memory if needed.

Implements xAOD::TVirtualManager.

Definition at line 102 of file TAuxBranchManager.cxx.

                                                    {
  
       // Make sure that the branch is associated to a tree 
       // as the entry to be read is retrieved from the tree
       if (!m_branch->GetTree()){
          Error("xAOD::TAuxBranchManager::getEntry",
             XAOD_MESSAGE("Branch=%s is not associated to any tree while reading of branches within this class relies on that"),
             m_branch->GetName());
          return -1;
       }
  
       // Get the entry that should be read 
       // The entry to be read is set with TTree::LoadTree()
       // NB: for a branch from a friend tree and if the friend tree has an index built,
       // then the entry to read is found when calling the TTree::LoadTree() function 
       // that matches the major and minor values between the main tree and the friend tree 
       ::Long64_t entry = m_branch->GetTree()->GetReadEntry();
  
       if ( entry  < 0 ){
          // Raise error as it implies 
          // either that the TTree::LoadTree() function has not been called 
          // or 
          // the entry requested to be read by the user 
          // is not corresponding to any entry for the friend tree 
          Error("xAOD::TAuxBranchManager::getEntry", 
             XAOD_MESSAGE( "Entry to read is not set for branch=%s from tree=%s. " 
             "It is either because TTree::LoadTree(entry) was not called "
             "beforehand in the TEvent class OR "
             "the entry requested to be read for the main tree is not corresponding to an event for the friend tree"), 
             m_branch->GetName(),
             m_branch->GetTree()->GetName());
          return -1;
       }
       
       // Check if anything needs to be done:
       if( entry == m_entry ) return 0;
  
       // Load the entry.
       const ::Int_t nbytes = m_branch->GetEntry( entry, getall );
  
       // If the load was successful, remember that we loaded this entry.
       if( nbytes >= 0 ) {
          m_entry = entry;
       }
  
       return nbytes;
    }

◆ holder() [1/2]

THolder * xAOD::TAuxBranchManager::holder ( )

Accessor to the Holder object.

Definition at line 97 of file TAuxBranchManager.cxx.

                                       {
  
       return m_holder;
    }

◆ holder() [2/2]

const THolder * xAOD::TAuxBranchManager::holder ( ) const

Accessor to the Holder object (constant version)

Definition at line 92 of file TAuxBranchManager.cxx.

                                                   {
  
       return m_holder;
    }

◆ isSet()

Bool_t xAOD::TAuxBranchManager::isSet ( ) const

overridevirtual

Check if the object was set for the current event.

Implements xAOD::TVirtualManager.

Definition at line 189 of file TAuxBranchManager.cxx.

                                          {
       return m_isSet;
    }

◆ object() [1/2]

const void * xAOD::TAuxBranchManager::object ( ) const

overridevirtual

Function getting a const pointer to the object being handled.

Implements xAOD::TVirtualManager.

Definition at line 150 of file TAuxBranchManager.cxx.

                                                {
  
       return std::as_const(*m_holder).get();
    }

◆ object() [2/2]

void * xAOD::TAuxBranchManager::object ( )

overridevirtual

Function getting a pointer to the object being handled.

Implements xAOD::TVirtualManager.

Definition at line 155 of file TAuxBranchManager.cxx.

                                    {
  
       return m_holder->get();
    }

◆ operator=()

TAuxBranchManager & xAOD::TAuxBranchManager::operator= ( const TAuxBranchManager & rhs )

Assignment operator.

Definition at line 51 of file TAuxBranchManager.cxx.

                                                               {
  
       // Check if anything needs to be done:
       if( this == &rhs ) {
          return *this;
       }
  
       m_branch = rhs.m_branch;
       if( m_holder ) delete m_holder;
       if( rhs.m_holder ) {
          m_holder = new THolder( *rhs.m_holder );
       } else {
          m_holder = 0;
       }
       m_entry = rhs.m_entry;
       m_isSet = rhs.m_isSet;
       m_auxId = rhs.m_auxId;
       if( m_vector ) delete m_vector;
       if( rhs.m_vector ) {
          m_vector =
             SG::AuxTypeRegistry::instance().makeVector( m_auxId,
                                                         ( size_t ) 0,
                                                         ( size_t ) 0 ).release();
       } else {
          m_vector = 0;
       }
  
       // Return this same object:
       return *this;
    }

◆ reset()

void xAOD::TAuxBranchManager::reset ( )

overridevirtual

Reset the object at the end of processing of an event.

Implements xAOD::TVirtualManager.

Definition at line 193 of file TAuxBranchManager.cxx.

                                  {
  
       m_isSet = kFALSE;
       return;
    }

◆ setObject()

void xAOD::TAuxBranchManager::setObject ( void * obj )

overridevirtual

Function replacing the object being handled.

Implements xAOD::TVirtualManager.

Definition at line 160 of file TAuxBranchManager.cxx.

                                                 {
  
       m_holder->setOwner( kFALSE );
       m_holder->set( obj );
       m_isSet = kTRUE;
       return;
    }

Member Data Documentation

◆ m_auxId

auxid_t xAOD::TAuxBranchManager::m_auxId

private

Auxiliary variable type.

Definition at line 88 of file TAuxBranchManager.h.

◆ m_branch

::TBranch* xAOD::TAuxBranchManager::m_branch

private

Pointer keeping track of the branch.

Definition at line 79 of file TAuxBranchManager.h.

◆ m_entry

::Long64_t xAOD::TAuxBranchManager::m_entry

private

The last entry that was loaded for this branch.

Definition at line 83 of file TAuxBranchManager.h.

◆ m_holder

THolder* xAOD::TAuxBranchManager::m_holder

private

Holder object for the EDM object.

Definition at line 81 of file TAuxBranchManager.h.

◆ m_isSet

::Bool_t xAOD::TAuxBranchManager::m_isSet

private

Was the object set for the current event?

Definition at line 85 of file TAuxBranchManager.h.

◆ m_vector

SG::IAuxTypeVector* xAOD::TAuxBranchManager::m_vector

private

Dummy auxiliary variable for the empty events.

Definition at line 90 of file TAuxBranchManager.h.

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

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ auxid_t

Constructor & Destructor Documentation

◆ TAuxBranchManager() [1/2]

◆ TAuxBranchManager() [2/2]

◆ ~TAuxBranchManager()

Member Function Documentation

◆ branch()

◆ branchPtr()

◆ create()

◆ getEntry()

◆ holder() [1/2]

◆ holder() [2/2]

◆ isSet()

◆ object() [1/2]

◆ object() [2/2]

◆ operator=()

◆ reset()

◆ setObject()

Member Data Documentation

◆ m_auxId

◆ m_branch

◆ m_entry

◆ m_holder

◆ m_isSet

◆ m_vector