xAOD::IParticle Class Reference

#include <IParticle.h>

Inheritance diagram for xAOD::IParticle:

Public Member Functions
virtual	~IParticle ()
	Virtual destructor, to make vtable happy...
virtual Type::ObjectType	type () const =0
	The type of the object as a simple enumeration.
Functions for getting and setting user properties

template<class T >
T &	auxdata (const std::string &name, const std::string &clsname="")
template<class T >
const T &	auxdata (const std::string &name, const std::string &clsname="") const
template<class T >
bool	isAvailable (const std::string &name, const std::string &clsname="") const
template<class T >
bool	isAvailableWritable (const std::string &name, const std::string &clsname="") const
Functions describing the 4-momentum of the object

typedef TLorentzVector	FourMom_t
	Definition of the 4-momentum type.
virtual double	pt () const =0
	The transverse momentum () of the particle.
virtual double	eta () const =0
	The pseudorapidity ( $\eta$ ) of the particle.
virtual double	phi () const =0
	The azimuthal angle ( $\phi$ ) of the particle.
virtual double	m () const =0
	The invariant mass of the particle.
virtual double	e () const =0
	The total energy of the particle.
virtual double	rapidity () const =0
	The true rapidity (y) of the particle.
virtual const FourMom_t &	p4 () const =0
	The full 4-momentum of the particle.

Detailed Description

Class providing the definition of the 4-vector interface

All particle-like classes in the xAOD EDM inherit from this simple interface class to make it simple to write generic analysis code for the objects.

Author:: Andy Buckley <Andy.Buckley@cern.ch>; Till Eifert <Till.Eifert@cern.ch>; Markus Elsing <Markus.Elsing@cern.ch>; Dag Gillberg <Dag.Gillberg@cern.ch>; Karsten Koeneke <karstenkoeneke@gmail.com>; Attila Krasznahorkay <Attila.Krasznahorkay@cern.ch>; Edward Moyse <Edward.Moyse@cern.ch>

Revision: 604340

Date: 2014-07-01 06:04:52 +0200 (Tue, 01 Jul 2014)

Member Function Documentation

template<class T >

template const uint8_t & xAOD::IParticle::auxdata< uint8_t >	(	const std::string &	name,
		const std::string &	clsname = `""`
	)			const `[inline]`

Fetch an aux data variable, as a const reference

This function provides an easy way for users to retrieve auxiliary decorations from an object.

Take note that this function is slow. Should not be used inside time-critical code.

Parameters:

	name	Name of the aux variable
	clsname	The name of the associated class. May be blank

Returns:: A constant reference to the decoration

Reimplemented from SG::AuxElement.

template<class T >

template uint8_t & xAOD::IParticle::auxdata< uint8_t >	(	const std::string &	name,
		const std::string &	clsname = `""`
	)			`[inline]`

Fetch an aux data variable, as a non-const reference

This function provides an easy way for users to decorate objects with auxiliary data.

Take note that this function is slow. Should not be used inside time-critical code.

Parameters:

	name	Name of the aux variable
	clsname	The name of the associated class. May be blank

Returns:: A modifyable reference to the decoration

Reimplemented from SG::AuxElement.

template<class T >

template bool xAOD::IParticle::isAvailable< uint8_t >	(	const std::string &	name,
		const std::string &	clsname = `""`
	)			const `[inline]`

Check if a user property is available for reading or not

This function should be used to check if a user property which may or may not exist, is set on the object.

Parameters:

	name	Name of the auxiliary variable
	clsname	The name of the associated class. May be blank

Returns:: Whether the decoration exists or not

Reimplemented from SG::AuxElement.

template<class T >

bool xAOD::IParticle::isAvailableWritable	(	const std::string &	name,
		const std::string &	clsname = `""`
	)			const `[inline]`

Check if a user property is available for writing or not

This function can be used to check whether it will be possible to set a user property on the object.

Parameters:

	name	Name of the auxiliary variable
	clsname	The name of the associated class. May be blank

Returns:: Whether the decoration is possible to set

Reimplemented from SG::AuxElement.

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

/cvmfs/atlas.cern.ch/repo/sw/ASG/AnalysisBase/2.4.28/xAODBase/xAODBase/IParticle.h
/cvmfs/atlas.cern.ch/repo/sw/ASG/AnalysisBase/2.4.28/xAODBase/xAODBase/xAODBaseDict.h

xAOD::IParticle Class Reference

Public Member Functions

Functions describing the 4-momentum of the object

Detailed Description

Member Function Documentation