Random Generator engine definition. More...

#include <src/RndmGenSvc/RndmEngine.h>

Inheritance diagram for RndmEngine:

Collaboration diagram for RndmEngine:

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

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

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

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 extends< Service, IRndmEngine, ISerialize, IIncidentListener >
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...

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

virtual	~RndmEngine ()
	Standard Destructor. 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
SmartIF< IIncidentSvc >	m_pIncidentSvc
	Reference to the incident service. 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...

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

Detailed Description

Random Generator engine definition.

Description: Definition of a interface for a generic random number generator giving randomly distributed numbers in the range [0...1] number generators.

Dependencies:

Generic Service interface: Gaudi/Interfaces/IRndmEngine.h

History :

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

Author: M.Frank Version: 1.0

Definition at line 46 of file RndmEngine.h.

Constructor & Destructor Documentation

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

protected

Standard Constructor.

Standard Service constructor.

Definition at line 31 of file RndmEngine.cpp.

 : base_class(name, loc)
 {
 }

RndmEngine::~RndmEngine ( )

protectedvirtual

Standard Destructor.

Standard Service destructor.

Definition at line 37 of file RndmEngine.cpp.

37 {

38 }

Member Function Documentation

StatusCode RndmEngine::finalize ( )

virtual

Service override: finalization.

Reimplemented in HepRndm::BaseEngine, and HepRndm::Engine< TYPE >.

Definition at line 56 of file RndmEngine.cpp.

                                   {
   m_pIncidentSvc = 0; // release
   return Service::finalize();
 }

void RndmEngine::handle ( const Incident & inc )

virtual

Inform that a new incident has occurred.

Single shot returning single random number.

Definition at line 78 of file RndmEngine.cpp.

78 {

79 }

StatusCode RndmEngine::initialize ( )

virtual

Service override: initialization.

Reimplemented in HepRndm::Engine< TYPE >.

Definition at line 41 of file RndmEngine.cpp.

                                     {
   StatusCode status = Service::initialize();
   if ( status.isSuccess() )   {
     status = setProperties();
     if ( status.isSuccess() )   {
       m_pIncidentSvc = serviceLocator()->service("IncidentSvc");
       if (!m_pIncidentSvc) {
         status = StatusCode::FAILURE;
       }
     }
   }
   return status;
 }

double RndmEngine::rndm ( ) const

virtual

Single shot returning single random number.

Reimplemented in HepRndm::BaseEngine.

Definition at line 73 of file RndmEngine.cpp.

                                 {
   return DBL_MAX;
 }

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

virtual

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 87 of file RndmEngine.cpp.

                                                                                             {
   long cnt = start;
   array.resize(start+howmany);
   for ( long i = start, num = start+howmany; i < num; i++ )     {
     array[cnt++] = rndm();
   }
   return StatusCode::SUCCESS;
 }

StreamBuffer & RndmEngine::serialize ( StreamBuffer & str )

virtual

Input serialization from stream buffer.

IRndmEngine interface implementation.

Restores the status of the object.

Parameters

str	Reference to Streambuffer to be filled

Returns: Reference to filled stream buffer

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

Definition at line 63 of file RndmEngine.cpp.

                                                         {
   return str;
 }

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

virtual

Output serialization to stream buffer.

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

Saves the status of the object.

Parameters

str	Reference to Streambuffer to be read

Returns: Reference to read stream buffer

Definition at line 68 of file RndmEngine.cpp.

                                                               {
   return str;
 }

Member Data Documentation

SmartIF<IIncidentSvc> RndmEngine::m_pIncidentSvc

protected

Reference to the incident service.

Definition at line 53 of file RndmEngine.h.

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation