In This Package:

IParticlePropertySvc Class Reference

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

#include <GaudiKernel/IParticlePropertySvc.h>

Inheritance diagram for IParticlePropertySvc:

[legend]Collaboration diagram for IParticlePropertySvc:[legend]List of all members.


Public Types
typedef std::vector< ParticleProperty * >	VectPP
typedef VectPP::const_iterator	const_iterator
typedef VectPP::iterator	iterator
	SUCCESS = 1
	Normal successful completion.
	NO_INTERFACE
	Requested interface is not available.
	VERSMISMATCH
	Requested interface version is incompatible.
	LAST_ERROR
	Last error.
enum	Status { SUCCESS = 1, NO_INTERFACE, VERSMISMATCH, LAST_ERROR }
	Return status. More...
Public Member Functions
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 ParticleProperty *	find (int geantId)=0
	Retrieve an object by geant3 id.
virtual ParticleProperty *	findByStdHepID (int stdHepID)=0
	Retrieve an object by StdHep id.
virtual ParticleProperty *	find (const std::string &name)=0
	Retrieve an object by name.
virtual ParticleProperty *	findByPythiaID (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 const InterfaceID &	type () const =0
	Retrieve ID of the Service. Not really used.
virtual StatusCode	sysInitialize ()=0
	Initilize 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 const std::string &	name () const =0
	Retrieve the name of the instance.
virtual StatusCode	queryInterface (const InterfaceID &riid, void **ppvInterface)=0
	Query interfaces of Interface.
virtual unsigned long	addRef ()=0
	Increment the reference count of Interface instance.
virtual unsigned long	release ()=0
	Release Interface instance.
Static Public Member Functions
static const InterfaceID &	interfaceID ()
	Retrieve interface ID.
Protected Member Functions
virtual void	setServiceManager (ISvcManager *)=0

Detailed Description

This class is an interface to the ParticlePropertySvc.

Author:: Iain Last
G.Corti

Definition at line 22 of file IParticlePropertySvc.h.

Member Typedef Documentation

typedef std::vector<ParticleProperty*> IParticlePropertySvc::VectPP

Definition at line 26 of file IParticlePropertySvc.h.

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.

Member Enumeration Documentation

enum IInterface::Status [inherited]

Return status.

Enumerator:

SUCCESS	Normal successful completion.
NO_INTERFACE	Requested interface is not available.
VERSMISMATCH	Requested interface version is incompatible.
LAST_ERROR	Last error.

Reimplemented in IConversionSvc, IConverter, and IDataProviderSvc.

Definition at line 113 of file IInterface.h.

00113                 {
00115     SUCCESS = 1,
00117     NO_INTERFACE,
00119     VERSMISMATCH,
00121     LAST_ERROR
00122   };

Member Function Documentation

static const InterfaceID& IParticlePropertySvc::interfaceID ( ) [inline, static]

Retrieve interface ID.

Reimplemented from IService.

Definition at line 31 of file IParticlePropertySvc.h.

00031 { return IID_IParticlePropertySvc; }

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:

	particle	String name of the particle
	geantId	Geant3 ID of the particle
	jetsetId	Jetset ID of the particle
	charge	Particle charge (/e)
	mass	Particle mass (MeV)
	tlife	Particle lifetime (s)
	evtName	String name of the particle in EvtGen
	pythiaId	ID of particle in Pythia

Returns:: StatusCode - SUCCESS if the particle property was added

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

Create a new particle property.

Parameters:

a particle property class

Returns:: StatusCode - SUCCESS if the particle property was added

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

Get a const reference to the begining of the container.

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

Get a const reference to the end of the container.

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

Get the container size.

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

Retrieve an object by geant3 id.

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

Retrieve an object by StdHep id.

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

Retrieve an object by name.

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

Retrieve an object by PythiaID.

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

Erase a property by geant3 id.

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

Erase a property by particle name.

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

Erase a property by StdHep id.

virtual const InterfaceID& IService::type ( ) const [pure virtual, inherited]

Retrieve ID of the Service. Not really used.

Implemented in Service.

virtual StatusCode IService::sysInitialize ( ) [pure virtual, inherited]

Initilize Service.

Implemented in Service.

virtual StatusCode IService::sysStart ( ) [pure virtual, inherited]

Start Service.

Implemented in Service.

virtual StatusCode IService::sysStop ( ) [pure virtual, inherited]

Stop Service.

Implemented in Service.

virtual StatusCode IService::sysFinalize ( ) [pure virtual, inherited]

Finalize Service.

Implemented in Service.

virtual StatusCode IService::sysReinitialize ( ) [pure virtual, inherited]

Re-initialize the Service.

Implemented in Service.

virtual StatusCode IService::sysRestart ( ) [pure virtual, inherited]

Re-start the Service.

Implemented in Service.

virtual StatusCode IService::configure ( ) [pure virtual, inherited]

Configuration (from OFFLINE to CONFIGURED).

Implemented in Service.

virtual StatusCode IService::initialize ( ) [pure virtual, inherited]

Initialization (from CONFIGURED to INITIALIZED).

Implemented in ConversionSvc, DataSvc, MinimalEventLoopMgr, and Service.

virtual StatusCode IService::start ( ) [pure virtual, inherited]

Start (from INITIALIZED to RUNNING).

Implemented in MinimalEventLoopMgr, and Service.

virtual StatusCode IService::stop ( ) [pure virtual, inherited]

Stop (from RUNNING to INITIALIZED).

Implemented in MinimalEventLoopMgr, and Service.

virtual StatusCode IService::finalize ( ) [pure virtual, inherited]

Finalize (from INITIALIZED to CONFIGURED).

Implemented in ConversionSvc, DataSvc, MinimalEventLoopMgr, and Service.

virtual StatusCode IService::terminate ( ) [pure virtual, inherited]

Initialization (from CONFIGURED to OFFLINE).

Implemented in Service.

virtual StatusCode IService::reinitialize ( ) [pure virtual, inherited]

Initialization (from INITIALIZED or RUNNING to INITIALIZED, via CONFIGURED).

Implemented in DataSvc, MinimalEventLoopMgr, and Service.

virtual StatusCode IService::restart ( ) [pure virtual, inherited]

Initialization (from RUNNING to RUNNING, via INITIALIZED).

Implemented in MinimalEventLoopMgr, and Service.

virtual Gaudi::StateMachine::State IService::FSMState ( ) const [pure virtual, inherited]

Get the current state.

Implemented in Service.

virtual Gaudi::StateMachine::State IService::targetFSMState ( ) const [pure virtual, inherited]

When we are in the middle of a transition, get the state where the transition is leading us.

Otherwise it returns the same state as state().

Implemented in Service.

virtual void IService::setServiceManager ( ISvcManager * ) [protected, pure virtual, inherited]

Implemented in Service.

virtual const std::string& INamedInterface::name ( ) const [pure virtual, inherited]

Retrieve the name of the instance.

Implemented in Algorithm, AlgTool, Auditor, and Service.

virtual StatusCode IInterface::queryInterface	(	const InterfaceID &	riid,
		void **	ppvInterface
	)			`[pure virtual, inherited]`

Query interfaces of Interface.

Parameters:

	riid	ID of Interface to be retrieved
	ppvInterface	Pointer to Location for interface pointer

Implemented in Algorithm, AlgTool, Auditor, ConversionSvc, Converter, DataSvc, EventSelectorDataStream, MinimalEventLoopMgr, PropertyMgr, SelectStatement, and Service.

virtual unsigned long IInterface::addRef ( ) [pure virtual, inherited]

Increment the reference count of Interface instance.

Implemented in Algorithm, AlgTool, Auditor, Converter, EventSelectorDataStream, IFactory, PropertyMgr, SelectStatement, and Service.

virtual unsigned long IInterface::release ( ) [pure virtual, inherited]

Release Interface instance.

Implemented in Algorithm, AlgTool, Auditor, Converter, EventSelectorDataStream, IFactory, PropertyMgr, SelectStatement, and Service.

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

/home/dayabay/installs/trunk_2011_04_11_opt/NuWa-trunk/gaudi/GaudiKernel/GaudiKernel/IParticlePropertySvc.h

Generated on Mon Apr 11 19:57:10 2011 for GaudiKernel by 1.4.7

In This Package:

IParticlePropertySvc Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Member Function Documentation