---

RandomNumberGenerator.h

Go to the documentation of this file.

#ifndef FWCore_Utilities_RandomNumberGenerator_h
#define FWCore_Utilities_RandomNumberGenerator_h
// -*- C++ -*-
//
// Package:     Utilities
// Class  :     RandomNumberGenerator
// 
//
// Original Author:  Chris Jones, W. David Dagenhart
//         Created:  Tue Mar  7 09:30:28 EST 2006
//

#include <vector>
#include <string>

namespace CLHEP {
  class HepRandomEngine;
}

namespace edm {

  class Event;

  class RandomNumberGenerator
  {

  public:

    RandomNumberGenerator() {}
    virtual ~RandomNumberGenerator();

    virtual CLHEP::HepRandomEngine& getEngine() const = 0;    

    virtual uint32_t mySeed() const = 0;

    // The following functions should not be used by general users.  They
    // should only be called by code designed to work with the service while
    // it is saving the engine state to an event or restoring it from an event.
    // The first 3 are called by a dedicated producer module (RandomEngineStateProducer).
    // The other two by the InputSource base class.

    virtual const std::vector<std::string>& getCachedLabels() const = 0;
    virtual const std::vector<std::vector<uint32_t> >& getCachedStates() const = 0;
    virtual const std::vector<std::vector<uint32_t> >& getCachedSeeds() const = 0;

    virtual void snapShot() = 0;
    virtual void restoreState(const Event& event) = 0;

    // For debugging purposes only
    virtual void print() = 0;
    virtual void saveEngineState(const std::string& fileName) = 0;
    virtual void restoreEngineState(const std::string& fileName) = 0;

  private:

    RandomNumberGenerator(const RandomNumberGenerator&); // stop default
    const RandomNumberGenerator& operator=(const RandomNumberGenerator&); // stop default
  };
}
#endif

---