Gaudi Framework, version v23r0

Home   Generated: Mon Jan 30 2012
Public Types | Public Member Functions

IParticlePropertySvc Class Reference

This class is an interface to the ParticlePropertySvc. More...

#include <GaudiKernel/IParticlePropertySvc.h>

Inheritance diagram for IParticlePropertySvc:
Inheritance graph
[legend]
Collaboration diagram for IParticlePropertySvc:
Collaboration graph
[legend]

List of all members.

Public Types

typedef std::vector
< ParticleProperty * > 
VectPP
typedef VectPP::const_iterator const_iterator
typedef VectPP::iterator iterator

Public Member Functions

 DeclareInterfaceID (IParticlePropertySvc, 3, 0)
 InterfaceID.
virtual StatusCode push_back (const std::string &particle, int geantId, int jetsetId, double charge, double mass, double tlife, const std::string &evtName, int pythiaId, double maxWidth)=0
 Create a new particle property.
virtual StatusCode push_back (ParticleProperty *pp)=0
 Create a new particle property.
virtual const_iterator begin () const =0
 Get a const reference to the begining of the container.
virtual const_iterator end () const =0
 Get a const reference to the end of the container.
virtual int size () const =0
 Get the container size.
virtual ParticlePropertyfind (int geantId)=0
 Retrieve an object by geant3 id.
virtual ParticlePropertyfindByStdHepID (int stdHepID)=0
 Retrieve an object by StdHep id.
virtual ParticlePropertyfind (const std::string &name)=0
 Retrieve an object by name.
virtual ParticlePropertyfindByPythiaID (int pythiaID)=0
 Retrieve an object by PythiaID.
virtual StatusCode erase (int geantId)=0
 Erase a property by geant3 id.
virtual StatusCode erase (const std::string &name)=0
 Erase a property by particle name.
virtual StatusCode eraseByStdHepID (int stdHepID)=0
 Erase a property by StdHep id.

Detailed Description

This class is an interface to the ParticlePropertySvc.

Author:
Iain Last
G.Corti

Definition at line 19 of file IParticlePropertySvc.h.


Member Typedef Documentation

Reimplemented in Gaudi::ParticlePropertySvc.

Definition at line 27 of file IParticlePropertySvc.h.

Reimplemented in Gaudi::ParticlePropertySvc.

Definition at line 28 of file IParticlePropertySvc.h.

Reimplemented in Gaudi::ParticlePropertySvc.

Definition at line 26 of file IParticlePropertySvc.h.


Member Function Documentation

virtual const_iterator IParticlePropertySvc::begin (  ) const [pure virtual]

Get a const reference to the begining of the container.

Implemented in Gaudi::ParticlePropertySvc.

IParticlePropertySvc::DeclareInterfaceID ( IParticlePropertySvc  ,
,
 
)
virtual const_iterator IParticlePropertySvc::end (  ) const [pure virtual]

Get a const reference to the end of the container.

Implemented in Gaudi::ParticlePropertySvc.

virtual StatusCode IParticlePropertySvc::erase ( int  geantId ) [pure virtual]

Erase a property by geant3 id.

Implemented in Gaudi::ParticlePropertySvc.

virtual StatusCode IParticlePropertySvc::erase ( const std::string name ) [pure virtual]

Erase a property by particle name.

Implemented in Gaudi::ParticlePropertySvc.

virtual StatusCode IParticlePropertySvc::eraseByStdHepID ( int  stdHepID ) [pure virtual]

Erase a property by StdHep id.

Implemented in Gaudi::ParticlePropertySvc.

virtual ParticleProperty* IParticlePropertySvc::find ( const std::string name ) [pure virtual]

Retrieve an object by name.

Implemented in Gaudi::ParticlePropertySvc.

virtual ParticleProperty* IParticlePropertySvc::find ( int  geantId ) [pure virtual]

Retrieve an object by geant3 id.

Implemented in Gaudi::ParticlePropertySvc.

virtual ParticleProperty* IParticlePropertySvc::findByPythiaID ( int  pythiaID ) [pure virtual]

Retrieve an object by PythiaID.

Implemented in Gaudi::ParticlePropertySvc.

virtual ParticleProperty* IParticlePropertySvc::findByStdHepID ( int  stdHepID ) [pure virtual]

Retrieve an object by StdHep id.

Implemented in Gaudi::ParticlePropertySvc.

virtual StatusCode IParticlePropertySvc::push_back ( ParticleProperty pp ) [pure virtual]

Create a new particle property.

Parameters:
ppa particle property class
Returns:
StatusCode - SUCCESS if the particle property was added

Implemented in Gaudi::ParticlePropertySvc.

virtual StatusCode IParticlePropertySvc::push_back ( const std::string particle,
int  geantId,
int  jetsetId,
double  charge,
double  mass,
double  tlife,
const std::string evtName,
int  pythiaId,
double  maxWidth 
) [pure virtual]

Create a new particle property.

Parameters:
particleString name of the particle
geantIdGeant3 ID of the particle
jetsetIdJetset ID of the particle
chargeParticle charge (/e)
massParticle mass (MeV)
tlifeParticle lifetime (s)
evtNameString name of the particle in EvtGen
pythiaIdID of particle in Pythia
Returns:
StatusCode - SUCCESS if the particle property was added

Implemented in Gaudi::ParticlePropertySvc.

virtual int IParticlePropertySvc::size (  ) const [pure virtual]

Get the container size.

Implemented in Gaudi::ParticlePropertySvc.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines

Generated at Mon Jan 30 2012 13:53:17 for Gaudi Framework, version v23r0 by Doxygen version 1.7.2 written by Dimitri van Heesch, © 1997-2004