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

Inheritance diagram for HepRndm::BaseEngine:

Collaboration diagram for HepRndm::BaseEngine:

Public Member Functions
	BaseEngine (const std::string &name, ISvcLocator *loc)
CLHEP::HepRandomEngine *	hepEngine ()
const CLHEP::HepRandomEngine *	hepEngine () const
double	rndm () const override
StatusCode	finalize () override
Public Member Functions inherited from RndmEngine
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.
StreamBuffer &	serialize (StreamBuffer &str) override
	Input serialization from stream buffer.
StreamBuffer &	serialize (StreamBuffer &str) const override
	Output serialization to stream buffer.
Public Member Functions inherited from extends< Service, 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 *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="")
	Declare a remote property.
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 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 &	operator= (const PropertyHolder &)=delete
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)
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

Protected Member Functions
void	initEngine ()
virtual std::unique_ptr< CLHEP::HepRandomEngine >	createEngine ()=0
template<typename Engine, typename... Args>
auto	create_engine (Args &&... args)
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 override final
	Set up local caches.
MSG::Level	resetMessaging ()
	Reinitialize internal states.
void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream.

Protected Attributes
std::unique_ptr< CLHEP::HepRandomEngine >	m_hepEngine
Gaudi::Property< bool >	m_threadSafe { this, "ThreadSafe", true }
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.

Additional Inherited Members
Public Types inherited from extends< Service, 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...

Detailed Description

Definition at line 119 of file HepRndmBaseEngine.h.

Constructor & Destructor Documentation

◆ BaseEngine()

HepRndm::BaseEngine::BaseEngine	(	const std::string &	name,
		ISvcLocator *	loc )

inline

Definition at line 125 of file HepRndmBaseEngine.h.

125: RndmEngine( name, loc ) {}

Service::name

const std::string & name() const override

Retrieve name of the service.

Definition Service.cpp:333

Member Function Documentation

◆ create_engine()

template<typename Engine, typename... Args>

auto HepRndm::BaseEngine::create_engine ( Args &&... args )

inlineprotected

Definition at line 141 of file HepRndmBaseEngine.h.

                                         {
      return ( m_threadSafe.value() ? std::make_unique<SynchronizedEngine<Engine>>( std::forward<Args>( args )... )
                                    : std::make_unique<Engine>( std::forward<Args>( args )... ) );
    }

◆ createEngine()

virtual std::unique_ptr< CLHEP::HepRandomEngine > HepRndm::BaseEngine::createEngine ( )

protectedpure virtual

◆ finalize()

StatusCode HepRndm::BaseEngine::finalize ( )

inlineoverride

Definition at line 131 of file HepRndmBaseEngine.h.

                                   {
      if ( m_hepEngine ) { CLHEP::HepRandom::setTheEngine( nullptr ); }
      m_hepEngine.reset();
      return RndmEngine::finalize();
    }

◆ hepEngine() [1/2]

CLHEP::HepRandomEngine * HepRndm::BaseEngine::hepEngine ( )

inline

Definition at line 126 of file HepRndmBaseEngine.h.

126{ return m_hepEngine.get(); }

◆ hepEngine() [2/2]

const CLHEP::HepRandomEngine * HepRndm::BaseEngine::hepEngine ( ) const

inline

Definition at line 127 of file HepRndmBaseEngine.h.

127{ return m_hepEngine.get(); }

◆ initEngine()

void HepRndm::BaseEngine::initEngine ( )

inlineprotected

Definition at line 138 of file HepRndmBaseEngine.h.

138{ m_hepEngine = createEngine(); }

HepRndm::BaseEngine::createEngine

virtual std::unique_ptr< CLHEP::HepRandomEngine > createEngine()=0

◆ rndm()

double HepRndm::BaseEngine::rndm ( ) const

inlineoverride

Definition at line 129 of file HepRndmBaseEngine.h.

129{ return m_hepEngine->flat(); }

Member Data Documentation

◆ m_hepEngine

std::unique_ptr<CLHEP::HepRandomEngine> HepRndm::BaseEngine::m_hepEngine

protected

Definition at line 121 of file HepRndmBaseEngine.h.

◆ m_threadSafe

Gaudi::Property<bool> HepRndm::BaseEngine::m_threadSafe { this, "ThreadSafe", true }

protected

Definition at line 122 of file HepRndmBaseEngine.h.

122{ this, "ThreadSafe", true };

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

GaudiSvc/src/RndmGenSvc/HepRndmBaseEngine.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BaseEngine()

Member Function Documentation

◆ create_engine()

◆ createEngine()

◆ finalize()

◆ hepEngine() [1/2]

◆ hepEngine() [2/2]

◆ initEngine()

◆ rndm()

Member Data Documentation

◆ m_hepEngine

◆ m_threadSafe