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

#include <RdChannelNoiseASCIIImporter.h>

Inheritance diagram for RdChannelNoiseASCIIImporter::RdChannelNoiseASCIIImporter:
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 ()
 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 ()
 Initialize: invoked at beginning of run (NOT beginning of event) More...
 
void InitTiming ()
 
 RdChannelNoiseASCIIImporter ()
 
fwk::VModule::ResultFlag Run (evt::Event &event)
 Run: invoked once per event. More...
 
ResultFlag RunWithTiming (evt::Event &event)
 
virtual ~RdChannelNoiseASCIIImporter ()
 

Static Public Member Functions

static std::string GetResultFlagByName (const ResultFlag flag)
 

Private Types

enum  InfoLevel {
  eNone = 0, eFinal = 1, eIntermediate = 2, eObscure = 3,
  eDebug = 4
}
 

Private Member Functions

std::string AddZero (int val)
 
std::string GetStringFromStatChan (int statid, int chanid)
 
 REGISTER_MODULE ("RdChannelNoiseASCIIImporter", RdChannelNoiseASCIIImporter)
 
void RemovePedestal (revt::ChannelTimeSeries &timeSeries)
 
void RemovePedestal (std::vector< int > &timeSeries)
 

Private Attributes

int fInfoLevel
 
int fNumberOfFiles
 Writes out a spectrum in an ASCII file. More...
 
std::string fPathToAsciitrace
 
bool fStopAtLastNoiseTrace
 
bool fUseAlwaysTheSameTrace
 
bool fUseRandomSeed
 
std::vector< int > v_id
 
std::vector< int >::iterator viter
 

Detailed Description

Definition at line 32 of file RdChannelNoiseASCIIImporter.h.

Member Enumeration Documentation

enum RdChannelNoiseASCIIImporter::RdChannelNoiseASCIIImporter::InfoLevel
private
Enumerator
eNone 
eFinal 
eIntermediate 
eObscure 
eDebug 

Definition at line 46 of file RdChannelNoiseASCIIImporter.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

RdChannelNoiseASCIIImporter::RdChannelNoiseASCIIImporter::RdChannelNoiseASCIIImporter ( )

Definition at line 43 of file RdChannelNoiseASCIIImporter.cc.

RdChannelNoiseASCIIImporter::RdChannelNoiseASCIIImporter::~RdChannelNoiseASCIIImporter ( )
virtual

Definition at line 53 of file RdChannelNoiseASCIIImporter.cc.

Member Function Documentation

std::string RdChannelNoiseASCIIImporter::RdChannelNoiseASCIIImporter::AddZero ( int  val)
inlineprivate

Definition at line 63 of file RdChannelNoiseASCIIImporter.h.

Referenced by Run().

VModule::ResultFlag RdChannelNoiseASCIIImporter::RdChannelNoiseASCIIImporter::Finish ( )
virtual

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 255 of file RdChannelNoiseASCIIImporter.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.

string RdChannelNoiseASCIIImporter::RdChannelNoiseASCIIImporter::GetStringFromStatChan ( int  statid,
int  chanid 
)
private

Definition at line 265 of file RdChannelNoiseASCIIImporter.cc.

Referenced by Run().

std::string fwk::VModule::GetVersionInfo ( const VersionInfoType  v) const
inherited
VModule::ResultFlag RdChannelNoiseASCIIImporter::RdChannelNoiseASCIIImporter::Init ( )
virtual

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 57 of file RdChannelNoiseASCIIImporter.cc.

References fwk::VModule::eSuccess, fInfoLevel, fNumberOfFiles, fPathToAsciitrace, fStopAtLastNoiseTrace, fUseAlwaysTheSameTrace, fUseRandomSeed, utl::Branch::GetChild(), utl::Branch::GetData(), utl::Branch::GetTopBranch(), INFO, v_id, and viter.

void fwk::VModule::InitTiming ( )
inlineinherited

Definition at line 95 of file VModule.h.

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

RdChannelNoiseASCIIImporter::RdChannelNoiseASCIIImporter::REGISTER_MODULE ( "RdChannelNoiseASCIIImporter"  ,
RdChannelNoiseASCIIImporter   
)
private
void RdChannelNoiseASCIIImporter::RdChannelNoiseASCIIImporter::RemovePedestal ( revt::ChannelTimeSeries timeSeries)
private
void RdChannelNoiseASCIIImporter::RdChannelNoiseASCIIImporter::RemovePedestal ( std::vector< int > &  timeSeries)
private

Definition at line 281 of file RdChannelNoiseASCIIImporter.cc.

VModule::ResultFlag RdChannelNoiseASCIIImporter::RdChannelNoiseASCIIImporter::Run ( evt::Event event)
virtual
ResultFlag fwk::VModule::RunWithTiming ( evt::Event event)
inlineinherited

Member Data Documentation

int RdChannelNoiseASCIIImporter::RdChannelNoiseASCIIImporter::fInfoLevel
private

Definition at line 56 of file RdChannelNoiseASCIIImporter.h.

Referenced by Init(), and Run().

int RdChannelNoiseASCIIImporter::RdChannelNoiseASCIIImporter::fNumberOfFiles
private

Writes out a spectrum in an ASCII file.

Definition at line 55 of file RdChannelNoiseASCIIImporter.h.

Referenced by Init().

std::string RdChannelNoiseASCIIImporter::RdChannelNoiseASCIIImporter::fPathToAsciitrace
private

Definition at line 57 of file RdChannelNoiseASCIIImporter.h.

Referenced by Init(), and Run().

bool RdChannelNoiseASCIIImporter::RdChannelNoiseASCIIImporter::fStopAtLastNoiseTrace
private

Definition at line 60 of file RdChannelNoiseASCIIImporter.h.

Referenced by Init(), and Run().

bool RdChannelNoiseASCIIImporter::RdChannelNoiseASCIIImporter::fUseAlwaysTheSameTrace
private

Definition at line 58 of file RdChannelNoiseASCIIImporter.h.

Referenced by Init(), and Run().

bool RdChannelNoiseASCIIImporter::RdChannelNoiseASCIIImporter::fUseRandomSeed
private

Definition at line 59 of file RdChannelNoiseASCIIImporter.h.

Referenced by Init().

std::vector<int> RdChannelNoiseASCIIImporter::RdChannelNoiseASCIIImporter::v_id
private

Definition at line 61 of file RdChannelNoiseASCIIImporter.h.

Referenced by Init(), and Run().

std::vector<int>::iterator RdChannelNoiseASCIIImporter::RdChannelNoiseASCIIImporter::viter
private

Definition at line 62 of file RdChannelNoiseASCIIImporter.h.

Referenced by Init(), and Run().


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

, generated on Tue Sep 26 2023.