#include <RdChannelDebugWriter.h>

Inheritance diagram for RdChannelDebugWriter::RdChannelDebugWriter:

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)

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

Protected Attributes
int	fInfoLevel = 0

Private Member Functions
	REGISTER_MODULE ("RdChannelDebugWriter", RdChannelDebugWriter)

void	writeAsciiSpectrum (const revt::REvent &) const
	Writes the spectra to ASCII files. More...

void	writeAsciiTrace (const revt::REvent &) const
	Writes the traces output to ASCII files. More...

void	writeRootOutput (const revt::REvent &) const
	Writes debug output to root file. More...

Private Attributes
std::string	fAsciiSpectrumNameBase
	Beginning of file name for ASCII file output. More...

std::string	fAsciiTraceNameBase
	Beginning of file name for ASCII file output. More...

std::set< int >	fChannelIds
	List of channels which will be considered for output. Empty = all channels. More...

unsigned long int	fEventCounter = 0
	Counts the number of events processed by the module. More...

unsigned int	fEventFraction = 0
	Consider only a fraction of event, if set to a value > 0. More...

unsigned long	fLastEventGPSsecond = 0
	GPS second of the last event. More...

int	fLastEventID = -1
	ID of the last event. More...

std::string	fRootFileNameBase
	Beginning of file name for root file output. More...

std::set< int >	fStationIds
	List of stations which will be considered for output. Empty = all stations. More...

unsigned long int	fStepCounter = 0
	Counts the number of calls of the module for the same event. More...

bool	fUseUnits = false
	Shall the module convert to physical unit. More...

Detailed Description

Definition at line 25 of file RdChannelDebugWriter.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.

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

fwk::VModule::ResultFlag RdChannelDebugWriter::RdChannelDebugWriter::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 30 of file RdChannelDebugWriter.h.

References fwk::VModule::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 RdChannelDebugWriter::RdChannelDebugWriter::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 35 of file RdChannelDebugWriter.cc.

References io::eSuccess, utl::Branch::Get(), utl::Branch::GetChild(), utl::Branch::GetData(), fwk::CentralConfig::GetInstance(), fwk::CentralConfig::GetTopBranch(), INFODebug, and INFOFinal.

void fwk::VModule::InitTiming ( )

inlineinherited

Definition at line 95 of file VModule.h.

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

RdChannelDebugWriter::RdChannelDebugWriter::REGISTER_MODULE	(	"RdChannelDebugWriter"	,
		RdChannelDebugWriter
	)

private

VModule::ResultFlag RdChannelDebugWriter::RdChannelDebugWriter::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 71 of file RdChannelDebugWriter.cc.

References io::eSuccess, utl::TimeStamp::GetGPSSecond(), revt::REvent::GetHeader(), revt::Header::GetId(), revt::Header::GetTime(), evt::Event::HasREvent(), INFOFinal, INFOIntermediate, and WARNING.

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().

void RdChannelDebugWriter::RdChannelDebugWriter::writeAsciiSpectrum ( const revt::REvent & rEvent ) const

private

Writes the spectra to ASCII files.

Definition at line 222 of file RdChannelDebugWriter.cc.

References utl::abs(), utl::deg, filename, utl::megahertz, utl::micro, and galactic::volt.

void RdChannelDebugWriter::RdChannelDebugWriter::writeAsciiTrace ( const revt::REvent & rEvent ) const

private

Writes the traces output to ASCII files.

Definition at line 267 of file RdChannelDebugWriter.cc.

References filename, utl::micro, utl::nanosecond, and galactic::volt.

void RdChannelDebugWriter::RdChannelDebugWriter::writeRootOutput ( const revt::REvent & rEvent ) const

private

Writes debug output to root file.

Definition at line 123 of file RdChannelDebugWriter.cc.

References utl::abs(), utl::deg, max, utl::megahertz, utl::micro, utl::nanosecond, and galactic::volt.

Member Data Documentation

std::string RdChannelDebugWriter::RdChannelDebugWriter::fAsciiSpectrumNameBase

private

Beginning of file name for ASCII file output.

Definition at line 46 of file RdChannelDebugWriter.h.

std::string RdChannelDebugWriter::RdChannelDebugWriter::fAsciiTraceNameBase

private

Beginning of file name for ASCII file output.

Definition at line 49 of file RdChannelDebugWriter.h.

std::set<int> RdChannelDebugWriter::RdChannelDebugWriter::fChannelIds

private

List of channels which will be considered for output. Empty = all channels.

Definition at line 34 of file RdChannelDebugWriter.h.

unsigned long int RdChannelDebugWriter::RdChannelDebugWriter::fEventCounter = 0

private

Counts the number of events processed by the module.

Definition at line 52 of file RdChannelDebugWriter.h.

unsigned int RdChannelDebugWriter::RdChannelDebugWriter::fEventFraction = 0

private

Consider only a fraction of event, if set to a value > 0.

Definition at line 40 of file RdChannelDebugWriter.h.

int fwk::VModule::fInfoLevel = 0

protectedinherited

Definition at line 123 of file VModule.h.

Referenced by RdChannelASCIINoiseImporterRD::RdChannelASCIINoiseImporterRD::Init(), Rd2dLDFFitter::Rd2dLDFFitter::Init(), RdChannelNoiseImporter_AERA::RdChannelNoiseImporter_AERA::Init(), and Rd2dLDFFitter::Rd2dLDFFitter::Run().

unsigned long RdChannelDebugWriter::RdChannelDebugWriter::fLastEventGPSsecond = 0

private

GPS second of the last event.

Definition at line 61 of file RdChannelDebugWriter.h.

int RdChannelDebugWriter::RdChannelDebugWriter::fLastEventID = -1

private

ID of the last event.

Definition at line 58 of file RdChannelDebugWriter.h.

std::string RdChannelDebugWriter::RdChannelDebugWriter::fRootFileNameBase

private

Beginning of file name for root file output.

Definition at line 43 of file RdChannelDebugWriter.h.

std::set<int> RdChannelDebugWriter::RdChannelDebugWriter::fStationIds

private

List of stations which will be considered for output. Empty = all stations.

Definition at line 37 of file RdChannelDebugWriter.h.

unsigned long int RdChannelDebugWriter::RdChannelDebugWriter::fStepCounter = 0

private

Counts the number of calls of the module for the same event.

Definition at line 55 of file RdChannelDebugWriter.h.

bool RdChannelDebugWriter::RdChannelDebugWriter::fUseUnits = false

private

Shall the module convert to physical unit.

Definition at line 64 of file RdChannelDebugWriter.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Member Data Documentation