edm::RandomEngineSentry< T > Class Template Reference

#include <RandomEngineSentry.h>

Public Member Functions
CLHEP::HepRandomEngine const *	randomEngine () const
CLHEP::HepRandomEngine *&	randomEngine ()
	RandomEngineSentry (T *t, CLHEP::HepRandomEngine *engine)
	RandomEngineSentry (T *t, StreamID const &streamID)
	RandomEngineSentry (T *t, LuminosityBlockIndex const &lumi)
	~RandomEngineSentry ()

Private Attributes
edm::propagate_const< CLHEP::HepRandomEngine * >	engine_
edm::propagate_const< T * >	t_

Detailed Description

template<class T>
class edm::RandomEngineSentry< T >

Description:

Definition at line 28 of file RandomEngineSentry.h.

Constructor & Destructor Documentation

template<class T>

edm::RandomEngineSentry< T >::RandomEngineSentry ( T *  t, CLHEP::HepRandomEngine *  engine  )

inlineexplicit

Definition at line 30 of file RandomEngineSentry.h.

                                                                    : t_(t), engine_(engine) {
      if (t) {
        t->setRandomEngine(engine);
      }
    }

template<class T>

edm::RandomEngineSentry< T >::RandomEngineSentry ( T *  t, StreamID const &  streamID  )

inlineexplicit

Definition at line 36 of file RandomEngineSentry.h.

References Exception, and edm::Service< T >::isAvailable().

                                                                : t_(t), engine_(nullptr) {
      if (t) {
        Service<RandomNumberGenerator> rng;
        if (!rng.isAvailable()) {
          throw cms::Exception("Configuration")
              << "Attempt to get a random engine when the RandomNumberGeneratorService is not configured.\n"
                 "You must configure the service if you want an engine.\n";
        }
        engine_ = &rng->getEngine(streamID);
        t->setRandomEngine(engine_);
      }
    }

template<class T>

edm::RandomEngineSentry< T >::RandomEngineSentry ( T *  t, LuminosityBlockIndex const &  lumi  )

inlineexplicit

Definition at line 49 of file RandomEngineSentry.h.

References Exception, and edm::Service< T >::isAvailable().

                                                                        : t_(t), engine_(nullptr) {
      if (t) {
        Service<RandomNumberGenerator> rng;
        if (!rng.isAvailable()) {
          throw cms::Exception("Configuration")
              << "Attempt to get a random engine when the RandomNumberGeneratorService is not configured.\n"
                 "You must configure the service if you want an engine.\n";
        }
        engine_ = &rng->getEngine(lumi);
        t->setRandomEngine(engine_);
      }
    }

template<class T>

edm::RandomEngineSentry< T >::~RandomEngineSentry ( )

inline

Definition at line 62 of file RandomEngineSentry.h.

                          {
      if (t_)
        t_->setRandomEngine(nullptr);
    }

Member Function Documentation

template<class T>

CLHEP::HepRandomEngine const* edm::RandomEngineSentry< T >::randomEngine ( ) const

inline

Definition at line 67 of file RandomEngineSentry.h.

References edm::get_underlying_safe().

{ return get_underlying_safe(engine_); }

template<class T>

CLHEP::HepRandomEngine*& edm::RandomEngineSentry< T >::randomEngine ( )

inline

Definition at line 68 of file RandomEngineSentry.h.

References edm::get_underlying_safe().

{ return get_underlying_safe(engine_); }

Member Data Documentation

template<class T>

edm::propagate_const<CLHEP::HepRandomEngine*> edm::RandomEngineSentry< T >::engine_

private

Definition at line 72 of file RandomEngineSentry.h.

template<class T>

edm::propagate_const<T*> edm::RandomEngineSentry< T >::t_

private

Definition at line 71 of file RandomEngineSentry.h.