#include <src/RndmGenSvc/HepRndmEngine.h>

Inheritance diagram for HepRndm::Engine< TYPE >:

Collaboration diagram for HepRndm::Engine< TYPE >:

Public Member Functions
	Engine (const std::string &name, ISvcLocator *loc)
	Standard Constructor. More...

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

virtual StatusCode	initialize ()
	Initialize the Engine. More...

virtual StatusCode	finalize ()
	Finalize the Engine. More...

virtual StatusCode	initializeEngine ()
	Create/Initialize new HepEngine.... More...

virtual double	rndm () const
	Single shot / This was declared "virtual double rndm()" which causes / compiler warnings since the signature if different than / that for RndmEngine::rndm(). I've assumed that the difference / is an error. If it is in fact a deliberate addition of a / new function, remove the "const" below and uncomment the / subsequent lines. More...

StatusCode	setSeeds (const std::vector< long > &seed)
	virtual double rndm() const { return BaseEngine::rndm( ); } More...

StatusCode	seeds (std::vector< long > &seed) const
	Retrieve seeds. More...

template<>
StatusCode	initializeEngine ()

template<>
StatusCode	initializeEngine ()

template<>
StatusCode	initializeEngine ()

template<>
StatusCode	initializeEngine ()

template<>
StatusCode	initializeEngine ()

template<>
StatusCode	initializeEngine ()

template<>
StatusCode	initializeEngine ()

template<>
StatusCode	initializeEngine ()

template<>
StatusCode	initializeEngine ()

template<>
StatusCode	initializeEngine ()

template<>
StatusCode	initializeEngine ()

Public Member Functions inherited from HepRndm::BaseEngine
	BaseEngine (const std::string &name, ISvcLocator *loc)

virtual	~BaseEngine ()

CLHEP::HepRandomEngine *	hepEngine ()

Public Member Functions inherited from RndmEngine
virtual StatusCode	rndmArray (std::vector< double > &array, long howmany, long start=0) const
	Multiple shots returning vector with flat random numbers. More...

virtual StreamBuffer &	serialize (StreamBuffer &str)
	Input serialization from stream buffer. More...

virtual StreamBuffer &	serialize (StreamBuffer &str) const
	Output serialization to stream buffer. More...

virtual void	handle (const Incident &inc)
	Inform that a new incident has occurred. More...

Public Member Functions inherited from extends3< Service, IRndmEngine, ISerialize, IIncidentListener >
	extends3 (A1 a1, A2 a2, A3 a3)
	Templated constructor with 3 arguments. More...

	extends3 (A1 a1, A2 a2)
	Templated constructor with 2 arguments. More...

	extends3 (A1 a1)
	Templated constructor with 1 argument. More...

	extends3 ()
	Default constructor. More...

virtual void *	i_cast (const InterfaceID &tid) const
	Implementation of IInterface::i_cast. More...

virtual StatusCode	queryInterface (const InterfaceID &ti, void **pp)
	Implementation of IInterface::queryInterface. More...

virtual std::vector< std::string >	getInterfaceNames () const
	Implementation of IInterface::getInterfaceNames. More...

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

Public Member Functions inherited from Service
virtual unsigned long	release ()
	Release Interface instance. More...

virtual const std::string &	name () const
	Retrieve name of the service. More...

virtual StatusCode	configure ()
	Configuration (from OFFLINE to CONFIGURED). More...

virtual StatusCode	start ()
	Start (from INITIALIZED to RUNNING). More...

virtual StatusCode	stop ()
	Stop (from RUNNING to INITIALIZED). More...

virtual StatusCode	terminate ()
	Initialization (from CONFIGURED to OFFLINE). More...

virtual Gaudi::StateMachine::State	FSMState () const
	Get the current state. More...

virtual Gaudi::StateMachine::State	targetFSMState () const
	When we are in the middle of a transition, get the state where the transition is leading us. More...

virtual StatusCode	reinitialize ()
	Initialization (from INITIALIZED or RUNNING to INITIALIZED, via CONFIGURED). More...

virtual StatusCode	restart ()
	Initialization (from RUNNING to RUNNING, via INITIALIZED). More...

virtual StatusCode	sysInitialize ()
	Initialize Service. More...

virtual StatusCode	sysStart ()
	Initialize Service. More...

virtual StatusCode	sysStop ()
	Initialize Service. More...

virtual StatusCode	sysFinalize ()
	Finalize Service. More...

virtual StatusCode	sysReinitialize ()
	Re-initialize the Service. More...

virtual StatusCode	sysRestart ()
	Re-initialize the Service. More...

virtual StatusCode	setProperty (const Property &p)
	Set the property by property. More...

virtual StatusCode	setProperty (const std::string &s)
	Set the property by string. More...

virtual StatusCode	setProperty (const std::string &n, const std::string &v)
	Set the property by std::string. More...

virtual StatusCode	getProperty (Property *p) const
	Get the property by property. More...

virtual const Property &	getProperty (const std::string &name) const
	Get the property by name. More...

virtual StatusCode	getProperty (const std::string &n, std::string &v) const
	Get the property by std::string. More...

virtual const std::vector < Property * > &	getProperties () const
	Get list of properties. More...

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

	Service (const std::string &name, ISvcLocator *svcloc)
	Standard Constructor. More...

SmartIF< ISvcLocator > &	serviceLocator () const
	Retrieve pointer to service locator. More...

StatusCode	setProperties ()
	Method for setting declared properties to the values specified for the job. More...

template<class T >
StatusCode	service (const std::string &name, const 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 &name, T *&psvc, bool createIf=true) const

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...

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< IAuditorSvc > &	auditorSvc () const
	The standard auditor service.May not be invoked before sysInitialize() has been invoked. More...

Public Member Functions inherited from CommonMessaging< implements3< IService, IProperty, IStateful > >
	CommonMessaging (const A1 &a1, const A2 &a2, const A3 &a3)
	Templated constructor with 3 arguments. More...

	CommonMessaging (const A1 &a1, const A2 &a2)
	Templated constructor with 2 arguments. More...

	CommonMessaging (const A1 &a1)
	Templated constructor with 1 argument. More...

	CommonMessaging ()
	Default constructor. More...

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

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

MsgStream &	msgStream () const
	Return an uninitialized MsgStream. More...

MsgStream &	msgStream (const MSG::Level level) const
	Predefined configurable message stream for the efficient printouts. More...

MsgStream &	always () const
	shortcut for the method msgStream(MSG::ALWAYS) More...

MsgStream &	fatal () const
	shortcut for the method msgStream(MSG::FATAL) More...

MsgStream &	err () const
	shortcut for the method msgStream(MSG::ERROR) More...

MsgStream &	error () const
	shortcut for the method msgStream(MSG::ERROR) More...

MsgStream &	warning () const
	shortcut for the method msgStream(MSG::WARNING) More...

MsgStream &	info () const
	shortcut for the method msgStream(MSG::INFO) More...

MsgStream &	debug () const
	shortcut for the method msgStream(MSG::DEBUG) More...

MsgStream &	verbose () const
	shortcut for the method msgStream(MSG::VERBOSE) More...

MsgStream &	msg () const
	shortcut for the method msgStream(MSG::INFO) More...

MSG::Level	msgLevel () const
	get the output level from the embedded MsgStream More...

bool	msgLevel (MSG::Level lvl) const
	get the output level from the embedded MsgStream More...

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

Public Member Functions inherited from IService
	DeclareInterfaceID (IService, 3, 0)
	InterfaceID. More...

virtual	~IService ()
	virtual destructor 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 unsigned long	addRef ()=0
	Increment the reference count of Interface instance. More...

virtual unsigned long	refCount () const =0
	Current reference count. 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 ()

Public Member Functions inherited from extend_interfaces3< IRndmEngine, ISerialize, IIncidentListener >
virtual	~extend_interfaces3 ()
	Virtual destructor. More...

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

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

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

Protected Attributes
std::vector< long >	m_seeds

int	m_row

int	m_col

int	m_lux

bool	m_useTable

bool	m_setSingleton

Protected Attributes inherited from HepRndm::BaseEngine
CLHEP::HepRandomEngine *	m_hepEngine

Protected Attributes inherited from RndmEngine
SmartIF< IIncidentSvc >	m_pIncidentSvc
	Reference to the incident service. More...

Protected Attributes inherited from Service
IntegerProperty	m_outputLevel
	Service output level. More...

Gaudi::StateMachine::State	m_state
	Service state. More...

Gaudi::StateMachine::State	m_targetState
	Service state. More...

Protected Attributes inherited from CommonMessaging< implements3< IService, IProperty, IStateful > >
SmartIF< IMessageSvc >	m_msgsvc
	Pointer to the message service;. More...

std::auto_ptr< MsgStream >	m_msgStream
	The predefined message stream. More...

bool	m_streamWithService
	Flag to create a new MsgStream if it was created without the message service. More...

Additional Inherited Members
Public Types inherited from extends3< Service, IRndmEngine, ISerialize, IIncidentListener >
typedef extends3	base_class
	Typedef to this class. More...

typedef extend_interfaces3 < IRndmEngine, ISerialize, IIncidentListener >	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 Service
typedef Gaudi::PluginService::Factory2 < IService , const std::string &, ISvcLocator >	Factory

Public Types inherited from CommonMessaging< implements3< IService, IProperty, IStateful > >
typedef CommonMessaging	base_class

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

typedef extend_interfaces3 < IService, 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< IService, IProperty, IStateful >
typedef mpl::fold< typename IService::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...

Public Types inherited from extend_interfaces3< IRndmEngine, ISerialize, IIncidentListener >
typedef mpl::fold< typename IRndmEngine::iid::iids::type, typename mpl::fold< typename ISerialize::iid::iids::type, typename IIncidentListener::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...

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 RndmEngine
	RndmEngine (const std::string &name, ISvcLocator *loc)
	Standard Constructor. More...

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

Protected Member Functions inherited from Service
virtual	~Service ()
	Standard Destructor. More...

int	outputLevel () const
	get the `Service's` output level More...

Protected Member Functions inherited from CommonMessaging< implements3< IService, IProperty, IStateful > >
void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream. More...

Detailed Description

template<class TYPE>
class HepRndm::Engine< TYPE >

Definition at line 25 of file HepRndmEngine.h.

Constructor & Destructor Documentation

template<class TYPE >

HepRndm::Engine< TYPE >::Engine	(	const std::string &	name,
		ISvcLocator *	loc
	)

Standard Constructor.

Definition at line 57 of file HepRndmEngines.cpp.

   : BaseEngine (nam, loc)    {
     declareProperty("Seeds",       m_seeds);
     declareProperty("Column",      m_col = 0);
     declareProperty("Row",         m_row = 1);
     declareProperty("Luxury",      m_lux = 3);
     declareProperty("UseTable",    m_useTable     = false);
     declareProperty("SetSingleton",m_setSingleton = false);
   }

template<class TYPE >

HepRndm::Engine< TYPE >::~Engine ( )

virtual

Standard Destructor.

Definition at line 68 of file HepRndmEngines.cpp.

68 {

69 }

Member Function Documentation

template<class TYPE >

StatusCode HepRndm::Engine< TYPE >::finalize ( )

virtual

Finalize the Engine.

Reimplemented from RndmEngine.

Definition at line 117 of file HepRndmEngines.cpp.

                                                                    {
     if ( m_hepEngine )   {
       HepRandom::setTheEngine(0);
       delete m_hepEngine;
     }
     m_seeds.clear();
     m_hepEngine = 0;
     return RndmEngine::finalize();
   }

template<class TYPE >

StatusCode HepRndm::Engine< TYPE >::initialize ( )

virtual

Initialize the Engine.

Reimplemented from RndmEngine.

