A small algorithm class using the random number service. More...

#include <src/Test/RandomNumberAlg.h>

Inheritance diagram for RandomNumberAlg:

Collaboration diagram for RandomNumberAlg:

Public Member Functions
	RandomNumberAlg (const std::string &name, ISvcLocator *pSvcLocator)
	Constructor: A constructor of this form must be provided. More...

virtual	~RandomNumberAlg ()
	Standard Destructor. More...

virtual StatusCode	initialize ()
	Customized initialisation. More...

virtual StatusCode	finalize ()
	Customized finalisation. More...

virtual StatusCode	execute ()
	Event callback. More...

Public Member Functions inherited from Algorithm
	Algorithm (const std::string &name, ISvcLocator *svcloc, const std::string &version=PACKAGE_VERSION)
	Constructor. More...

virtual	~Algorithm ()
	Destructor. More...

virtual StatusCode	sysStart ()
	Reinitialization method invoked by the framework. More...

virtual StatusCode	sysInitialize ()
	Initialization method invoked by the framework. More...

virtual StatusCode	sysReinitialize ()
	Reinitialization method invoked by the framework. More...

virtual StatusCode	sysRestart ()
	Restart method invoked by the framework. More...

virtual StatusCode	sysExecute ()
	The actions to be performed by the algorithm on an event. More...

virtual StatusCode	sysStop ()
	System stop. More...

virtual StatusCode	sysFinalize ()
	System finalization. More...

virtual StatusCode	sysBeginRun ()
	beginRun method invoked by the framework. More...

virtual StatusCode	sysEndRun ()
	endRun method invoked by the framework. More...

virtual const std::string &	name () const
	The identifying name of the algorithm object. More...

virtual const std::string &	version () const
	The version of the algorithm. More...

virtual StatusCode	configure ()
	Dummy implementation of IStateful::configure() method. More...

virtual StatusCode	terminate ()
	Dummy implementation of IStateful::terminate() method. More...

virtual StatusCode	start ()
	the default (empty) implementation of IStateful::start() method More...

virtual StatusCode	stop ()
	the default (empty) implementation of IStateful::stop() method More...

virtual StatusCode	reinitialize ()
	the default (empty) implementation of IStateful::reinitialize() method More...

virtual StatusCode	restart ()
	the default (empty) implementation of IStateful::restart() method More...

virtual bool	isExecuted () const
	Has this algorithm been executed since the last reset? More...

virtual void	setExecuted (bool state)
	Set the executed flag to the specified state. More...

virtual void	resetExecuted ()
	Reset the executed state of the Algorithm for the duration of the current event. More...

virtual StatusCode	beginRun ()
	Algorithm begin run. More...

virtual StatusCode	endRun ()
	Algorithm end run. This method is called at the end of the event loop. More...

virtual Gaudi::StateMachine::State	FSMState () const
	returns the current state of the algorithm More...

virtual Gaudi::StateMachine::State	targetFSMState () const
	returns the state the algorithm will be in after the ongoing transition More...

virtual bool	isEnabled () const
	Is this algorithm enabled or disabled? More...

virtual bool	filterPassed () const
	Did this algorithm pass or fail its filter criterion for the last event? More...

virtual void	setFilterPassed (bool state)
	Set the filter passed flag to the specified state. More...

template<class T >
StatusCode	service (const std::string &name, T *&psvc, bool createIf=true) const
	Access a service by name, creating it if it doesn't already exist. More...

template<class T >
StatusCode	service (const std::string &svcType, const std::string &svcName, T *&psvc) const
	Access a service by name and type, creating it if it doesn't already exist. More...

SmartIF< IService >	service (const std::string &name, const bool createIf=true, const bool quiet=false) const
	Return a pointer to the service identified by name (or "type/name") More...

void	setOutputLevel (int level)
	Set the output level for current algorithm. More...

SmartIF< IAuditorSvc > &	auditorSvc () const
	The standard auditor service.May not be invoked before sysInitialize() has been invoked. More...

SmartIF< IChronoStatSvc > &	chronoSvc () const
	The standard Chrono & Stat service, Return a pointer to the service if present. More...

