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

#include <FindTimeOffset.h>

Inheritance diagram for FindTimeOffset::FindTimeOffset:
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

 FindTimeOffset ()=default
 
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)
 
virtual ~FindTimeOffset ()=default
 

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

void ExamineFEvent (const evt::Event &event, const bool isCeleste)
 
void FindOffset (const sevt::SEvent &sEvent, const fevt::Eye &eye, const bool isCeleste)
 
 REGISTER_MODULE ("FindTimeOffset", FindTimeOffset)
 

Detailed Description

Definition at line 37 of file FindTimeOffset.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

FindTimeOffset::FindTimeOffset::FindTimeOffset ( )
default
virtual FindTimeOffset::FindTimeOffset::~FindTimeOffset ( )
virtualdefault

Member Function Documentation

void FindTimeOffset::FindTimeOffset::ExamineFEvent ( const evt::Event event,
const bool  isCeleste 
)
private

Definition at line 88 of file FindTimeOffset.cc.

References fevt::ComponentSelector::eHasData, and FindOffset().

Referenced by Run().

void FindTimeOffset::FindTimeOffset::FindOffset ( const sevt::SEvent sEvent,
const fevt::Eye eye,
const bool  isCeleste 
)
private
fwk::VModule::ResultFlag FindTimeOffset::FindTimeOffset::Finish ( )
inlineoverridevirtual

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 45 of file FindTimeOffset.h.

References fwk::VModule::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
fwk::VModule::ResultFlag FindTimeOffset::FindTimeOffset::Init ( )
inlineoverridevirtual

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 43 of file FindTimeOffset.h.

References fwk::VModule::eSuccess.

void fwk::VModule::InitTiming ( )
inlineinherited

Definition at line 95 of file VModule.h.

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

FindTimeOffset::FindTimeOffset::REGISTER_MODULE ( "FindTimeOffset"  ,
FindTimeOffset   
)
private
fwk::VModule::ResultFlag FindTimeOffset::FindTimeOffset::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 45 of file FindTimeOffset.cc.

References fwk::VModule::eContinueLoop, fwk::VModule::eSuccess, ExamineFEvent(), evt::Event::HasFEvent(), evt::Event::HasSEvent(), and INFO.

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

Member Data Documentation

int fwk::VModule::fInfoLevel = 0
protectedinherited

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

, generated on Tue Sep 26 2023.