Random Generator service definition. More...

#include </builds/gaudi/Gaudi/GaudiSvc/src/RndmGenSvc/RndmGenSvc.h>

Inheritance diagram for RndmGenSvc:

[legend]

Collaboration diagram for RndmGenSvc:

[legend]

Public Member Functions
StatusCode	initialize () override
	Service override: initialization.

StatusCode	finalize () override
	Service override: finalization.

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

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

IRndmEngine *	engine () override
	Retrieve engine.

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

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

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

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

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

Public Member Functions inherited from extends< Service, IRndmGenSvc, IRndmEngine, ISerialize >
void const *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast.

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

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

Public Member Functions inherited from Service
const std::string &	name () const override
	Retrieve name of the service.

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.

StatusCode	sysStart () override
	Initialize Service.

StatusCode	sysStop () override
	Initialize Service.

StatusCode	sysFinalize () override
	Finalize Service.

StatusCode	sysReinitialize () override
	Re-initialize the Service.

StatusCode	sysRestart () override
	Re-initialize the Service.

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

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

template<typename IFace = IService>
SmartIF< IFace >	service (const std::string &name, bool createIf=true) const

template<class T>
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandle< T > &hndl, const std::string &doc="none")

template<class T>
StatusCode	declareTool (ToolHandle< T > &handle, bool createIf=true)

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

template<class T>
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandleArray< T > &hndlArr, const std::string &doc="none")

template<class T>
void	addToolsArray (ToolHandleArray< T > &hndlArr)

const std::vector< IAlgTool * > &	tools () const

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

Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
StatusCode	setProperty (const Gaudi::Details::PropertyBase &p)
	Set the property from a property.

StatusCode	setProperty (const std::string &name, const char *v)
	Special case for string literals.

StatusCode	setProperty (const std::string &name, const std::string &v)
	Special case for std::string.

StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value

	PropertyHolder ()=default

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Details::PropertyBase &prop)
	Declare a property.

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, TYPE &value, const std::string &doc="none")
	Helper to wrap a regular data member and use it as a regular property.

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, Gaudi::Property< TYPE, VERIFIER, HANDLERS > &prop, const std::string &doc="none")
	Declare a PropertyBase instance setting name and documentation.

Gaudi::Details::PropertyBase *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="")
	Declare a remote property.

StatusCode	setProperty (const std::string &name, const Gaudi::Details::PropertyBase &p) override
	set the property from another property with a different name

StatusCode	setProperty (const std::string &s) override
	set the property from the formatted string

StatusCode	setProperty (const Gaudi::Details::PropertyBase &p)
	Set the property from a property.

StatusCode	setProperty (const std::string &name, const char *v)
	Special case for string literals.

StatusCode	setProperty (const std::string &name, const std::string &v)
	Special case for std::string.

StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value

StatusCode	setPropertyRepr (const std::string &n, const std::string &r) override
	set the property from name and value string representation

StatusCode	getProperty (Gaudi::Details::PropertyBase *p) const override
	get the property

const Gaudi::Details::PropertyBase &	getProperty (std::string_view name) const override
	get the property by name

StatusCode	getProperty (std::string_view n, std::string &v) const override
	convert the property to the string

const std::vector< Gaudi::Details::PropertyBase * > &	getProperties () const override
	get all properties

bool	hasProperty (std::string_view name) const override
	Return true if we have a property with the given name.

Gaudi::Details::PropertyBase *	property (std::string_view name) const
	\fixme property and bindPropertiesTo should be protected

void	bindPropertiesTo (Gaudi::Interfaces::IOptionsSvc &optsSvc)

	PropertyHolder (const PropertyHolder &)=delete

PropertyHolder &	operator= (const PropertyHolder &)=delete

Public Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
MSG::Level	msgLevel () const
	get the cached level (originally extracted from the embedded MsgStream)

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

Public Member Functions inherited from CommonMessagingBase
virtual	~CommonMessagingBase ()=default
	Virtual destructor.

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

MsgStream &	msgStream () const
	Return an uninitialized MsgStream.

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

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

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

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

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

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

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

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

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

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

Private Attributes
SmartIF< IRndmEngine >	m_engine
	Random number engine.

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

Gaudi::Property< std::string >	m_engineName { this, "Engine", "HepRndm::Engine<CLHEP::RanluxEngine>", "engine name" }

Additional Inherited Members
Public Types inherited from extends< Service, IRndmGenSvc, IRndmEngine, ISerialize >
using	base_class
	Typedef to this class.

using	extend_interfaces_base
	Typedef to the base of this class.

Public Types inherited from Service
using	Factory = Gaudi::PluginService::Factory<IService( const std::string&, ISvcLocator )>

Public Types inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
using	PropertyHolderImpl
	Typedef used to refer to this class from derived classes, as in.

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

Public Types inherited from extend_interfaces< Interfaces... >
using	ext_iids
	take union of the ext_iids of all Interfaces...

Protected Member Functions inherited from Service
std::vector< IAlgTool * > &	tools ()

	~Service () override

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