SmartIF< IChronoStatSvc > &	chronoStatService () const
	Obsoleted name, kept due to the backwards compatibility. More...

SmartIF< IDataProviderSvc > &	detSvc () const
	The standard detector data service. More...

SmartIF< IDataProviderSvc > &	detDataService () const
	Obsoleted name, kept due to the backwards compatibility. More...

SmartIF< IConversionSvc > &	detCnvSvc () const
	The standard detector data persistency conversion service. More...

SmartIF< IConversionSvc > &	detDataCnvService () const
	Obsoleted name, kept due to the backwards compatibility. More...

SmartIF< IDataProviderSvc > &	eventSvc () const
	The standard event data service. More...

SmartIF< IDataProviderSvc > &	evtSvc () const
	shortcut for method eventSvc More...

SmartIF< IDataProviderSvc > &	eventDataService () const
	Obsoleted name, kept due to the backwards compatibility. More...

SmartIF< IConversionSvc > &	eventCnvSvc () const
	The standard event data persistency conversion service. More...

SmartIF< IConversionSvc > &	eventDataCnvService () const
	Obsoleted name, kept due to the backwards compatibility. More...

SmartIF< IHistogramSvc > &	histoSvc () const
	The standard histogram service. More...

SmartIF< IHistogramSvc > &	histogramDataService () const
	Obsoleted name, kept due to the backwards compatibility. More...

SmartIF< IMessageSvc > &	msgSvc () const
	The standard message service. More...

SmartIF< IMessageSvc > &	messageService () const
	Obsoleted name, kept due to the backwards compatibility. More...

SmartIF< INTupleSvc > &	ntupleSvc () const
	The standard N tuple service. More...

SmartIF< INTupleSvc > &	ntupleService () const
	Obsoleted name, kept due to the backwards compatibility. More...

SmartIF< IRndmGenSvc > &	randSvc () const
	AIDA-based NTuple service Returns a pointer to the AIDATuple service if present. More...

SmartIF< IToolSvc > &	toolSvc () const
	The standard ToolSvc service, Return a pointer to the service if present. More...

SmartIF< IExceptionSvc > &	exceptionSvc () const
	Get the exception Service. More...

SmartIF< IAlgContextSvc > &	contextSvc () const
	get Algorithm Context Service More...

SmartIF< ISvcLocator > &	serviceLocator () const
	The standard service locator. More...

SmartIF< ISvcLocator > &	svcLoc () const
	shortcut for method serviceLocator More...

bool	registerContext () const
	register for Algorithm Context Service? More...

StatusCode	createSubAlgorithm (const std::string &type, const std::string &name, Algorithm *&pSubAlg)
	Create a sub algorithm. More...

std::vector< Algorithm * > *	subAlgorithms () const
	List of sub-algorithms. Returns a pointer to a vector of (sub) Algorithms. More...

virtual StatusCode	setProperty (const Property &p)
	Implementation of IProperty::setProperty. More...

virtual StatusCode	setProperty (const std::string &s)
	Implementation of IProperty::setProperty. More...

virtual StatusCode	setProperty (const std::string &n, const std::string &v)
	Implementation of IProperty::setProperty. More...

virtual StatusCode	getProperty (Property *p) const
	Implementation of IProperty::getProperty. More...

virtual const Property &	getProperty (const std::string &name) const
	Implementation of IProperty::getProperty. More...

virtual StatusCode	getProperty (const std::string &n, std::string &v) const
	Implementation of IProperty::getProperty. More...

virtual const std::vector < Property * > &	getProperties () const
	Implementation of IProperty::getProperties. More...

StatusCode	setProperties ()
	Set the algorithm's properties. More...

template<class T >
Property *	declareProperty (const std::string &name, T &property, const std::string &doc="none") const
	Declare the named property. More...

Property *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="") const
	Declare remote named properties. More...

SmartIF< IMonitorSvc > &	monitorSvc () const
	Access the monitor service. More...

template<class T >
void	declareInfo (const std::string &name, const T &var, const std::string &desc) const
	Declare monitoring information. More...

void	declareInfo (const std::string &name, const std::string &format, const void *var, int size, const std::string &desc) const
	Declare monitoring information (special case) More...