Definition at line 72 of file HepRndmEngines.cpp.

                                                                      {
     m_seeds.erase(m_seeds.begin(), m_seeds.end());
     StatusCode status = RndmEngine::initialize();
     if ( m_seeds.size() == 0 )  {
       // Default seeds
       long theSeed = 1234567;
       m_seeds.push_back(theSeed);
       m_seeds.push_back(0);
     }
     MsgStream log(msgSvc(), name());
     if ( status.isSuccess() )   {
       status = initializeEngine();
       if ( status.isSuccess() )   {
         log << MSG::INFO << "Generator engine type:"
               << System::typeinfoName(typeid(TYPE))
               << endmsg;
         if ( m_useTable )   {
           if ( m_row > 214 || m_col > 1 )   {
             log << MSG::ERROR << "Generator engine seed table has dimension [215][2], you gave:"
                 << " Row=" << m_row << " Column:" << m_col << endmsg;
             status = StatusCode::FAILURE;
           }
           else    {
             log << MSG::INFO << "Generator engine seeds from table."
                 << " Row=" << m_row << " Column:" << m_col << endmsg;
           }
         }
         log << "Current Seed:" << m_hepEngine->getSeed();
         log << " Luxury:" << m_lux;
         log << endmsg;
         // Use the default static engine if required (e.g. for GEANT4)
         if ( m_setSingleton )   {
             HepRandom::setTheEngine(m_hepEngine);
           log << "This is the GEANT4 engine!" << endmsg;
         }
         return status;
       }
     }
     log << MSG::ERROR << "Cannot initialze random engine of type:"
           << System::typeinfoName(typeid(TYPE))
         << endmsg;
     return status;
   }

template<class TYPE >

virtual StatusCode HepRndm::Engine< TYPE >::initializeEngine ( )

virtual

Create/Initialize new HepEngine....

template<>

StatusCode HepRndm::Engine< DualRand >::initializeEngine ( )

Definition at line 166 of file HepRndmEngines.cpp.

                                                              {
     m_hepEngine = (m_useTable) ? new DualRand(m_row, m_col) : new DualRand(m_seeds[0]);
     return StatusCode::SUCCESS;
   }

template<>

StatusCode HepRndm::Engine< TripleRand >::initializeEngine ( )

Definition at line 171 of file HepRndmEngines.cpp.

                                                                {
     m_hepEngine = (m_useTable) ? new TripleRand(m_row, m_col) : new TripleRand(m_seeds[0]);
     return StatusCode::SUCCESS;
   }

template<>

StatusCode HepRndm::Engine< DRand48Engine >::initializeEngine ( )

Definition at line 176 of file HepRndmEngines.cpp.

                                                                   {
     m_hepEngine = (m_useTable) ? new DRand48Engine(m_row, m_col) : new DRand48Engine(m_seeds[0]);
     return StatusCode::SUCCESS;
   }

template<>

StatusCode HepRndm::Engine< Hurd160Engine >::initializeEngine ( )

Definition at line 181 of file HepRndmEngines.cpp.

                                                                   {
     m_hepEngine = (m_useTable) ? new Hurd160Engine(m_row, m_col) : new Hurd160Engine(m_seeds[0]);
     return StatusCode::SUCCESS;
   }

template<>

StatusCode HepRndm::Engine< Hurd288Engine >::initializeEngine ( )

Definition at line 186 of file HepRndmEngines.cpp.

                                                                   {
     m_hepEngine = (m_useTable) ? new Hurd288Engine(m_row, m_col) : new Hurd288Engine(m_seeds[0]);
     return StatusCode::SUCCESS;
   }

template<>

StatusCode HepRndm::Engine< RanecuEngine >::initializeEngine ( )

Definition at line 191 of file HepRndmEngines.cpp.

                                                                  {
     m_hepEngine = (m_useTable) ? new RanecuEngine(m_row) : new RanecuEngine(m_seeds[0]);
     return StatusCode::SUCCESS;
   }

template<>

StatusCode HepRndm::Engine< RanshiEngine >::initializeEngine ( )

Definition at line 196 of file HepRndmEngines.cpp.

                                                                  {
     m_hepEngine = (m_useTable) ? new RanshiEngine(m_row, m_col) : new RanshiEngine(m_seeds[0]);
     return StatusCode::SUCCESS;
   }

template<>

StatusCode HepRndm::Engine< RanluxEngine >::initializeEngine ( )

Definition at line 201 of file HepRndmEngines.cpp.

                                                                  {
     m_hepEngine = (m_useTable) ? new RanluxEngine(m_row, m_col, m_lux) : new RanluxEngine(m_seeds[0], m_lux);
     return StatusCode::SUCCESS;
   }

template<>

StatusCode HepRndm::Engine< Ranlux64Engine >::initializeEngine ( )

Definition at line 206 of file HepRndmEngines.cpp.

                                                                    {
     m_hepEngine = (m_useTable) ? new Ranlux64Engine(m_row, m_col, m_lux) : new Ranlux64Engine(m_seeds[0], m_lux);
     return StatusCode::SUCCESS;
   }

template<>

StatusCode HepRndm::Engine< MTwistEngine >::initializeEngine ( )

Definition at line 211 of file HepRndmEngines.cpp.

                                                                  {
     m_hepEngine = (m_useTable) ? new MTwistEngine(m_row, m_col) : new MTwistEngine(m_seeds[0]);
     return StatusCode::SUCCESS;
   }

template<>

StatusCode HepRndm::Engine< HepJamesRandom >::initializeEngine ( )

Definition at line 216 of file HepRndmEngines.cpp.

                                                                    {
     m_hepEngine = (m_useTable) ? new HepJamesRandom(m_row, m_col) : new HepJamesRandom(m_seeds[0]);
     return StatusCode::SUCCESS;
   }

template<class TYPE >

double HepRndm::Engine< TYPE >::rndm ( ) const

virtual

Single shot / This was declared "virtual double rndm()" which causes / compiler warnings since the signature if different than / that for RndmEngine::rndm(). I've assumed that the difference / is an error. If it is in fact a deliberate addition of a / new function, remove the "const" below and uncomment the / subsequent lines.

Reimplemented from RndmEngine.

Definition at line 128 of file HepRndmEngines.cpp.

                                                          {
     return m_hepEngine->flat();
   }

template<class TYPE >

StatusCode HepRndm::Engine< TYPE >::seeds ( std::vector< long > & seed ) const

virtual

Retrieve seeds.

Implements IRndmEngine.

Definition at line 150 of file HepRndmEngines.cpp.

                                                                                     {
     /*
     const long *s = m_hepEngine->getSeeds();
     for ( size_t i = 0; i < NUMBER_OF_SEEDS; i++ )   {
       seed.push_back(s[i]);
       if ( m_seeds.size() > i )
         m_seeds[i] = s[i];
       else
         m_seeds.push_back(s[i]);
     }
     */
     seed.push_back(m_hepEngine->getSeed());
     return StatusCode::SUCCESS;
   }

template<class TYPE >

StatusCode HepRndm::Engine< TYPE >::setSeeds ( const std::vector< long > & seed )

virtual

virtual double rndm() const { return BaseEngine::rndm( ); }

Set seeds

Implements IRndmEngine.

Definition at line 133 of file HepRndmEngines.cpp.

                                                                                        {
     typedef std::vector<long> seed_t;
     m_seeds.clear();
     for ( seed_t::const_iterator i = seed.begin(); i < seed.end(); i++ )   {
       m_seeds.push_back(*i);
     }
     if ( m_seeds.size() > 0 )   {
       if ( m_seeds.back() != 0 )    {
         m_seeds.push_back(0);
       }
       m_hepEngine->setSeeds(&m_seeds[0], m_lux);
       return StatusCode::SUCCESS;
     }
     return StatusCode::FAILURE;
   }

Member Data Documentation

template<class TYPE >

int HepRndm::Engine< TYPE >::m_col

protected

Definition at line 30 of file HepRndmEngine.h.

template<class TYPE >

int HepRndm::Engine< TYPE >::m_lux

protected

Definition at line 30 of file HepRndmEngine.h.

template<class TYPE >

int HepRndm::Engine< TYPE >::m_row

protected

Definition at line 30 of file HepRndmEngine.h.

template<class TYPE >

std::vector<long> HepRndm::Engine< TYPE >::m_seeds

mutableprotected

Definition at line 28 of file HepRndmEngine.h.

template<class TYPE >

bool HepRndm::Engine< TYPE >::m_setSingleton

protected

Definition at line 31 of file HepRndmEngine.h.

template<class TYPE >

bool HepRndm::Engine< TYPE >::m_useTable

protected

Definition at line 31 of file HepRndmEngine.h.

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

GaudiSvc/src/RndmGenSvc/HepRndmEngine.h
GaudiSvc/src/RndmGenSvc/HepRndmEngines.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<class TYPE> class HepRndm::Engine< TYPE >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class TYPE>
class HepRndm::Engine< TYPE >