List of all members | Public Types | Public Member Functions | Static Public Member Functions | Private Types | Private Member Functions | Private Attributes
RdStationSimAntennaAlignmentError::RdStationSimAntennaAlignmentError Class Reference

#include <RdStationSimAntennaAlignmentError.h>

Inheritance diagram for RdStationSimAntennaAlignmentError::RdStationSimAntennaAlignmentError:
Inheritance graph
[legend]

Public Types

enum  ResultFlag { eSuccess, eFailure, eBreakLoop, eContinueLoop }
 Flag returned by module methods to the RunController. More...
 
enum  VersionInfoType {
  eFilename = 1, eRevisionNumber = 2, eDate = 3, eTime = 4,
  eLastEditor = 5
}
 Different types of version info that can be retrieved from GetVersionInfo. More...
 

Public Member Functions

fwk::VModule::ResultFlag Finish ()
 Finish: invoked at end of the run (NOT end of the event) More...
 
utl::StopwatchGetStopwatch ()
 
const utl::StopwatchGetStopwatch () const
 
std::string GetVersionInfo (const VersionInfoType v) const
 Retrieve different sorts of module version info. More...
 
fwk::VModule::ResultFlag Init ()
 Initialize: invoked at beginning of run (NOT beginning of event) More...
 
void InitTiming ()
 
 RdStationSimAntennaAlignmentError ()
 
fwk::VModule::ResultFlag Run (evt::Event &event)
 Run: invoked once per event. More...
 
ResultFlag RunWithTiming (evt::Event &event)
 
virtual ~RdStationSimAntennaAlignmentError ()
 

Static Public Member Functions

static std::string GetResultFlagByName (const ResultFlag flag)
 

Private Types

enum  InfoLevel {
  eNone = 0, eFinal = 1, eIntermediate = 2, eObscure = 3,
  eMinuit = 4
}
 

Private Member Functions

 REGISTER_MODULE ("RdStationSimAntennaAlignmentError", RdStationSimAntennaAlignmentError)
 

Private Attributes

double fAzimuthalAlignmentError
 
int fInfoLevel
 
bool fOnlyForVariedEvents
 
int fRandomSeed
 
double fZenithalAlignmentError
 
boost::normal_distribution
< double > 
normalRandom
 
boost::variate_generator
< boost::mt19937,
boost::normal_distribution
< double > > 
normalRandomGenerator
 
boost::mt19937 randgen
 
boost::uniform_real< double > uniformRandom
 
boost::variate_generator
< boost::mt19937,
boost::uniform_real< double > > 
uniformRandomGenerator
 

Detailed Description

Definition at line 25 of file RdStationSimAntennaAlignmentError.h.

Member Enumeration Documentation

Enumerator
eNone 
eFinal 
eIntermediate 
eObscure 
eMinuit 

Definition at line 37 of file RdStationSimAntennaAlignmentError.h.

enum fwk::VModule::ResultFlag
inherited

Flag returned by module methods to the RunController.

Enumerator
eSuccess 

Report success to RunController.

eFailure 

Report failure to RunController, causing RunController to terminate execution.

eBreakLoop 

Break current loop. It works for nested loops too!

eContinueLoop 

Skip remaining modules in the current loop and continue with next iteration of the loop.

Definition at line 60 of file VModule.h.

Different types of version info that can be retrieved from GetVersionInfo.

Enumerator
eFilename 
eRevisionNumber 
eDate 
eTime 
eLastEditor 

Definition at line 110 of file VModule.h.

Constructor & Destructor Documentation

RdStationSimAntennaAlignmentError::RdStationSimAntennaAlignmentError::RdStationSimAntennaAlignmentError ( )

Definition at line 48 of file RdStationSimAntennaAlignmentError.cc.

RdStationSimAntennaAlignmentError::RdStationSimAntennaAlignmentError::~RdStationSimAntennaAlignmentError ( )
virtual

Definition at line 61 of file RdStationSimAntennaAlignmentError.cc.

Member Function Documentation

VModule::ResultFlag RdStationSimAntennaAlignmentError::RdStationSimAntennaAlignmentError::Finish ( )
virtual

Finish: invoked at end of the run (NOT end of the event)

This method is for things that should be done at the end of the run (for example, closing files or writing out histograms) {You must override this method in your concrete module}

Implements fwk::VModule.

Definition at line 159 of file RdStationSimAntennaAlignmentError.cc.

References fwk::VModule::eSuccess, and INFO.

