Random Generator engine definition. More...

#include <RndmEngine.h>

Inheritance diagram for RndmEngine:

Collaboration diagram for RndmEngine:

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

virtual StatusCode	finalize ()
	Service override: finalization.

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

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

virtual StreamBuffer &	serialize (StreamBuffer &str)
	Input serialization from stream buffer.

virtual StreamBuffer &	serialize (StreamBuffer &str) const
	Output serialization to stream buffer.

virtual void	handle (const Incident &inc)
	Inform that a new incident has occurred.

Public Member Functions inherited from extends3< Service, IRndmEngine, ISerialize, IIncidentListener >
	extends3 (A1 a1, A2 a2, A3 a3)
	Templated constructor with 3 arguments.

	extends3 (A1 a1, A2 a2)
	Templated constructor with 2 arguments.

	extends3 (A1 a1)
	Templated constructor with 1 argument.

	extends3 ()
	Default constructor.

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

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

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

virtual	~extends3 ()
	Virtual destructor.

Public Member Functions inherited from Service
virtual unsigned long	release ()
	Release Interface instance.

virtual const std::string &	name () const
	Retrieve name of the service.

virtual StatusCode	configure ()

virtual StatusCode	start ()

virtual StatusCode	stop ()

virtual StatusCode	terminate ()

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

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

virtual StatusCode	reinitialize ()

virtual StatusCode	restart ()

virtual StatusCode	sysInitialize ()
	Initialize Service.

virtual StatusCode	sysStart ()
	Initialize Service.

virtual StatusCode	sysStop ()
	Initialize Service.

virtual StatusCode	sysFinalize ()
	Finalize Service.

virtual StatusCode	sysReinitialize ()
	Re-initialize the Service.

virtual StatusCode	sysRestart ()
	Re-initialize the Service.

virtual StatusCode	setProperty (const Property &p)

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

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

virtual StatusCode	getProperty (Property *p) const

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

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

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

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

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

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

StatusCode	setProperties ()
	Method for setting declared properties to the values specified for the job.

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.

template<class T >
StatusCode	service (const std::string &name, T *&psvc, 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.

template<class T >
Property *	declareProperty (const std::string &name, T &property, const std::string &doc="none") const
	Declare the named property.

Property *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="") const
	Declare remote named properties.

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

Public Member Functions inherited from CommonMessaging< implements3< IService, IProperty, IStateful > >
	CommonMessaging (const A1 &a1, const A2 &a2, const A3 &a3)
	Templated constructor with 3 arguments.

	CommonMessaging (const A1 &a1, const A2 &a2)
	Templated constructor with 2 arguments.

	CommonMessaging (const A1 &a1)
	Templated constructor with 1 argument.

	CommonMessaging ()
	Default constructor.

virtual	~CommonMessaging ()
	Virtual destructor.

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 output level from the embedded MsgStream

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

Public Member Functions inherited from extend_interfaces3< I1, I2, I3 >
virtual	~extend_interfaces3 ()
	Virtual destructor.

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

virtual	~RndmEngine ()
	Standard Destructor.

Protected Attributes
SmartIF< IIncidentSvc >	m_pIncidentSvc
	Reference to the incident service.

Additional Inherited Members
Public Types inherited from extends3< Service, IRndmEngine, ISerialize, IIncidentListener >
typedef extends3	base_class
	Typedef to this class.

typedef extend_interfaces3 < IRndmEngine, ISerialize, IIncidentListener >	extend_interfaces_base
	Typedef to the base of this class.

typedef extend_interfaces_base::ext_iids	interfaces
	MPL set of all the implemented interfaces.

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.

{

}

Member Function Documentation

StatusCode RndmEngine::finalize ( )

virtual

Service override: finalization.

Reimplemented from Service.

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

{

}

StatusCode RndmEngine::initialize ( )

virtual

Service override: initialization.

Reimplemented from Service.

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.isValid()) {
        status = StatusCode::FAILURE;
      }
    }
  }
  return status;
}

double RndmEngine::rndm ( ) const

virtual

Single shot returning single random number.

Reimplemented in HepRndm::Engine< TYPE >.

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 50 of file RndmEngine.h.

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

/afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v25r0/GaudiSvc/src/RndmGenSvc/RndmEngine.h
/afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v25r0/GaudiSvc/src/RndmGenSvc/RndmEngine.cpp

Gaudi Framework, version v25r0

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation