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

#include <RdClusterFinder.h>

Inheritance diagram for RdClusterFinder::RdClusterFinder:
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 () override
 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 () override
 Initialize: invoked at beginning of run (NOT beginning of event) More...
 
void InitTiming ()
 
fwk::VModule::ResultFlag Run (evt::Event &event) override
 Run: invoked once per event. More...
 
ResultFlag RunWithTiming (evt::Event &event)
 

Static Public Member Functions

static std::string GetResultFlagByName (const ResultFlag flag)
 

Protected Types

enum  InfoLevel { eInfoNone = 0, eInfoFinal = 1, eInfoIntermediate = 2, eInfoDebug = 3 }
 

Protected Attributes

int fInfoLevel = 0
 

Private Member Functions

bool CheckRejection (const revt::Station &station)
 
 REGISTER_MODULE ("RdClusterFinder", RdClusterFinder)
 
bool UseStation (const revt::Station &station)
 

Private Attributes

bool fIgnoreExcludedStations = false
 
unsigned int fIgnoreRejectedStations = 0
 
double fLonelyIfNoneInDistance = 0
 
double fLonelyIfNoneInDistancePhase3 = 0
 
double fLonelyIfOneInDistance = 0
 
double fLonelyIfOneInDistancePhase3 = 0
 
double fMaximumDiscontinuity = 0
 
bool fRejectLonelyStations = false
 

Detailed Description

Definition at line 19 of file RdClusterFinder.h.

Member Enumeration Documentation

enum fwk::VModule::InfoLevel
protectedinherited
Enumerator
eInfoNone 
eInfoFinal 
eInfoIntermediate 
eInfoDebug 

Definition at line 125 of file VModule.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.

Member Function Documentation

bool RdClusterFinder::RdClusterFinder::CheckRejection ( const revt::Station station)
private
VModule::ResultFlag RdClusterFinder::RdClusterFinder::Finish ( )
overridevirtual

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 189 of file RdClusterFinder.cc.

References io::eSuccess.

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 RdClusterFinder::RdClusterFinder::Init ( )
overridevirtual

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 37 of file RdClusterFinder.cc.

References ERROR, io::eSuccess, utl::Branch::GetChild(), utl::Branch::GetData(), and utl::Branch::GetTopBranch().

void fwk::VModule::InitTiming ( )
inlineinherited

Definition at line 95 of file VModule.h.

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

RdClusterFinder::RdClusterFinder::REGISTER_MODULE ( "RdClusterFinder"  ,
RdClusterFinder   
)
private
VModule::ResultFlag RdClusterFinder::RdClusterFinder::Run ( evt::Event event)
overridevirtual
ResultFlag fwk::VModule::RunWithTiming ( evt::Event event)
inlineinherited
bool RdClusterFinder::RdClusterFinder::UseStation ( const revt::Station station)
private

Member Data Documentation

bool RdClusterFinder::RdClusterFinder::fIgnoreExcludedStations = false
private

Definition at line 30 of file RdClusterFinder.h.

unsigned int RdClusterFinder::RdClusterFinder::fIgnoreRejectedStations = 0
private

Definition at line 29 of file RdClusterFinder.h.

int fwk::VModule::fInfoLevel = 0
protectedinherited
double RdClusterFinder::RdClusterFinder::fLonelyIfNoneInDistance = 0
private

Definition at line 34 of file RdClusterFinder.h.

double RdClusterFinder::RdClusterFinder::fLonelyIfNoneInDistancePhase3 = 0
private

Definition at line 36 of file RdClusterFinder.h.

double RdClusterFinder::RdClusterFinder::fLonelyIfOneInDistance = 0
private

Definition at line 35 of file RdClusterFinder.h.

double RdClusterFinder::RdClusterFinder::fLonelyIfOneInDistancePhase3 = 0
private

Definition at line 37 of file RdClusterFinder.h.

double RdClusterFinder::RdClusterFinder::fMaximumDiscontinuity = 0
private

Definition at line 32 of file RdClusterFinder.h.

bool RdClusterFinder::RdClusterFinder::fRejectLonelyStations = false
private

Definition at line 28 of file RdClusterFinder.h.


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

, generated on Tue Sep 26 2023.