template<class TYPE >
StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value More...

Public Member Functions inherited from extend_interfaces3< IAlgorithm, IProperty, IStateful >
virtual	~extend_interfaces3 ()
	Virtual destructor. More...

Public Member Functions inherited from IAlgorithm
	DeclareInterfaceID (IAlgorithm, 4, 0)
	InterfaceID. More...

Public Member Functions inherited from INamedInterface
	DeclareInterfaceID (INamedInterface, 1, 0)
	InterfaceID. More...

virtual	~INamedInterface ()
	Virtual destructor (always needed for abstract classes). More...

Public Member Functions inherited from IInterface
virtual void *	i_cast (const InterfaceID &) const =0
	main cast function More...

virtual std::vector< std::string >	getInterfaceNames () const =0
	Returns a vector of strings containing the names of all the implemented interfaces. More...

virtual unsigned long	addRef ()=0
	Increment the reference count of Interface instance. More...

virtual unsigned long	release ()=0
	Release Interface instance. More...

virtual unsigned long	refCount () const =0
	Current reference count. More...

virtual StatusCode	queryInterface (const InterfaceID &ti, void **pp)=0
	Set the void** to the pointer to the requested interface of the instance. More...

virtual	~IInterface ()
	Virtual destructor. More...

Public Member Functions inherited from IProperty
	DeclareInterfaceID (IProperty, 2, 0)
	InterfaceID. More...

Public Member Functions inherited from IStateful
	DeclareInterfaceID (IStateful, 1, 0)
	InterfaceID. More...

virtual	~IStateful ()

Protected Attributes
Rndm::Numbers	m_gaussNumbers
	Allocate wrapper for random number generator. More...

Rndm::Numbers	m_poissonNumbers

Rndm::Numbers	m_expNumbers

AIDA::IHistogram1D *	m_gaussHisto

AIDA::IHistogram2D *	m_gauss2Histo

AIDA::IHistogram1D *	m_poissonHisto

AIDA::IHistogram1D *	m_expHisto

Additional Inherited Members
Public Types inherited from Algorithm
typedef Gaudi::PluginService::Factory < IAlgorithm , const std::string &, ISvcLocator >	Factory

Public Types inherited from implements3< IAlgorithm, IProperty, IStateful >
typedef implements3	base_class
	Typedef to this class. More...

typedef extend_interfaces3 < IAlgorithm, IProperty, IStateful >	extend_interfaces_base
	Typedef to the base of this class. More...

typedef extend_interfaces_base::ext_iids	interfaces
	MPL set of all the implemented interfaces. More...

Public Types inherited from extend_interfaces3< IAlgorithm, IProperty, IStateful >
typedef mpl::fold< typename IAlgorithm::iid::iids::type, typename mpl::fold< typename IProperty::iid::iids::type, typename IStateful::iid::iids::type, mpl::insert< mpl::_1, mpl::_2 > >::type, mpl::insert< mpl::_1, mpl::_2 > >::type	ext_iids
	MPL set of interfaces extended by this one. More...

Public Types inherited from IInterface
enum	Status { SUCCESS = 1, NO_INTERFACE, VERSMISMATCH, LAST_ERROR }
	Return status. More...

typedef Gaudi::InterfaceId < IInterface, 0, 0 >	iid
	Interface ID. More...

typedef mpl::set1< iid >	ext_iids
	Extra interfaces. More...

Static Public Member Functions inherited from IInterface
static const InterfaceID &	interfaceID ()
	Return an instance of InterfaceID identifying the interface. More...

Protected Member Functions inherited from Algorithm
bool	isInitialized () const
	Has the Algorithm already been initialized? More...

bool	isFinalized () const
	Has the Algorithm already been finalized? More...

int	outputLevel () const
	retrieve the Algorithm output level More...

IntegerProperty &	outputLevelProperty ()
	Accessor for the Message level property. More...

void	initOutputLevel (Property &prop)
	callback for output level property More...

Detailed Description

A small algorithm class using the random number service.

Author: M.Frank

Date: 1999

Definition at line 21 of file RandomNumberAlg.h.

Constructor & Destructor Documentation

