Manager for EDM objects created by ROOT. More...

#include <RObjectManager.h>

Inheritance diagram for xAOD::Experimental::RObjectManager:

Collaboration diagram for xAOD::Experimental::RObjectManager:

Public Member Functions
	RObjectManager (ROOT::RNTupleView< void > field, ::Long64_t &entry, THolder *holder=0, ::Bool_t renewOnRead=kFALSE)
	Constructor. More...

	RObjectManager (const RObjectManager &parent)=delete
	Do not allow copy-constructing this object: More...

	~RObjectManager ()
	Destructor. More...

RObjectManager &	operator= (const RObjectManager &parent)=delete
	Do not allow copying this object. More...

const std::string &	fieldName () const
	provide the field name More...

const THolder *	holder () const
	Accessor to the Holder object. 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
ROOT::RNTupleView< void >	m_field
	The typeless object taking care of reading the field. More...

std::unique_ptr< THolder >	m_holder
	Holder object for the EDM object. More...

std::reference_wrapper<::Long64_t >	m_entryToLoad
	Entry number to load next. More...

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

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

::Bool_t	m_renewOnRead
	Should the object be recreated on each read? More...

Detailed Description

Manager for EDM objects created by ROOT.

This class is used when an EDM object is meant to be created by ROOT's schema evolution system, behind the scenes.

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; RD Schaffer R.D.S.nosp@m.chaf.nosp@m.fer@c.nosp@m.ern..nosp@m.ch

Definition at line 43 of file RObjectManager.h.

Constructor & Destructor Documentation

◆ RObjectManager() [1/2]

xAOD::Experimental::RObjectManager::RObjectManager	(	ROOT::RNTupleView< void >	field,
		::Long64_t &	entry,
		THolder *	holder = `0`,
		::Bool_t	renewOnRead = `kFALSE`
	)

Constructor.

Definition at line 20 of file RObjectManager.cxx.

       :
         m_field( std::move( field ) ),
         m_holder( holder ), 
         m_entryToLoad( entry ), m_entry ( -1 ), m_isSet( kTRUE ), m_renewOnRead( renewOnRead ) {
    }

◆ RObjectManager() [2/2]

xAOD::Experimental::RObjectManager::RObjectManager ( const RObjectManager & parent )

delete

Do not allow copy-constructing this object:

◆ ~RObjectManager()

xAOD::Experimental::RObjectManager::~RObjectManager ( )

Destructor.

Definition at line 27 of file RObjectManager.cxx.

27 {}

Member Function Documentation

◆ create()

Bool_t xAOD::Experimental::RObjectManager::create ( )

overridevirtual

Create the object for the current event.

Dummy implementation as full objects can't be missing.

Implements xAOD::TVirtualManager.

Definition at line 115 of file RObjectManager.cxx.

                                  {
  
       return m_isSet;
    }

◆ fieldName()

const std::string & xAOD::Experimental::RObjectManager::fieldName ( ) const

provide the field name

Returns: field name

Definition at line 30 of file RObjectManager.cxx.

                                                     {
       return m_field.GetField().GetFieldName();
    }

◆ getEntry()

Int_t xAOD::Experimental::RObjectManager::getEntry ( ::Int_t getall = 0 )

overridevirtual

Function for updating the object in memory if needed.

This function is used to load the contents of a field only when it needs to be done.

It keeps track of which entry was already loaded for a field/object, and only asks the RNTupleView for the field to load an entry when it really has to be done. The next entry to load (m_entryToLoad) is managed by the owning Event object, set in this object's constructor.

Returns: 0 if no new entry was read, the number of read bytes otherwise

Implements xAOD::TVirtualManager.

Definition at line 56 of file RObjectManager.cxx.

                                                                  {
  
       // Must be valid entry value
       if ( m_entryToLoad  < 0 ){
          // Raise error as a negative entry is incorrect
          Error("xAOD::RObjectManager::getEntry", 
             XAOD_MESSAGE( "Entry to read must be larger than or equal to 0. entry=%i"), static_cast< int >( m_entryToLoad ) );
          return -1;
       }
  
       // Check if anything needs to be done:
       if( m_entryToLoad == m_entry ) return 0;
  
       // Renew the object in memory if we are in such a mode:
       if( m_renewOnRead ) {
          m_holder->renew();
       }
  
       // Load the entry.
       m_field(m_entryToLoad);
  
       // If successful, save entry number
       m_entry = m_entryToLoad;
  
       // For the moment, we don't know how to get 
       // the number of bytes read, so we just return 1
       return 1; 
  
    }

◆ holder() [1/2]

THolder * xAOD::Experimental::RObjectManager::holder ( )

Accessor to the Holder object.

Returns: A pointer to the internal data holding object

Definition at line 43 of file RObjectManager.cxx.

                                    {
  
       return m_holder.get();
    }

◆ holder() [2/2]

const THolder * xAOD::Experimental::RObjectManager::holder ( ) const

Accessor to the Holder object.

Returns: A pointer to the internal data holding object

Definition at line 36 of file RObjectManager.cxx.

                                                {
  
       return m_holder.get();
    }

◆ isSet()

Bool_t xAOD::Experimental::RObjectManager::isSet ( ) const

overridevirtual

Check if the object was set for the current event.

Returns: kTRUE if the object for this event was set, kFALSE otherwise

Implements xAOD::TVirtualManager.

Definition at line 123 of file RObjectManager.cxx.

                                       {
  
       return m_isSet;
    }

◆ object() [1/2]

const void * xAOD::Experimental::RObjectManager::object ( ) const

overridevirtual

Function getting a const pointer to the object being handled.

This function gives an easy access to the object managed by this object.

Returns: A typeless pointer to the object being managed

Implements xAOD::TVirtualManager.

Definition at line 92 of file RObjectManager.cxx.

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

◆ object() [2/2]

void * xAOD::Experimental::RObjectManager::object ( )

overridevirtual

Function getting a pointer to the object being handled.

Implements xAOD::TVirtualManager.

Definition at line 97 of file RObjectManager.cxx.

                                 {
  
       return m_holder->get();
    }

◆ operator=()

RObjectManager& xAOD::Experimental::RObjectManager::operator= ( const RObjectManager & parent )

delete

Do not allow copying this object.

◆ reset()

void xAOD::Experimental::RObjectManager::reset ( )

overridevirtual

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

This function needs to be called after an event was filled into the output TTree.

It tells the manager object that it needs to wait for another object to be set up for the upcoming event.

Implements xAOD::TVirtualManager.

Definition at line 132 of file RObjectManager.cxx.

                               {
  
       m_isSet = kFALSE;
       return;
    }

◆ setObject()

void xAOD::Experimental::RObjectManager::setObject ( void * obj )

overridevirtual

Function replacing the object being handled.

This is just a convenient way of calling THolder::Set from TEvent.

Parameters

obj	The object to replace the previously managed one

Implements xAOD::TVirtualManager.

Definition at line 106 of file RObjectManager.cxx.

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

Member Data Documentation

◆ m_entry

::Long64_t xAOD::Experimental::RObjectManager::m_entry

private

The last entry that was loaded for this field.

Definition at line 90 of file RObjectManager.h.

◆ m_entryToLoad

std::reference_wrapper<::Long64_t> xAOD::Experimental::RObjectManager::m_entryToLoad

private

Entry number to load next.

Definition at line 88 of file RObjectManager.h.

◆ m_field

ROOT::RNTupleView<void> xAOD::Experimental::RObjectManager::m_field

private

The typeless object taking care of reading the field.

Definition at line 84 of file RObjectManager.h.

◆ m_holder

std::unique_ptr<THolder> xAOD::Experimental::RObjectManager::m_holder

private

Holder object for the EDM object.

Definition at line 86 of file RObjectManager.h.

◆ m_isSet

::Bool_t xAOD::Experimental::RObjectManager::m_isSet

private

Was the object set for the current event?

Definition at line 92 of file RObjectManager.h.

◆ m_renewOnRead

::Bool_t xAOD::Experimental::RObjectManager::m_renewOnRead

private

Should the object be recreated on each read?

Definition at line 94 of file RObjectManager.h.

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ RObjectManager() [1/2]

◆ RObjectManager() [2/2]

◆ ~RObjectManager()

Member Function Documentation

◆ create()

◆ fieldName()

◆ getEntry()

◆ holder() [1/2]

◆ holder() [2/2]

◆ isSet()

◆ object() [1/2]

◆ object() [2/2]

◆ operator=()

◆ reset()

◆ setObject()

Member Data Documentation

◆ m_entry

◆ m_entryToLoad

◆ m_field

◆ m_holder

◆ m_isSet

◆ m_renewOnRead