evgb::EvtTimeShiftI Class Reference

interface for event time distribution More...

#include <EvtTimeShiftI.h>

Inheritance diagram for evgb::EvtTimeShiftI:

Public Member Functions
	EvtTimeShiftI (const std::string &config)
virtual	~EvtTimeShiftI ()
virtual void	Config (const std::string &config)=0
virtual double	TimeOffset ()=0
virtual double	TimeOffset (std::vector< double > v)=0
virtual void	PrintConfig (bool verbose=true)=0
	provide a means of printing the configuration More...
TRandom *	GetRandomGenerator () const
bool	IsRandomGeneratorOwned () const
void	SetRandomGenerator (TRandom *gen, bool isOwned)

Protected Attributes
TRandom *	fRndmGen
bool	fIsOwned

Detailed Description

interface for event time distribution

Specific implementations of this class when are used to generate appropriate times relative to the t0 of a 'record' (spill/snarl/trigger...).

Concrete instances of this interface must be configurable from a string.

Author

Robert Hatcher <rhatcher fnal.gov> Fermi National Accelerator Laboratory

2015-06-22

Version

Id

EvtTimeShiftI.h,v 1.1 2015/06/30 18:01:24 rhatcher Exp

Definition at line 29 of file EvtTimeShiftI.h.

Constructor & Destructor Documentation

evgb::EvtTimeShiftI::EvtTimeShiftI

(

const std::string &

config

)

Definition at line 17 of file EvtTimeShiftI.cxx.

    : fRndmGen(new TRandom3), fIsOwned(true)
  { 
    // user should call Config(config) in their constructor
  }

evgb::EvtTimeShiftI::~EvtTimeShiftI ( )

virtual

Definition at line 23 of file EvtTimeShiftI.cxx.

  {
    if (fIsOwned) delete fRndmGen;
    fRndmGen = 0;
  }

Member Function Documentation

virtual void evgb::EvtTimeShiftI::Config ( const std::string &  config )

pure virtual

each schema must take a string that configures it it is up to the individual model to parse said string and extract parameters

Implemented in evgb::EvtTimeFlat, evgb::EvtTimeFNALBeam, and evgb::EvtTimeNone.

TRandom* evgb::EvtTimeShiftI::GetRandomGenerator ( ) const

inline

Allow users some control over random # sequences An "owned" object is expected to be deleted by the EvtTimeShift obj

Definition at line 61 of file EvtTimeShiftI.h.

{ return fRndmGen; }

bool evgb::EvtTimeShiftI::IsRandomGeneratorOwned ( ) const

inline

Definition at line 62 of file EvtTimeShiftI.h.

{ return fIsOwned; }

virtual void evgb::EvtTimeShiftI::PrintConfig ( bool  verbose = true )

pure virtual

provide a means of printing the configuration

Implemented in evgb::EvtTimeFlat, evgb::EvtTimeFNALBeam, and evgb::EvtTimeNone.

void evgb::EvtTimeShiftI::SetRandomGenerator	(	TRandom *	gen,
		bool	isOwned
	)

Definition at line 28 of file EvtTimeShiftI.cxx.

  {
    // deal with what we might already have
    if ( fIsOwned ) { delete fRndmGen; fRndmGen = 0; fIsOwned = false; }

    fRndmGen = gen;
    fIsOwned = isOwned;
  }

virtual double evgb::EvtTimeShiftI::TimeOffset ( )

pure virtual

return time (in nanoseconds) for an interaction/event within a record/spill/snarl

version taking array might be used for relative batch fractions that vary on a record-by-record basis

Implemented in evgb::EvtTimeFlat, evgb::EvtTimeFNALBeam, and evgb::EvtTimeNone.

virtual double evgb::EvtTimeShiftI::TimeOffset ( std::vector< double >  v )

pure virtual

Implemented in evgb::EvtTimeFlat, evgb::EvtTimeFNALBeam, and evgb::EvtTimeNone.

Member Data Documentation

bool evgb::EvtTimeShiftI::fIsOwned

protected

Definition at line 69 of file EvtTimeShiftI.h.

TRandom* evgb::EvtTimeShiftI::fRndmGen

protected

Definition at line 68 of file EvtTimeShiftI.h.

---

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

• nutools/old/EventGeneratorBase/GENIE/EvtTimeShiftI.h
• nutools/old/EventGeneratorBase/GENIE/EvtTimeShiftI.cxx