| The Gaudi Framework v32r1 (f65d50dc)

RndmGenSvc.cpp
Go to the documentation of this file.
1 //====================================================================
2 // Random Generator service implementation
3 //--------------------------------------------------------------------
4 //
5 // Package : Gaudi/RndmGen ( The LHCb Offline System)
6 // Author : M.Frank
7 // History :
8 // +---------+----------------------------------------------+---------
9 // | Date | Comment | Who
10 // +---------+----------------------------------------------+---------
11 // | 29/10/99| Initial version | MF
12 // +---------+----------------------------------------------+---------
13 //
14 //====================================================================
15 #define GAUDI_RANDOMGENSVC_RNDMGENSVC_CPP
16
17 // STL include files
18 #include <cfloat>
19
20 // Framework include files
21 #include "GaudiKernel/IRndmEngine.h"
22 #include "GaudiKernel/ISvcManager.h"
23 #include "GaudiKernel/ObjectFactory.h"
24 #include "GaudiKernel/SmartIF.h"
25
26 #include "RndmGen.h"
27 #include "RndmGenSvc.h"
28
29 // Instantiation of a static factory class used by clients to create
30 // instances of this service
31 DECLARE_COMPONENT( RndmGenSvc )
32
33 StatusCode RndmGenSvc::initialize() {
35 StatusCode status = Service::initialize();
36
37 auto mgr = serviceLocator()->as<ISvcManager>();
38
39 if ( status.isSuccess() ) {
40 status = setProperties();
41 if ( status.isSuccess() ) { // Check if the Engine service exists:
42 // FIXME: (MCl) why RndmGenSvc cannot create the engine service in a standard way?
43 const bool CREATE = false;
44 std::string machName = name() + ".Engine";
45 auto engine = serviceLocator()->service<IRndmEngine>( machName, CREATE );
46 if ( !engine && mgr ) {
47 using Gaudi::Utils::TypeNameString;
48 engine = mgr->createService( TypeNameString( machName, m_engineName ) );
49 }
50 if ( engine ) {
51 auto serial = engine.as<ISerialize>();
52 auto service = engine.as<IService>();
53 if ( serial && service ) {
54 status = service->sysInitialize();
55 if ( status.isSuccess() ) {
56 m_engine = engine;
57 m_serialize = serial;
58 info() << "Using Random engine:" << m_engineName.value() << endmsg;
59 }
60 }
61 }
62 }
63 }
64 return status;
65 }
66
68 StatusCode RndmGenSvc::finalize() {
69 StatusCode status = Service::finalize();
70 m_serialize.reset();
71 if ( m_engine ) {
72 m_engine.as<IService>()->finalize().ignore();
73 m_engine.reset();
74 }
75 return status;
76 }
77
79 StreamBuffer& RndmGenSvc::serialize( StreamBuffer& str ) {
81 if ( m_serialize ) return m_serialize->serialize( str );
82 error() << "Cannot input serialize Generator settings!" << endmsg;
83 return str;
84 }
85
87 StreamBuffer& RndmGenSvc::serialize( StreamBuffer& str ) const {
88 if ( m_serialize ) return m_serialize->serialize( str );
89 error() << "Cannot output serialize Generator settings!" << endmsg;
90 return str;
91 }
92
94 IRndmEngine* RndmGenSvc::engine() { return m_engine.get(); }
95
97 StatusCode RndmGenSvc::generator( const IRndmGen::Param& par, IRndmGen*& refpGen ) {
98 auto pGen = SmartIF<IRndmGen>( ObjFactory::create( par.type(), m_engine.get() ).release() );
99 if ( !pGen ) {
100 refpGen = nullptr;
101 return StatusCode::FAILURE;
102 }
103 refpGen = pGen.get();
104 refpGen->addRef(); // insure the caller gets something with a refCount of (at least) one back...
105 return refpGen->initialize( par );
106 }
107
108 // Single shot returning single random number
109 double RndmGenSvc::rndm() const { return m_engine ? m_engine->rndm() : -1; }
110
111 /* Multiple shots returning vector with flat random numbers.
112 @param array Array containing random numbers
113 @param howmany fill 'howmany' random numbers into array
114 @param start ... starting at position start
115 @return StatusCode indicating failure or success.
116 */
117 StatusCode RndmGenSvc::rndmArray( std::vector<double>& array, long howmany, long start ) const {
118 return m_engine ? m_engine->rndmArray( array, howmany, start ) : StatusCode::FAILURE;
119 }
120
121 // Allow to set new seeds
122 StatusCode RndmGenSvc::setSeeds( const std::vector<long>& seeds ) {
123 return m_engine ? m_engine->setSeeds( seeds ) : StatusCode::FAILURE;
124 }
125
126 // Allow to get the seeds
127 StatusCode RndmGenSvc::seeds( std::vector<long>& seeds ) const {
128 return m_engine ? m_engine->seeds( seeds ) : StatusCode::FAILURE;
129 }
IRndmGen::initialize
virtual StatusCode initialize(const IRndmGen::Param &par)=0
Initialize the generator.
Service::initialize
StatusCode initialize() override
Definition: Service.cpp:60
RndmGenSvc.h
SmartIF< IRndmGen >
Service::serviceLocator
SmartIF< ISvcLocator > & serviceLocator() const override
Retrieve pointer to service locator.
Definition: Service.cpp:277
IRndmEngine::rndmArray
virtual StatusCode rndmArray(std::vector< double > &array, long howmany, long start=0) const =0
Multiple shots returning vector with flat random numbers.
RndmGenSvc::serialize
StreamBuffer & serialize(StreamBuffer &str) override
IRndmGenSvc interface implementation.
Definition: RndmGenSvc.cpp:80
RndmGenSvc::initialize
StatusCode initialize() override
Service override: initialization.
Definition: RndmGenSvc.cpp:34
Service::finalize
StatusCode finalize() override
Definition: Service.cpp:164
RndmGenSvc::finalize
StatusCode finalize() override
Service override: finalization.
Definition: RndmGenSvc.cpp:68
Service::start
StatusCode start() override
Definition: Service.cpp:129
ISvcManager
The ISvcManager is the interface implemented by the Service Factory in the Application Manager to sup...
Definition: ISvcManager.h:28
StreamBuffer
The stream buffer is a small object collecting object data.
Definition: StreamBuffer.h:41
IRndmGen
Definition of a interface for a generic random number generators.
Definition: IRndmGen.h:34
RndmGenSvc::m_engine
SmartIF< IRndmEngine > m_engine
Random number engine.
Definition: RndmGenSvc.h:52
ObjectFactory.h
SmartIF::as
SmartIF< IFace > as() const
return a new SmartIF instance to another interface
Definition: SmartIF.h:107
RndmGenSvc::m_engineName
Gaudi::Property< std::string > m_engineName
Definition: RndmGenSvc.h:56
ISvcLocator::as
SmartIF< IFace > as()
Definition: ISvcLocator.h:103
CommonMessagingBase::info
MsgStream & info() const
shortcut for the method msgStream(MSG::INFO)
Definition: CommonMessaging.h:104
SmartIF::get
TYPE * get() const
Get interface pointer.
Definition: SmartIF.h:76
IOTest.start
def start
Definition: IOTest.py:97
ISvcManager.h
std::string
STL class.
RndmGenSvc
Random Generator service definition.
Definition: RndmGenSvc.h:49
DECLARE_COMPONENT
#define DECLARE_COMPONENT(type)
Definition: PluginServiceV1.h:46
ISvcLocator::service
StatusCode service(const Gaudi::Utils::TypeNameString &name, T *&svc, bool createIf=true)
Templated method to access a service by name.
Definition: ISvcLocator.h:76
Service::name
const std::string & name() const override
Retrieve name of the service.
Definition: Service.cpp:274
IRndmEngine.h
CommonMessagingBase::error
MsgStream & error() const
shortcut for the method msgStream(MSG::ERROR)
Definition: CommonMessaging.h:98
Gaudi::Utils::TypeNameString
Helper class to parse a string of format "type/name".
Definition: TypeNameString.h:10
compareOutputFiles.par
string par
Definition: compareOutputFiles.py:465
IService
General service interface definition.
Definition: IService.h:18
StatusCode
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:50
IRndmEngine::rndm
virtual double rndm() const =0
Single shot returning single random number.
IRndmGen::Param
Definition: IRndmGen.h:39
ISerialize::serialize
virtual StreamBuffer & serialize(StreamBuffer &str)=0
Input serialization from stream buffer.
SmartIF.h
RndmGenSvc::seeds
StatusCode seeds(std::vector< long > &seeds) const override
Allow to get seeds.
Definition: RndmGenSvc.cpp:127
RndmGenSvc::generator
StatusCode generator(const IRndmGen::Param &par, IRndmGen *&refpGen) override
Retrieve a valid generator from the service.
Definition: RndmGenSvc.cpp:97
IRndmEngine::setSeeds
virtual StatusCode setSeeds(const std::vector< long > &seeds)=0
Allow to set new seeds.
RndmGen.h
StatusCode::isSuccess
bool isSuccess() const
Definition: StatusCode.h:267
RndmGenSvc::rndmArray
StatusCode rndmArray(std::vector< double > &array, long howmany, long start=0) const override
Multiple shots returning vector with flat random numbers.
Definition: RndmGenSvc.cpp:117
Service::setProperties
StatusCode setProperties()
Method for setting declared properties to the values specified for the job.
Definition: Service.cpp:280
RndmGenSvc::rndm
double rndm() const override
Single shot returning single random number.
Definition: RndmGenSvc.cpp:109
StatusCode::ignore
const StatusCode & ignore() const
Ignore/check StatusCode.
Definition: StatusCode.h:153
Containers::array
struct GAUDI_API array
Parametrisation class for redirection array - like implementation.
Definition: KeyedObjectManager.h:27
std::vector< double >
RndmGenSvc::setSeeds
StatusCode setSeeds(const std::vector< long > &seeds) override
Allow to set new seeds.
Definition: RndmGenSvc.cpp:122
Io::CREATE
Definition: IFileMgr.h:31
StatusCode::FAILURE
constexpr static const auto FAILURE
Definition: StatusCode.h:86
IInterface::addRef
virtual unsigned long addRef()=0
Increment the reference count of Interface instance.
Service::service
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.
Definition: Service.h:83
IRndmEngine
Definition of a interface for a generic random number generator giving randomly distributed numbers i...
Definition: IRndmEngine.h:19
SmartIF::reset
void reset(TYPE *ptr=nullptr)
Set the internal pointer to the passed one disposing of the old one.
Definition: SmartIF.h:86
RndmGenSvc::engine
IRndmEngine * engine() override
Retrieve engine.
Definition: RndmGenSvc.cpp:94
RndmGenSvc::m_serialize
SmartIF< ISerialize > m_serialize
Serialization interface of random number engine.
Definition: RndmGenSvc.h:54
ISerialize
Object serialization interface definition.
Definition: ISerialize.h:17
IRndmEngine::seeds
virtual StatusCode seeds(std::vector< long > &seeds) const =0
Allow to retrieve seeds.
endmsg
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:192