Random Generator service definition. More...

#include <src/RndmGenSvc/RndmGenSvc.h>

Inheritance diagram for RndmGenSvc:

Collaboration diagram for RndmGenSvc:

Public Member Functions
	RndmGenSvc (const std::string &name, ISvcLocator *svc)
	Standard Service constructor. More...

	~RndmGenSvc () override=default
	Standard Service destructor. More...

StatusCode	initialize () override
	Service override: initialization. More...

StatusCode	finalize () override
	Service override: finalization. More...

StreamBuffer &	serialize (StreamBuffer &str) override
	IRndmGenSvc interface implementation. More...

StreamBuffer &	serialize (StreamBuffer &str) const override
	Output serialization to stream buffer. Saves the status of the generator engine. More...

IRndmEngine *	engine () override
	Retrieve engine. More...

StatusCode	generator (const IRndmGen::Param &par, IRndmGen *&refpGen) override
	Retrieve a valid generator from the service. More...

double	rndm () const override
	Single shot returning single random number. More...

StatusCode	rndmArray (std::vector< double > &array, long howmany, long start=0) const override
	Multiple shots returning vector with flat random numbers. More...

StatusCode	setSeeds (const std::vector< long > &seeds) override
	Allow to set new seeds. More...

StatusCode	seeds (std::vector< long > &seeds) const override
	Allow to get seeds. More...

Public Member Functions inherited from extends< BASE, Interfaces >
void *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast. More...

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

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

	~extends () override=default
	Virtual destructor. More...

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

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

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

	~extends () override=default
	Virtual destructor. More...

Public Member Functions inherited from extend_interfaces< Interfaces...>
	~extend_interfaces () override=default
	Virtual destructor. More...

	~extend_interfaces () override=default
	Virtual destructor. More...

Private Attributes
SmartIF< IRndmEngine >	m_engine
	Random number engine. More...

SmartIF< ISerialize >	m_serialize
	Serialization interface of random number engine. More...

std::string	m_engineName
	Engine name. More...

Additional Inherited Members
Public Types inherited from extends< BASE, Interfaces >
using	base_class = extends
	Typedef to this class. More...

using	extend_interfaces_base = extend_interfaces< Interfaces...>
	Typedef to the base of this class. More...

using	base_class = extends
	Typedef to this class. More...

using	extend_interfaces_base = extend_interfaces< Interfaces...>
	Typedef to the base of this class. More...

Public Types inherited from extend_interfaces< Interfaces...>
using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids...>::type
	take union of the ext_iids of all Interfaces... More...

using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids...>::type
	take union of the ext_iids of all Interfaces... More...

Detailed Description

Random Generator service definition.

Description: Definition of a interface for a service to access random generators according to predefined distributions. For more detailed explanations please see the interface definition.

Dependencies:

Base class: Gaudi/RndmGenSvc/ISerialize.h
Base class: Gaudi/RndmGenSvc/IRandomGenSvc.h

History :

+---------+----------------------------------------------+--------+
|    Date |                 Comment                      | Who    |
+---------+----------------------------------------------+--------+
| 21/04/99| Initial version.                             | MF     |
+---------+----------------------------------------------+--------+

Author: M.Frank Version: 1.0

Definition at line 49 of file RndmGenSvc.h.

Constructor & Destructor Documentation

RndmGenSvc::RndmGenSvc	(	const std::string &	name,
		ISvcLocator *	svc
	)

Standard Service constructor.

Definition at line 36 of file RndmGenSvc.cpp.

 : base_class(nam, svc)
 {
   declareProperty("Engine", m_engineName = "HepRndm::Engine<CLHEP::RanluxEngine>");
 }

RndmGenSvc::~RndmGenSvc ( )

overridedefault

Standard Service destructor.

Member Function Documentation

IRndmEngine * RndmGenSvc::engine ( )

override

Retrieve engine.

Definition at line 106 of file RndmGenSvc.cpp.

                                     {
   return m_engine.get();
 }

StatusCode RndmGenSvc::finalize ( )

override

Service override: finalization.

Definition at line 78 of file RndmGenSvc.cpp.

                                   {
   StatusCode status = Service::finalize();
   m_serialize.reset();
   if ( m_engine ) {
     m_engine.as<IService>()->finalize().ignore();
     m_engine.reset();
   }
   return status;
 }

StatusCode RndmGenSvc::generator	(	const IRndmGen::Param &	par,
		IRndmGen *&	refpGen
	)

override

Retrieve a valid generator from the service.

