HepRndm::BaseEngine Class Referenceabstract

#include <src/RndmGenSvc/HepRndmBaseEngine.h>

Inheritance diagram for HepRndm::BaseEngine:
Collaboration diagram for HepRndm::BaseEngine:

Public Member Functions

 BaseEngine (const std::string &name, ISvcLocator *loc)
 
 ~BaseEngine () override=default
 
CLHEP::HepRandomEngine * hepEngine ()
 
const CLHEP::HepRandomEngine * hepEngine () const
 
double rndm () const override
 Single shot returning single random number. More...
 
StatusCode finalize () override
 Service override: finalization. More...
 
- Public Member Functions inherited from RndmEngine
virtual StatusCode initialize ()
 Service override: initialization. More...
 
virtual StatusCode rndmArray (std::vector< double > &array, long howmany, long start=0) const
 Multiple shots returning vector with flat random numbers. More...
 
virtual StreamBufferserialize (StreamBuffer &str)
 Input serialization from stream buffer. More...
 
virtual StreamBufferserialize (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::stringgetInterfaceNames () const override
 Implementation of IInterface::getInterfaceNames. More...
 
 ~extends () override=default
 Virtual destructor. More...
 
- Public Member Functions inherited from Service
const std::stringname () 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 PropertygetProperty (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 >
PropertydeclareProperty (const std::string &name, T &property, const std::string &doc="none") const
 Declare the named property. More...
 
PropertydeclareRemoteProperty (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...
 
MsgStreammsgStream () const
 Return an uninitialized MsgStream. More...
 
MsgStreammsgStream (const MSG::Level level) const
 Predefined configurable message stream for the efficient printouts. More...
 
MsgStreamalways () const
 shortcut for the method msgStream(MSG::ALWAYS) More...
 
MsgStreamfatal () const
 shortcut for the method msgStream(MSG::FATAL) More...
 
MsgStreamerr () const
 shortcut for the method msgStream(MSG::ERROR) More...
 
MsgStreamerror () const
 shortcut for the method msgStream(MSG::ERROR) More...
 
MsgStreamwarning () const
 shortcut for the method msgStream(MSG::WARNING) More...
 
MsgStreaminfo () const
 shortcut for the method msgStream(MSG::INFO) More...
 
MsgStreamdebug () const
 shortcut for the method msgStream(MSG::DEBUG) More...
 
MsgStreamverbose () const
 shortcut for the method msgStream(MSG::VERBOSE) More...
 
MsgStreammsg () 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

void initEngine ()
 
virtual std::unique_ptr< CLHEP::HepRandomEngine > createEngine ()=0
 
- Protected Member Functions inherited from RndmEngine
 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

std::unique_ptr< CLHEP::HepRandomEngine > m_hepEngine
 
- Protected Attributes inherited from RndmEngine
SmartIF< IIncidentSvcm_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

Definition at line 29 of file HepRndmBaseEngine.h.

Constructor & Destructor Documentation

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

Definition at line 33 of file HepRndmBaseEngine.h.

34  : RndmEngine( name, loc ) { }
RndmEngine(const std::string &name, ISvcLocator *loc)
Standard Constructor.
Definition: RndmEngine.cpp:31
HepRndm::BaseEngine::~BaseEngine ( )
overridedefault

Member Function Documentation

StatusCode HepRndm::BaseEngine::finalize ( )
inlineoverridevirtual

Service override: finalization.

Reimplemented from RndmEngine.

Reimplemented in HepRndm::Engine< TYPE >.

Definition at line 41 of file HepRndmBaseEngine.h.

41  {
42  if (m_hepEngine) CLHEP::HepRandom::setTheEngine(nullptr);
44  return RndmEngine::finalize();
45  }
std::unique_ptr< CLHEP::HepRandomEngine > m_hepEngine
virtual StatusCode finalize()
Service override: finalization.
Definition: RndmEngine.cpp:56
T reset(T...args)
CLHEP::HepRandomEngine* HepRndm::BaseEngine::hepEngine ( )
inline

Definition at line 36 of file HepRndmBaseEngine.h.

36 { return m_hepEngine.get(); }
std::unique_ptr< CLHEP::HepRandomEngine > m_hepEngine
T get(T...args)
const CLHEP::HepRandomEngine* HepRndm::BaseEngine::hepEngine ( ) const
inline

Definition at line 37 of file HepRndmBaseEngine.h.

37 { return m_hepEngine.get(); }
std::unique_ptr< CLHEP::HepRandomEngine > m_hepEngine
T get(T...args)
void HepRndm::BaseEngine::initEngine ( )
inlineprotected

Definition at line 48 of file HepRndmBaseEngine.h.

std::unique_ptr< CLHEP::HepRandomEngine > m_hepEngine
virtual std::unique_ptr< CLHEP::HepRandomEngine > createEngine()=0
double HepRndm::BaseEngine::rndm ( ) const
inlineoverridevirtual

Single shot returning single random number.

Reimplemented from RndmEngine.

Definition at line 39 of file HepRndmBaseEngine.h.

39 { return m_hepEngine->flat(); }
std::unique_ptr< CLHEP::HepRandomEngine > m_hepEngine

Member Data Documentation

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

Definition at line 31 of file HepRndmBaseEngine.h.


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