std::string fwk::VModule::GetResultFlagByName ( const ResultFlag  flag)
staticinherited
utl::Stopwatch& fwk::VModule::GetStopwatch ( )
inlineinherited

Definition at line 106 of file VModule.h.

References fwk::VModule::fStopwatch.

const utl::Stopwatch& fwk::VModule::GetStopwatch ( ) const
inlineinherited

Definition at line 107 of file VModule.h.

References fwk::VModule::fStopwatch.

std::string fwk::VModule::GetVersionInfo ( const VersionInfoType  v) const
inherited
VModule::ResultFlag RdStationSimAntennaAlignmentError::RdStationSimAntennaAlignmentError::Init ( )
virtual

Initialize: invoked at beginning of run (NOT beginning of event)

This method is for things that should be done once at the beginning of a run (for example, booking histograms, performing calculations that need to be done only once, initializing parameters) {You must override this method in your concrete module}

Implements fwk::VModule.

Definition at line 63 of file RdStationSimAntennaAlignmentError.cc.

References fwk::VModule::eSuccess, fAzimuthalAlignmentError, fInfoLevel, fOnlyForVariedEvents, fRandomSeed, fZenithalAlignmentError, utl::Branch::GetChild(), utl::Branch::GetData(), utl::Branch::GetTopBranch(), INFO, OUT, and randgen.

void fwk::VModule::InitTiming ( )
inlineinherited

Definition at line 95 of file VModule.h.

References fwk::VModule::fStopwatch, and utl::Stopwatch::Reset().

RdStationSimAntennaAlignmentError::RdStationSimAntennaAlignmentError::REGISTER_MODULE ( "RdStationSimAntennaAlignmentError"  ,
RdStationSimAntennaAlignmentError   
)
private
VModule::ResultFlag RdStationSimAntennaAlignmentError::RdStationSimAntennaAlignmentError::Run ( evt::Event event)
virtual
ResultFlag fwk::VModule::RunWithTiming ( evt::Event event)
inlineinherited

Member Data Documentation

double RdStationSimAntennaAlignmentError::RdStationSimAntennaAlignmentError::fAzimuthalAlignmentError
private

Definition at line 48 of file RdStationSimAntennaAlignmentError.h.

Referenced by Init(), and Run().

int RdStationSimAntennaAlignmentError::RdStationSimAntennaAlignmentError::fInfoLevel
private

Definition at line 45 of file RdStationSimAntennaAlignmentError.h.

Referenced by Init().

bool RdStationSimAntennaAlignmentError::RdStationSimAntennaAlignmentError::fOnlyForVariedEvents
private

Definition at line 46 of file RdStationSimAntennaAlignmentError.h.

Referenced by Init(), and Run().

int RdStationSimAntennaAlignmentError::RdStationSimAntennaAlignmentError::fRandomSeed
private

Definition at line 49 of file RdStationSimAntennaAlignmentError.h.

Referenced by Init().

double RdStationSimAntennaAlignmentError::RdStationSimAntennaAlignmentError::fZenithalAlignmentError
private

Definition at line 47 of file RdStationSimAntennaAlignmentError.h.

Referenced by Init(), and Run().

boost::normal_distribution<double> RdStationSimAntennaAlignmentError::RdStationSimAntennaAlignmentError::normalRandom
private

Definition at line 52 of file RdStationSimAntennaAlignmentError.h.

boost::variate_generator<boost::mt19937, boost::normal_distribution<double> > RdStationSimAntennaAlignmentError::RdStationSimAntennaAlignmentError::normalRandomGenerator
private

Definition at line 53 of file RdStationSimAntennaAlignmentError.h.

Referenced by Run().

boost::mt19937 RdStationSimAntennaAlignmentError::RdStationSimAntennaAlignmentError::randgen
private

Definition at line 51 of file RdStationSimAntennaAlignmentError.h.

Referenced by Init().

boost::uniform_real<double> RdStationSimAntennaAlignmentError::RdStationSimAntennaAlignmentError::uniformRandom
private

Definition at line 54 of file RdStationSimAntennaAlignmentError.h.

boost::variate_generator<boost::mt19937, boost::uniform_real<double> > RdStationSimAntennaAlignmentError::RdStationSimAntennaAlignmentError::uniformRandomGenerator
private

Definition at line 55 of file RdStationSimAntennaAlignmentError.h.

Referenced by Run().


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

, generated on Tue Sep 26 2023.