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

#include <RdStationPositionCorrection/RdStationPositionCorrection.h>

Inheritance diagram for RdStationPositionCorrectionOG::RdStationPositionCorrection:
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 Types

typedef std::map< unsigned int,
utl::TimeInterval
OffsetMap
 
typedef std::map< unsigned int,
utl::TimeStamp
ValidityMap
 

Private Member Functions

 REGISTER_MODULE ("RdStationPositionCorrection", RdStationPositionCorrection)
 

Private Attributes

double fDistanceTolerance = 0
 
OffsetMap fOffsets
 
ValidityMap fValidityTimes
 

Detailed Description

This module tries to correct for time offsets which are a result of a wrong position set in the radio station GPS unit when switched to the position fixed mode of operation. It is based on the SdStationPositionCorrection module written by Darko Veberic.

A text file lists the positions used in the GPS unit, followed by the true positions of the GPS antennas and a timestamp as of which no correction is necessary any more because the true position was then used in the GPS unit.

This module should be included into the module sequence after RdEventInitializer module.

Author
Tim Huege
Date
Aug 2014

Definition at line 32 of file RdStationPositionCorrection.h.

Member Typedef Documentation

Definition at line 40 of file RdStationPositionCorrection.h.

Definition at line 43 of file RdStationPositionCorrection.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

VModule::ResultFlag RdStationPositionCorrectionOG::RdStationPositionCorrection::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 196 of file RdStationPositionCorrection.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 RdStationPositionCorrectionOG::RdStationPositionCorrection::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 66 of file RdStationPositionCorrection.cc.

References ERROR, io::eSuccess, RdStationPositionCorrectionOG::UTM::fEasting, RdStationPositionCorrectionOG::UTM::fHeight, RdStationPositionCorrectionOG::UTM::fNorthing, utl::Branch::Get(), utl::Branch::GetChild(), utl::GetCurrentSystemTime(), utl::ReadStream::GetLines(), utl::UTMPoint::GetPoint(), rdet::Station::GetPosition(), rdet::RDetector::GetStation(), utl::Branch::GetTopBranch(), galactic::meter, and WARNING.

void fwk::VModule::InitTiming ( )
inlineinherited

Definition at line 95 of file VModule.h.

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

RdStationPositionCorrectionOG::RdStationPositionCorrection::REGISTER_MODULE ( "RdStationPositionCorrection"  ,
RdStationPositionCorrection   
)
private
VModule::ResultFlag RdStationPositionCorrectionOG::RdStationPositionCorrection::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 151 of file RdStationPositionCorrection.cc.

References ERROR, io::eSuccess, revt::REvent::GetHeader(), revt::StationRecData::GetParameter(), revt::Header::GetTime(), revt::StationRecData::HasParameter(), evt::Event::HasREvent(), and revt::StationRecData::SetParameter().

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

Member Data Documentation

double RdStationPositionCorrectionOG::RdStationPositionCorrection::fDistanceTolerance = 0
private

Definition at line 46 of file RdStationPositionCorrection.h.

int fwk::VModule::fInfoLevel = 0
protectedinherited
OffsetMap RdStationPositionCorrectionOG::RdStationPositionCorrection::fOffsets
private

Definition at line 41 of file RdStationPositionCorrection.h.

ValidityMap RdStationPositionCorrectionOG::RdStationPositionCorrection::fValidityTimes
private

Definition at line 44 of file RdStationPositionCorrection.h.


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

, generated on Tue Sep 26 2023.