Protected Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
MSG::Level	setUpMessaging () const
	Set up local caches.

MSG::Level	resetMessaging ()
	Reinitialize internal states.

void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream.

Protected Attributes inherited from Service
Gaudi::StateMachine::State	m_state = Gaudi::StateMachine::OFFLINE
	Service state.

Gaudi::StateMachine::State	m_targetState = Gaudi::StateMachine::OFFLINE
	Service state.

Gaudi::Property< int >	m_outputLevel { this, "OutputLevel", MSG::NIL, "output level" }
	flag indicating whether ToolHandle tools have been added to m_tools

Gaudi::Property< bool >	m_auditorInitialize { this, "AuditInitialize", false, "trigger auditor on initialize()" }

Gaudi::Property< bool >	m_auditorStart { this, "AuditStart", false, "trigger auditor on start()" }

Gaudi::Property< bool >	m_auditorStop { this, "AuditStop", false, "trigger auditor on stop()" }

Gaudi::Property< bool >	m_auditorFinalize { this, "AuditFinalize", false, "trigger auditor on finalize()" }

Gaudi::Property< bool >	m_auditorReinitialize { this, "AuditReinitialize", false, "trigger auditor on reinitialize()" }

Gaudi::Property< bool >	m_auditorRestart { this, "AuditRestart", false, "trigger auditor on restart()" }

Gaudi::Property< bool >	m_autoRetrieveTools

Gaudi::Property< bool >	m_checkToolDeps

SmartIF< IAuditorSvc >	m_pAuditorSvc
	Auditor Service.

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 58 of file RndmGenSvc.h.

Member Function Documentation

◆ engine()

IRndmEngine * RndmGenSvc::engine ( )

override

Retrieve engine.

Definition at line 101 of file RndmGenSvc.cpp.

101{ return m_engine.get(); }

RndmGenSvc::m_engine

SmartIF< IRndmEngine > m_engine

Random number engine.

Definition RndmGenSvc.h:61

◆ finalize()

StatusCode RndmGenSvc::finalize ( )

override

Service override: finalization.

Definition at line 75 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;
}

◆ generator()

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

override

Retrieve a valid generator from the service.

Definition at line 104 of file RndmGenSvc.cpp.

                                                                               {
  auto pGen = SmartIF<IRndmGen>( ObjFactory::create( par.type(), m_engine.get() ).release() );
  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 );
}

◆ initialize()

StatusCode RndmGenSvc::initialize ( )

override

Service override: initialization.

Definition at line 44 of file RndmGenSvc.cpp.

                                  {
  StatusCode status = Service::initialize();
 
  auto mgr = serviceLocator()->as<ISvcManager>();
 
  if ( status.isSuccess() ) {
    // 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.value() << endmsg;
        }
      }
    }
  }
  return status;
}

◆ rndm()

double RndmGenSvc::rndm ( ) const

override

Single shot returning single random number.

Definition at line 116 of file RndmGenSvc.cpp.

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

◆ rndmArray()

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 124 of file RndmGenSvc.cpp.

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

◆ seeds()

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

override

Allow to get seeds.

Definition at line 134 of file RndmGenSvc.cpp.

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

◆ serialize() [1/2]

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

override

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

Definition at line 94 of file RndmGenSvc.cpp.

                                                             {
  if ( m_serialize ) return m_serialize->serialize( str );
  error() << "Cannot output serialize Generator settings!" << endmsg;
  return str;
}

◆ serialize() [2/2]

StreamBuffer & RndmGenSvc::serialize ( StreamBuffer & str )

override

IRndmGenSvc interface implementation.

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

Definition at line 87 of file RndmGenSvc.cpp.

                                                       {
  if ( m_serialize ) return m_serialize->serialize( str );
  error() << "Cannot input serialize Generator settings!" << endmsg;
  return str;
}

◆ setSeeds()

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

override

Allow to set new seeds.

Definition at line 129 of file RndmGenSvc.cpp.

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

Member Data Documentation

◆ m_engine

SmartIF<IRndmEngine> RndmGenSvc::m_engine

mutableprivate

Random number engine.

Definition at line 61 of file RndmGenSvc.h.

◆ m_engineName

Gaudi::Property<std::string> RndmGenSvc::m_engineName { this, "Engine", "HepRndm::Engine<CLHEP::RanluxEngine>", "engine name" }

private

Definition at line 65 of file RndmGenSvc.h.

65{ this, "Engine", "HepRndm::Engine<CLHEP::RanluxEngine>", "engine name" };

◆ m_serialize

SmartIF<ISerialize> RndmGenSvc::m_serialize

mutableprivate

Serialization interface of random number engine.

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

Member Function Documentation

◆ engine()

◆ finalize()

◆ generator()

◆ initialize()

◆ rndm()

◆ rndmArray()

◆ seeds()

◆ serialize() [1/2]

◆ serialize() [2/2]

◆ setSeeds()

Member Data Documentation

◆ m_engine

◆ m_engineName

◆ m_serialize