asg::SgTEvent Class Reference

Wrapper for TEvent to make it look like StoreGate. More...

#include <SgTEvent.h>

Collaboration diagram for asg::SgTEvent:

Public Member Functions
	SgTEvent (xAOD::TEvent *pevm=0, xAOD::TStore *ptds=0)
	Constructor specifying concrete TEvent and TStore objects. More...
xAOD::TEvent *	event () const
	Return the underlying event manager. More...
xAOD::TStore *	tds () const
	Return the underlying transient data store. More...
Functions providing access to the persistent and transient data
template<typename T >
bool	contains (const std::string &name) const
	Check if an object is available for constant access. More...
template<typename T >
bool	transientContains (const std::string &name) const
	Check if an object is available for non-constant access. More...
template<typename T >
T *	retrieve (const std::string &name) const
	Function retrieving a constant or non-constant object. More...
template<typename T >
StatusCode	retrieve (T *&pobj, const std::string &name)
	Retrieve a container from memory. More...
template<typename T >
StatusCode	retrieve (const T *&pobj, const std::string &name) const
	Retrieve a container from the input file or the memory. More...
template<typename T >
StatusCode	record (std::unique_ptr< T > pobj, const std::string &cname)
	Record an object/container using a smart pointer for ownership. More...
template<typename T >
StatusCode	record (T *pobj, const std::string &cname)
	Record an object/container. More...
template<typename T >
StatusCode	overwrite (T *pobj, const std::string &name, bool allowMods, bool resetOnly=true, bool noHist=false)
	Overwrite an object/container in the transient store. More...
template<typename T >
void	keys (std::vector< std::string > &vkeys) const
	provide list of all keys associated with an object. More...

Private Member Functions
StatusCode	initialize () const
	Function initialising the object. More...

Private Attributes
xAOD::TEvent *	m_pevm
	Pointer to the TEvent that this object interacts with. More...
xAOD::TStore *	m_ptds
	Pointer to the TStore that this object interacts with. More...

Detailed Description

Wrapper for TEvent to make it look like StoreGate.

In order to be able to interact with xAOD::TEvent using the same sort of code that we use to interact with StoreGateSvc in Athena, we wrap it into such an object.

This class also takes care of placing transient objects into xAOD::TStore.

Author

David Adams dlada.nosp@m.ms@b.nosp@m.nl.go.nosp@m.v

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

Revision

669898

Date

2015-05-26 15:49:13 +0200 (Tue, 26 May 2015)

Definition at line 44 of file SgTEvent.h.

Constructor & Destructor Documentation

SgTEvent()

asg::SgTEvent::SgTEvent	(	xAOD::TEvent *	pevm = 0,
		xAOD::TStore *	ptds = 0
	)

Constructor specifying concrete TEvent and TStore objects.

Definition at line 19 of file SgTEvent.cxx.

      : m_pevm( pevm ), m_ptds( ptds ) {
 
   }

Member Function Documentation

contains()

template<typename T >

bool asg::SgTEvent::contains

(

const std::string &

name

)

const

Check if an object is available for constant access.

event()

xAOD::TEvent * asg::SgTEvent::event

(

)

const

Return the underlying event manager.

Definition at line 24 of file SgTEvent.cxx.

                                     {
 
      if( ! m_pevm ) {
         initialize().ignore();
      }
 
      return m_pevm;
   }

initialize()

StatusCode asg::SgTEvent::initialize ( ) const

private

Function initialising the object.

Definition at line 44 of file SgTEvent.cxx.

                                         {
 
      // Return right away if we already have a pointer to both stores:
      if( m_pevm && m_ptds ) {
         return StatusCode::SUCCESS;
      }
 
      // Look for a pointer to the active event if necessary:
      if( ! m_pevm ) {
         // Check if there's an active event:
         xAOD::TVirtualEvent* event = xAOD::TActiveEvent::event();
         if( ! event ) {
            std::cout << ERROR_SOURCE << "Couldn't find an active event in "
                      << "the job" << std::endl;
            return StatusCode::FAILURE;
         }
 
         // This should actually be a TEvent:
         m_pevm = dynamic_cast< xAOD::TEvent* >( event );
         if( ! m_pevm ) {
            std::cout << ERROR_SOURCE << "The active event is not of type "
                      << "xAOD::TEvent?!?" << std::endl;
            return StatusCode::FAILURE;
         }
      }
 
      // Look for a pointer to the active store if necessary:
      if( ! m_ptds ) {
         m_ptds = xAOD::TActiveStore::store();
         if( ! m_ptds ) {
            std::cout << "asg::SgTEvent             WARNING "
                      << "No xAOD::TStore object is available" << std::endl;
         }
      }
 
      // Return gracefully:
      return StatusCode::SUCCESS;
   }

keys()

template<typename T >

void asg::SgTEvent::keys

(

std::vector< std::string > &

vkeys

)

const

provide list of all keys associated with an object.

usage: store->keys(key_vector)

Parameters

a	vector of strings that will be filled with the list of keys

overwrite()

template<typename T >

StatusCode asg::SgTEvent::overwrite	(	T *	pobj,
		const std::string &	name,
		bool	allowMods,
		bool	resetOnly = true,
		bool	noHist = false
	)

Overwrite an object/container in the transient store.

record() [1/2]

template<typename T >

StatusCode asg::SgTEvent::record	(	std::unique_ptr< T >	pobj,
		const std::string &	cname
	)

Record an object/container using a smart pointer for ownership.

record() [2/2]

template<typename T >

StatusCode asg::SgTEvent::record	(	T *	pobj,
		const std::string &	cname
	)

Record an object/container.

retrieve() [1/3]

template<typename T >

T* asg::SgTEvent::retrieve

(

const std::string &

name

)

const

Function retrieving a constant or non-constant object.

retrieve() [2/3]

template<typename T >

StatusCode asg::SgTEvent::retrieve	(	const T *&	pobj,
		const std::string &	name
	)		const

Retrieve a container from the input file or the memory.

retrieve() [3/3]

template<typename T >

StatusCode asg::SgTEvent::retrieve	(	T *&	pobj,
		const std::string &	name
	)

Retrieve a container from memory.

tds()

xAOD::TStore * asg::SgTEvent::tds

(

)

const

Return the underlying transient data store.

Definition at line 33 of file SgTEvent.cxx.

                                   {
 
      // I'm checking the value of m_pevm on purpose. Since m_ptds may be
      // missing under normal circumstances as well.
      if( ! m_pevm ) {
         initialize().ignore();
      }
 
      return m_ptds;
   }

transientContains()

template<typename T >

bool asg::SgTEvent::transientContains

(

const std::string &

name

)

const

Check if an object is available for non-constant access.

Member Data Documentation

m_pevm

xAOD::TEvent* asg::SgTEvent::m_pevm

mutableprivate

Pointer to the TEvent that this object interacts with.

Definition at line 105 of file SgTEvent.h.

m_ptds

xAOD::TStore* asg::SgTEvent::m_ptds

mutableprivate

Pointer to the TStore that this object interacts with.

Definition at line 107 of file SgTEvent.h.

---

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

• SgTEvent.h
• SgTEvent.cxx