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

#include <RdMonitoring.h>

Inheritance diagram for RdMonitoring::RdMonitoring:
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 ()
 
 RdMonitoring ()
 
fwk::VModule::ResultFlag Run (evt::Event &event) override
 Run: invoked once per event. More...
 
ResultFlag RunWithTiming (evt::Event &event)
 
 ~RdMonitoring () override
 

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

 REGISTER_MODULE ("RdMonitoring", RdMonitoring)
 

Private Attributes

std::vector< double > fBeaconFrequencies
 
int fCurChannelId
 
int fCurEventId
 
int fCurGPSSecond
 
int fCurRunId
 
int fCurStationId
 
std::set< int > fDebugStationIds
 List of station IDs which will be included into debugging file. More...
 
bool fDownsample10sTriggers
 
double fMaxFrequency
 
double fMinFrequency
 
std::string fOutputFileName
 
std::string fPathToStoreOutput
 
int fPrevGPSSecond
 
double fSpectrumFractionToSearch
 
double fSpectrumMinPeakSNR
 
int fSpectrumNoiseFilterSize
 
int fSpectrumPeakFilterSize
 
int fTraceNSigmaRMS
 

Static Private Attributes

static revt::REventfgCurrentREvent
 

Detailed Description

Definition at line 53 of file RdMonitoring.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.

Constructor & Destructor Documentation

RdMonitoring::RdMonitoring::RdMonitoring ( )

Definition at line 66 of file RdMonitoring.cc.

RdMonitoring::RdMonitoring::~RdMonitoring ( )
inlineoverride

Definition at line 57 of file RdMonitoring.h.

Member Function Documentation

VModule::ResultFlag RdMonitoring::RdMonitoring::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 492 of file RdMonitoring.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 RdMonitoring::RdMonitoring::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 87 of file RdMonitoring.cc.

References fwk::VModule::eSuccess, fBeaconFrequencies, fDebugStationIds, fDownsample10sTriggers, fMaxFrequency, fMinFrequency, fOutputFileName, fPathToStoreOutput, fSpectrumFractionToSearch, fSpectrumMinPeakSNR, fSpectrumNoiseFilterSize, fSpectrumPeakFilterSize, fTraceNSigmaRMS, utl::Branch::GetChild(), utl::Branch::GetData(), utl::Branch::GetTopBranch(), INFO, out, utl::StringEquivalent(), and WARNING.

void fwk::VModule::InitTiming ( )
inlineinherited

Definition at line 95 of file VModule.h.

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

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

Member Data Documentation

std::vector<double> RdMonitoring::RdMonitoring::fBeaconFrequencies
private

Definition at line 77 of file RdMonitoring.h.

Referenced by Init(), and Run().

int RdMonitoring::RdMonitoring::fCurChannelId
private

Definition at line 67 of file RdMonitoring.h.

Referenced by Run().

int RdMonitoring::RdMonitoring::fCurEventId
private

Definition at line 65 of file RdMonitoring.h.

Referenced by Run().

int RdMonitoring::RdMonitoring::fCurGPSSecond
private

Definition at line 68 of file RdMonitoring.h.

Referenced by Run().

int RdMonitoring::RdMonitoring::fCurRunId
private

Definition at line 64 of file RdMonitoring.h.

Referenced by Run().

int RdMonitoring::RdMonitoring::fCurStationId
private

Definition at line 66 of file RdMonitoring.h.

Referenced by Run().

std::set<int> RdMonitoring::RdMonitoring::fDebugStationIds
private

List of station IDs which will be included into debugging file.

Definition at line 84 of file RdMonitoring.h.

Referenced by Init(), and Run().

bool RdMonitoring::RdMonitoring::fDownsample10sTriggers
private

Definition at line 72 of file RdMonitoring.h.

Referenced by Init(), and Run().

REvent * RdMonitoring::RdMonitoring::fgCurrentREvent
staticprivate

Definition at line 86 of file RdMonitoring.h.

Referenced by Run().

int fwk::VModule::fInfoLevel = 0
protectedinherited
double RdMonitoring::RdMonitoring::fMaxFrequency
private

Definition at line 75 of file RdMonitoring.h.

Referenced by Init(), and Run().

double RdMonitoring::RdMonitoring::fMinFrequency
private

Definition at line 74 of file RdMonitoring.h.

Referenced by Init(), and Run().

std::string RdMonitoring::RdMonitoring::fOutputFileName
private

Definition at line 76 of file RdMonitoring.h.

Referenced by Init(), and Run().

std::string RdMonitoring::RdMonitoring::fPathToStoreOutput
private

Definition at line 73 of file RdMonitoring.h.

Referenced by Init(), and Run().

int RdMonitoring::RdMonitoring::fPrevGPSSecond
private

Definition at line 69 of file RdMonitoring.h.

Referenced by Run().

double RdMonitoring::RdMonitoring::fSpectrumFractionToSearch
private

Definition at line 81 of file RdMonitoring.h.

Referenced by Init(), and Run().

double RdMonitoring::RdMonitoring::fSpectrumMinPeakSNR
private

Definition at line 80 of file RdMonitoring.h.

Referenced by Init(), and Run().

int RdMonitoring::RdMonitoring::fSpectrumNoiseFilterSize
private

Definition at line 78 of file RdMonitoring.h.

Referenced by Init(), and Run().

int RdMonitoring::RdMonitoring::fSpectrumPeakFilterSize
private

Definition at line 79 of file RdMonitoring.h.

Referenced by Init(), and Run().

int RdMonitoring::RdMonitoring::fTraceNSigmaRMS
private

Definition at line 82 of file RdMonitoring.h.

Referenced by Init(), and Run().


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

, generated on Tue Sep 26 2023.