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< Service, IRndmGenSvc, IRndmEngine, ISerialize >
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 Service
const std::string &	name () const override
	Retrieve name of the service. More...

StatusCode	configure () override

StatusCode	initialize () override

StatusCode	start () override

StatusCode	stop () override

StatusCode	finalize () override

StatusCode	terminate () override

Gaudi::StateMachine::State	FSMState () const override

Gaudi::StateMachine::State	targetFSMState () const override

StatusCode	reinitialize () override

StatusCode	restart () override

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

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

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

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

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

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

StatusCode	setProperty (const Property &p) override

StatusCode	setProperty (const std::string &s) override

StatusCode	setProperty (const std::string &n, const std::string &v) override

StatusCode	getProperty (Property *p) const override

const Property &	getProperty (const std::string &name) const override

StatusCode	getProperty (const std::string &n, std::string &v) const override

const std::vector< Property * > &	getProperties () const override

bool	hasProperty (const std::string &name) const override

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

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

SmartIF< ISvcLocator > &	serviceLocator () const override
	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<typename IFace = IService>
SmartIF< IFace >	service (const std::string &name, 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...

template<class T >
StatusCode	declarePrivateTool (ToolHandle< T > &handle, std::string toolTypeAndName="", bool createIf=true)
	Declare used Private tool. More...

template<class T >
StatusCode	declarePublicTool (ToolHandle< T > &handle, std::string toolTypeAndName="", bool createIf=true)
	Declare used Public tool. More...

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

Public Member Functions inherited from CommonMessagingBase
virtual	~CommonMessagingBase ()=default
	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...

MSG::Level	outputLevel () const __attribute__((deprecated))
	Backward compatibility function for getting the output level. More...

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

Public Member Functions inherited from extend_interfaces< Interfaces...>
	~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< Service, IRndmGenSvc, IRndmEngine, ISerialize >
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 Service
typedef Gaudi::PluginService::Factory< IService , const std::string &, ISvcLocator >	Factory

Public Types inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
using	base_class = CommonMessaging

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

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

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

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

Protected Attributes inherited from Service
IntegerProperty	m_outputLevel = MSG::NIL
	Service output level. More...

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

Gaudi::StateMachine::State	m_targetState = Gaudi::StateMachine::OFFLINE
	Service state. 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 35 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 102 of file RndmGenSvc.cpp.

                                     {
   return m_engine.get();
 }

StatusCode RndmGenSvc::finalize ( )

override

Service override: finalization.

Definition at line 76 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 107 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 42 of file RndmGenSvc.cpp.

                                     {
   StatusCode status = Service::initialize();
 
   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;
             info() << "Using Random engine:" << m_engineName << endmsg;
           }
         }
       }
     }
   }
   return status;
 }

double RndmGenSvc::rndm ( ) const

override

Single shot returning single random number.

Definition at line 119 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 129 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 141 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 88 of file RndmGenSvc.cpp.

                                                         {
   if ( m_serialize ) return m_serialize->serialize(str);
   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 95 of file RndmGenSvc.cpp.

                                                               {
   if ( m_serialize ) return m_serialize->serialize(str);
   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 135 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 55 of file RndmGenSvc.h.

std::string RndmGenSvc::m_engineName

private

Engine name.

Definition at line 59 of file RndmGenSvc.h.

SmartIF<ISerialize> RndmGenSvc::m_serialize

mutableprivate

Serialization interface of random number engine.

Definition at line 57 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