RandomNumberAlg::RandomNumberAlg	(	const std::string &	name,
		ISvcLocator *	pSvcLocator
	)

Constructor: A constructor of this form must be provided.

Algorithm parameters which can be set at run time must be declared.

This should be done in the constructor.

Definition at line 23 of file RandomNumberAlg.cpp.

24 : Algorithm(name, pSvcLocator) {

25 }

Algorithm::name

virtual const std::string & name() const

The identifying name of the algorithm object.

Definition: Algorithm.cpp:837

Algorithm::Algorithm

Algorithm(const std::string &name, ISvcLocator *svcloc, const std::string &version=PACKAGE_VERSION)

Constructor.

Definition: Algorithm.cpp:28

RandomNumberAlg::~RandomNumberAlg ( )

virtual

Standard Destructor.

Definition at line 28 of file RandomNumberAlg.cpp.

28 {

29 }

Member Function Documentation

StatusCode RandomNumberAlg::execute ( )

virtual

Event callback.

Implements IAlgorithm.

Definition at line 55 of file RandomNumberAlg.cpp.

                                       {
   MsgStream log(msgSvc(), name());
   StatusCode sc;
 
   m_gaussHisto->fill(m_gaussNumbers(), 1.0 );
   m_gauss2Histo->fill(m_gaussNumbers(), m_gaussNumbers(), 1.0 );
   m_poissonHisto->fill(m_poissonNumbers(), 1.0 );
   m_expHisto->fill(m_expNumbers(), 1.0 );
   return sc;
 }

StatusCode RandomNumberAlg::finalize ( )

virtual

Customized finalisation.

Reimplemented from Algorithm.

Definition at line 66 of file RandomNumberAlg.cpp.

                                        {
   return StatusCode::SUCCESS;
 }

StatusCode RandomNumberAlg::initialize ( )

virtual

Customized initialisation.

Reimplemented from Algorithm.

Definition at line 33 of file RandomNumberAlg.cpp.

                                        {
   MsgStream log(msgSvc(), name());
   StatusCode sc;
 
   // Initilize random number generators
   sc = m_poissonNumbers.initialize(randSvc(), Rndm::Poisson(0.3));
   if ( sc.isFailure() ) return sc;
   sc = m_gaussNumbers.initialize(randSvc(), Rndm::Gauss(0.5,0.2));
   if ( sc.isFailure() ) return sc;
   sc = m_expNumbers.initialize(randSvc(), Rndm::Exponential(0.2));
   if ( sc.isFailure() ) return sc;
 
 
   // Initiatize Histograms
   m_gaussHisto   = histoSvc()->book( "simple/1", "Gauss", 40, 0., 3.);
   m_gauss2Histo  = histoSvc()->book( "simple/2", "Gauss 2D", 40, 0., 3., 50, 0., 3.);
   m_expHisto     = histoSvc()->book( "simple/3", "Exponential", 40, 0., 3.);
   m_poissonHisto = histoSvc()->book( "simple/4", "Poisson", 40, 0., 3.);
 
   return sc;
 }

Member Data Documentation

AIDA::IHistogram1D* RandomNumberAlg::m_expHisto

protected

Definition at line 31 of file RandomNumberAlg.h.

Rndm::Numbers RandomNumberAlg::m_expNumbers

protected

Definition at line 26 of file RandomNumberAlg.h.

AIDA::IHistogram2D* RandomNumberAlg::m_gauss2Histo

protected

Definition at line 29 of file RandomNumberAlg.h.

AIDA::IHistogram1D* RandomNumberAlg::m_gaussHisto

protected

Definition at line 28 of file RandomNumberAlg.h.

Rndm::Numbers RandomNumberAlg::m_gaussNumbers

protected

Allocate wrapper for random number generator.

Definition at line 24 of file RandomNumberAlg.h.

AIDA::IHistogram1D* RandomNumberAlg::m_poissonHisto

protected

Definition at line 30 of file RandomNumberAlg.h.

Rndm::Numbers RandomNumberAlg::m_poissonNumbers

protected

Definition at line 25 of file RandomNumberAlg.h.

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

GaudiPython/src/Test/RandomNumberAlg.h
GaudiPython/src/Test/RandomNumberAlg.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation