python.TPyEvent.TPyEvent Class Reference

A Python wrapper around xAOD.TPyEvent. More...

Inheritance diagram for python.TPyEvent.TPyEvent:

Collaboration diagram for python.TPyEvent.TPyEvent:

Public Member Functions
	__init__ (self, mode=ROOT.xAOD.TEvent.kClassAccess)
	Constructor for the class.
	__getitem__ (self, key)
	Convenient shorthand for retrieving an object.
	contains (self, key, type)
	Convenient version of the base class's contains function.
	transientContains (self, key, type)
	Convenient version of the base class's transientContains function.
	record (self, obj, key)
	Convenient version of the base class's record function.

Detailed Description

A Python wrapper around xAOD.TPyEvent.

In order to make the semi-templated functions of xAOD.TPyEvent more convenient to use from PyROOT, the user is supposed to use an instance of this class, and not ROOT.xAOD.TPyEvent directly.

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 17 of file TPyEvent.py.

Constructor & Destructor Documentation

__init__()

python.TPyEvent.TPyEvent.__init__	(		self,
			mode = ROOT.xAOD.TEvent.kClassAccess )

Constructor for the class.

Definition at line 20 of file TPyEvent.py.

    def __init__( self, mode = ROOT.xAOD.TEvent.kClassAccess ):
 
        # Forward the call to the base class's constructor:
        ROOT.xAOD.TPyEvent.__init__( self, mode )
        return
 

Member Function Documentation

__getitem__()

python.TPyEvent.TPyEvent.__getitem__	(		self,
			key )

Convenient shorthand for retrieving an object.

Definition at line 27 of file TPyEvent.py.

    def __getitem__( self, key ):
        return self.pyRetrieve( key )
 

contains()

python.TPyEvent.TPyEvent.contains	(		self,
			key,
			type )

Convenient version of the base class's contains function.

This function allows the user to, instead of figuring out the exact type name of some C++ type, to rather write code like:

if event.contains( "Electrons", ROOT.xAOD.ElectronContainer ):

Parameters

key	The string key of the object to check for
type	The type of the object we are looking for

Returns

True if the object is available in the event, False if it's not

Definition at line 44 of file TPyEvent.py.

    def contains( self, key, type ):
        # Determine the class name:
        clname = type.__name__
        if hasattr( type, "__cpp_name__" ):
            clname = type.__cpp_name__
            pass
        # Call the parent class's function:
        return super( TPyEvent, self ).pyContains( key, clname )
 

record()

python.TPyEvent.TPyEvent.record	(		self,
			obj,
			key )

Convenient version of the base class's record function.

This is the main function of this wrapper class. It allows the user to record objects into an output file like:

el = ROOT.xAOD.ElectronContainer() event.record( el, "MyElectrons" )

Parameters

obj	The object to be recorded into the output file
key	The key (branch name) for the object

Returns

StatusCode::SUCCESS if all was successful, or StatusCode::FAILURE if not

Definition at line 93 of file TPyEvent.py.

    def record( self, obj, key ):
        # Determine the class name:
        clname = obj.__class__.__name__
        if hasattr( obj.__class__, "__cpp_name__" ):
            clname = obj.__class__.__cpp_name__
            pass
        # Call the parent class's function:
        return super( TPyEvent, self ).pyRecord( obj, key, clname )

transientContains()

python.TPyEvent.TPyEvent.transientContains	(		self,
			key,
			type )

Convenient version of the base class's transientContains function.

This function allows the used to, instead of figuring out the exact type name of some C++ type, to rather write code like:

if event.transientContains( "MyElectrons",
ROOT.xAOD.ElectronContainer ):

Parameters

key	The string key of the object to check for
type	The type of the object we are looking for

Returns

True if the object is available in the event in a modifyable form, False if it's not

Definition at line 68 of file TPyEvent.py.

    def transientContains( self, key, type ):
        # Determine the class name:
        clname = type.__name__
        if hasattr( type, "__cpp_name__" ):
            clname = type.__cpp_name__
            pass
        # Call the parent class's function:
        return super( TPyEvent,
                      self ).pyTransientContains( key, clname )
 

---

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

• TPyEvent.py