Gaudi Framework, version v25r2

Home   Generated: Wed Jun 4 2014
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Types | Public Member Functions | List of all members
IParticlePropertySvc Class Referenceabstract

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]

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.
 
virtual ~IParticlePropertySvc ()
 virtual destructor
 
- Public Member Functions inherited from IService
 DeclareInterfaceID (IService, 3, 0)
 InterfaceID.
 
virtual StatusCode sysInitialize ()=0
 Initialize Service.
 
virtual StatusCode sysStart ()=0
 Start Service.
 
virtual StatusCode sysStop ()=0
 Stop Service.
 
virtual StatusCode sysFinalize ()=0
 Finalize Service.
 
virtual StatusCode sysReinitialize ()=0
 Re-initialize the Service.
 
virtual StatusCode sysRestart ()=0
 Re-start the Service.
 
virtual StatusCode configure ()=0
 Configuration (from OFFLINE to CONFIGURED).
 
virtual StatusCode initialize ()=0
 Initialization (from CONFIGURED to INITIALIZED).
 
virtual StatusCode start ()=0
 Start (from INITIALIZED to RUNNING).
 
virtual StatusCode stop ()=0
 Stop (from RUNNING to INITIALIZED).
 
virtual StatusCode finalize ()=0
 Finalize (from INITIALIZED to CONFIGURED).
 
virtual StatusCode terminate ()=0
 Initialization (from CONFIGURED to OFFLINE).
 
virtual StatusCode reinitialize ()=0
 Initialization (from INITIALIZED or RUNNING to INITIALIZED, via CONFIGURED).
 
virtual StatusCode restart ()=0
 Initialization (from RUNNING to RUNNING, via INITIALIZED).
 
virtual Gaudi::StateMachine::State FSMState () const =0
 Get the current state.
 
virtual Gaudi::StateMachine::State targetFSMState () const =0
 When we are in the middle of a transition, get the state where the transition is leading us.
 
virtual ~IService ()
 virtual destructor
 
- Public Member Functions inherited from INamedInterface
 DeclareInterfaceID (INamedInterface, 1, 0)
 InterfaceID.
 
virtual const std::string & name () const =0
 Retrieve the name of the instance.
 
virtual ~INamedInterface ()
 Virtual destructor (always needed for abstract classes).
 
- Public Member Functions inherited from IInterface
virtual void * i_cast (const InterfaceID &) const =0
 main cast function
 
virtual std::vector< std::string > getInterfaceNames () const =0
 Returns a vector of strings containing the names of all the implemented interfaces.
 
virtual unsigned long addRef ()=0
 Increment the reference count of Interface instance.
 
virtual unsigned long release ()=0
 Release Interface instance.
 
virtual unsigned long refCount () const =0
 Current reference count.
 
virtual StatusCode queryInterface (const InterfaceID &ti, void **pp)=0
 Set the void** to the pointer to the requested interface of the instance.
 
virtual ~IInterface ()
 Virtual destructor.
 

Additional Inherited Members

- Static Public Member Functions inherited from IInterface
static const InterfaceIDinterfaceID ()
 Return an instance of InterfaceID identifying the interface.
 
- Protected Member Functions inherited from IService
virtual void setServiceManager (ISvcManager *)=0
 

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

typedef VectPP::const_iterator IParticlePropertySvc::const_iterator

Definition at line 27 of file IParticlePropertySvc.h.

typedef VectPP::iterator IParticlePropertySvc::iterator

Definition at line 28 of file IParticlePropertySvc.h.

Definition at line 26 of file IParticlePropertySvc.h.

Constructor & Destructor Documentation

virtual IParticlePropertySvc::~IParticlePropertySvc ( )
inlinevirtual

virtual destructor

Definition at line 84 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 ( int  geantId)
pure virtual

Retrieve an object by geant3 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::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 ( 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 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 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:

Generated at Wed Jun 4 2014 14:49:02 for Gaudi Framework, version v25r2 by Doxygen version 1.8.2 written by Dimitri van Heesch, © 1997-2004