List of all members | Public Types | Public Member Functions | Static Public Member Functions | Private Types | Private Member Functions | Private Attributes
SdInspectorOG::SdInspector Class Reference
Service Modules

Performs output of all non-vector/trace quantities of SD event. More...

#include "SdInspectorOG/SdInspector.h"

Inheritance diagram for SdInspectorOG::SdInspector:
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::Stopwatch & GetStopwatch ()
 
const utl::Stopwatch & GetStopwatch () 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)
 

Private Types

enum  InfoLevel {
  eInfoNone = 0, eInfoEvent, eInfoStation, eInfoPMT,
  eInfoAll = eInfoPMT
}
 

Private Member Functions

 REGISTER_MODULE ("SdInspectorOG", SdInspector)
 

Private Attributes

std::pair< unsigned int,
unsigned int > 		fEventSecondRange { 0, 0 }
 
bool fEventSecondUnbounded = false
 
InfoLevel fInfoLevel = eInfoNone
 
bool fShowSimData = false
 

Detailed Description

Performs output of all non-vector/trace quantities of SD event.

Author
Darko Veberic
Date
30 Sep 2004

Definition at line 20 of file SdInspector.h.

Member Enumeration Documentation

enum SdInspectorOG::SdInspector::InfoLevel
private
Enumerator
eInfoNone 
eInfoEvent 
eInfoStation 
eInfoPMT 
eInfoAll 

Definition at line 28 of file SdInspector.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.

enum fwk::VModule::VersionInfoType
inherited

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

VModule::ResultFlag SdInspector::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 495 of file SdInspector.cc.

References io::eSuccess.

std::string fwk::VModule::GetResultFlagByName ( const ResultFlag  flag)
staticinherited

Definition at line 8 of file VModule.cc.

References fwk::VModule::eBreakLoop, fwk::VModule::eContinueLoop, fwk::VModule::eFailure, and fwk::VModule::eSuccess.

Referenced by fwk::RunController::DoNextInSequence(), fwk::RunController::FinishBranch(), and fwk::RunController::InitBranch().

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

Retrieve different sorts of module version info.

Definition at line 26 of file VModule.cc.

Referenced by fwk::CentralConfig::GetConfig(), ThresholdCalculatorKG::ThresholdCalculator::Init(), fdDoubleBumpFinder::FdDoubleBumpFinder::Init(), LaserGeneratorNA::LaserGenerator::Init(), LaserLightSimulatorNA::LaserLightSimulator::Init(), FdElectronicsSimulatorOG::FdElectronicsSimulator::Init(), TelescopeSimulatorKG::TelescopeSimulator::Init(), TelescopeSimulatorKG2::TelescopeSimulator::Init(), SdSimpleSimKG::SdSimpleSim::Init(), ShowerPhotonGeneratorOG::ShowerPhotonGenerator::Init(), and testRunController::testModuleVersionInfo().

VModule::ResultFlag SdInspector::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 70 of file SdInspector.cc.

References io::eSuccess, and INFO.

void fwk::VModule::InitTiming ( )
inlineinherited

Definition at line 95 of file VModule.h.

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

SdInspectorOG::SdInspector::REGISTER_MODULE ( "SdInspectorOG"  ,
SdInspector   
)
private
VModule::ResultFlag SdInspector::Run ( evt::Event &  event)
overridevirtual

Run: invoked once per event.

This method is for things that should be done once per event {You must override this method in your concrete module}

Implements fwk::VModule.

Definition at line 110 of file SdInspector.cc.

References sdet::PMTConstants::eLowGain, io::eSuccess, sevt::EventTrigger::GetAlgorithm(), sevt::StationTriggerData::GetAlgorithmName(), sevt::PMTRecData::GetAreaOverPeak(), sevt::PMTCalibData::GetBaseline(), sevt::PMTCalibData::GetBaselineRMS(), sevt::StationGPSData::GetCorrectedNanosecond(), sevt::StationGPSData::GetCurrent100(), sevt::StationGPSData::GetCurrent40(), sevt::StationGPSData::GetCurrentST(), sevt::StationCalibData::GetEndSecond(), sevt::StationTriggerData::GetErrorCode(), sevt::PMTCalibData::GetEvolution(), sevt::StationRecData::GetFallTime(), sevt::PMTRecData::GetFallTime(), sevt::StationRecData::GetFallTimeRMS(), sevt::PMTRecData::GetFallTimeRMS(), sevt::PMTCalibData::GetGainRatio(), sevt::PMTRecData::GetGainRatio(), sevt::PMTCalibData::GetGainRatioRMS(), utl::TimeStamp::GetGPSSecond(), sevt::SEvent::GetHeader(), sevt::PMTCalibData::GetHighGainDelay(), sevt::PMTCalibData::GetHighGainDelayChi2(), sevt::PMTCalibData::GetHighGainDelayRMS(), sevt::EventTrigger::GetId(), sevt::Header::GetId(), sevt::StationRecData::GetLDFResidual(), sevt::PMTCalibData::GetMuonBaseHisto(), sevt::StationCalibData::GetMuonChargeHisto(), sevt::PMTCalibData::GetMuonChargeHisto(), sevt::StationRecData::GetMuonComponent(), sevt::PMTCalibData::GetMuonPeakHisto(), sevt::PMTCalibData::GetMuonShapeHisto(), sevt::SEvent::GetNErrorZeroStations(), sevt::StationGPSData::GetNext100(), sevt::StationGPSData::GetNext40(), sevt::StationGPSData::GetNextST(), sevt::EventTrigger::GetNStations(), sevt::StationCalibData::GetNT1(), sevt::StationCalibData::GetNT2(), sevt::StationCalibData::GetNTot(), sevt::StationCalibData::GetNTubesOk(), sevt::SEvent::GetNumberOfStations(), sevt::PMTCalibData::GetNumberTDA(), sevt::StationGPSData::GetOffset(), sevt::StationTriggerData::GetOffsetMicroSecond(), sevt::PMTCalibData::GetOnlineCharge(), sevt::PMTCalibData::GetOnlinePeak(), IndentOut::GetOs(), sevt::StationRecData::GetPeakAmplitude(), sevt::PMTRecData::GetPeakAmplitude(), sevt::StationSimData::GetPlaneFrontTime(), sevt::StationTriggerData::GetPLDTrigger(), sevt::EventTrigger::GetPreviousId(), sevt::StationGPSData::GetPreviousST(), sevt::PMTCalibData::GetRate(), sevt::StationRecData::GetResidual(), sevt::StationRecData::GetRiseTime(), sevt::PMTRecData::GetRiseTime(), sevt::StationRecData::GetRiseTimeRMS(), sevt::PMTRecData::GetRiseTimeRMS(), sevt::EventTrigger::GetSDPAngle(), sevt::StationGPSData::GetSecond(), sevt::EventTrigger::GetSender(), evt::Event::GetSEvent(), sevt::StationRecData::GetShapeParameter(), sevt::StationRecData::GetShapeParameterRMS(), sevt::StationRecData::GetSignalEndSlot(), sevt::StationRecData::GetSignalStartSlot(), sevt::StationRecData::GetSignalStartTime(), utl::Trace< T >::GetSize(), sevt::StationRecData::GetSPDistance(), sevt::StationCalibData::GetStartSecond(), sevt::StationGPSData::GetTick(), sevt::StationGPSData::GetTickFall(), sevt::Header::GetTime(), sevt::EventTrigger::GetTime(), sevt::PMTRecData::GetTotalCharge(), sevt::StationRecData::GetTotalSignal(), sevt::SEvent::GetTrigger(), sevt::PMTRecData::GetVEMCharge(), sevt::PMTRecData::GetVEMPeak(), sevt::PMTRecData::GetVEMTrace(), sevt::StationCalibData::GetVersion(), sevt::StationTriggerData::GetWindowMicroSecond(), evt::Event::HasSEvent(), sevt::SEvent::HasTrigger(), sevt::PMTRecData::HasVEMTrace(), sevt::PMTCalibData::IsTubeOk(), nl, IndentOut::OutputBinary(), sevt::StationSimData::ParticlesBegin(), sevt::StationSimData::ParticlesEnd(), sevt::SEvent::StationsBegin(), sevt::SEvent::StationsEnd(), and tab.

ResultFlag fwk::VModule::RunWithTiming ( evt::Event &  event)
inlineinherited

Definition at line 98 of file VModule.h.

References fwk::VModule::fStopwatch, fwk::VModule::Run(), utl::Stopwatch::Start(), and utl::Stopwatch::Stop().

Referenced by fwk::RunController::DoNextInSequence().

Member Data Documentation

std::pair<unsigned int, unsigned int> SdInspectorOG::SdInspector::fEventSecondRange { 0, 0 }
private

Definition at line 39 of file SdInspector.h.

bool SdInspectorOG::SdInspector::fEventSecondUnbounded = false
private

Definition at line 38 of file SdInspector.h.

InfoLevel SdInspectorOG::SdInspector::fInfoLevel = eInfoNone
private

Definition at line 36 of file SdInspector.h.

bool SdInspectorOG::SdInspector::fShowSimData = false
private

Definition at line 37 of file SdInspector.h.

The documentation for this class was generated from the following files:
, generated on Tue Sep 26 2023.