Definition at line 111 of file RndmGenSvc.cpp.

                                                                                {
   auto pGen = SmartIF<IRndmGen>( ObjFactory::create(par.type(),m_engine.get()) );
   if (!pGen) {
       refpGen = nullptr;
       return StatusCode::FAILURE;
   }
   refpGen = pGen.get();
   refpGen->addRef(); // insure the caller gets something with a refCount of (at least) one back...
   return refpGen->initialize(par);
 }

StatusCode RndmGenSvc::initialize ( )

override

Service override: initialization.

Definition at line 43 of file RndmGenSvc.cpp.

                                     {
   StatusCode status = Service::initialize();
 
   MsgStream log(msgSvc(), name());
   auto mgr = serviceLocator()->as<ISvcManager>();
 
   if ( status.isSuccess() ) {
     status = setProperties();
     if ( status.isSuccess() ) {  // Check if the Engine service exists:
       // FIXME: (MCl) why RndmGenSvc cannot create the engine service in a standard way?
       const bool CREATE = false;
       std::string machName = name()+".Engine";
       auto engine = serviceLocator()->service<IRndmEngine>(machName, CREATE);
       if ( !engine && mgr )   {
         using Gaudi::Utils::TypeNameString;
         engine = mgr->createService(TypeNameString(machName, m_engineName));
       }
       if ( engine )   {
         auto serial = engine.as<ISerialize>();
         auto service = engine.as<IService>();
         if ( serial && service )  {
           status = service->sysInitialize();
           if ( status.isSuccess() )   {
             m_engine = engine;
             m_serialize = serial;
             log << MSG::INFO << "Using Random engine:" << m_engineName << endmsg;
           }
         }
       }
     }
   }
   return status;
 }

double RndmGenSvc::rndm ( ) const

override

Single shot returning single random number.

Definition at line 123 of file RndmGenSvc.cpp.

                                 {
   return m_engine ? m_engine->rndm() : -1;
 }

StatusCode RndmGenSvc::rndmArray	(	std::vector< double > &	array,
		long	howmany,
		long	start = `0`
	)		const

override

Multiple shots returning vector with flat random numbers.

Parameters

array	Array containing random numbers
howmany	fill 'howmany' random numbers into array
start	... starting at position start

Returns: StatusCode indicating failure or success.

Definition at line 133 of file RndmGenSvc.cpp.

                                                                                             {
   return m_engine ? m_engine->rndmArray(array, howmany, start)
                   : StatusCode::FAILURE;
 }

StatusCode RndmGenSvc::seeds ( std::vector< long > & seeds ) const

override

Allow to get seeds.

Definition at line 145 of file RndmGenSvc.cpp.

                                                            {
   return m_engine ? m_engine->seeds(seeds)
                   : StatusCode::FAILURE;
 }

StreamBuffer & RndmGenSvc::serialize ( StreamBuffer & str )

override

IRndmGenSvc interface implementation.

Input serialization from stream buffer. Restores the status of the generator engine.

Definition at line 90 of file RndmGenSvc.cpp.

                                                         {
   if ( m_serialize ) return m_serialize->serialize(str);
   MsgStream log(msgSvc(), name());
   log << MSG::ERROR << "Cannot input serialize Generator settings!" << endmsg;
   return str;
 }

StreamBuffer & RndmGenSvc::serialize ( StreamBuffer & str ) const

override

Output serialization to stream buffer. Saves the status of the generator engine.

Definition at line 98 of file RndmGenSvc.cpp.

                                                               {
   if ( m_serialize ) return m_serialize->serialize(str);
   MsgStream log(msgSvc(), name());
   log << MSG::ERROR << "Cannot output serialize Generator settings!" << endmsg;
   return str;
 }

StatusCode RndmGenSvc::setSeeds ( const std::vector< long > & seeds )

override

Allow to set new seeds.

Definition at line 139 of file RndmGenSvc.cpp.

                                                               {
   return m_engine ? m_engine->setSeeds(seeds)
                   : StatusCode::FAILURE;
 }

Member Data Documentation

SmartIF<IRndmEngine> RndmGenSvc::m_engine

mutableprivate

Random number engine.

Definition at line 52 of file RndmGenSvc.h.

std::string RndmGenSvc::m_engineName

private

Engine name.

Definition at line 56 of file RndmGenSvc.h.

SmartIF<ISerialize> RndmGenSvc::m_serialize

mutableprivate

Serialization interface of random number engine.

Definition at line 54 of file RndmGenSvc.h.

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

GaudiSvc/src/RndmGenSvc/RndmGenSvc.h
GaudiSvc/src/RndmGenSvc/RndmGenSvc.cpp

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation