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

Emulates the second generation of CDAS Ct. Check the overview at Central Trigger Overview. More...

#include "CentralTriggerSimulatorXb/CentralTriggerSimulator.h"

Inheritance diagram for CentralTriggerSimulatorXb::CentralTriggerSimulator:
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 ()
 
fwk::VModule::ResultFlag Run (evt::Event &event)
 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

void ArrayInit ()
 
 REGISTER_MODULE ("CentralTriggerSimulatorXb", CentralTriggerSimulator)
 

Private Attributes

utl::TimeInterval fDefaultOffset
 
utl::TimeInterval fDefaultWindow
 
std::vector< StationfStations
 

Static Private Attributes

static const int fgMaxStations = 2000
 

Detailed Description

Emulates the second generation of CDAS Ct. Check the overview at Central Trigger Overview.

A rumor has it that "Xb" stands for "eXtremely Beautiful".

Notes:

Author
Darko Veberic
Javier Gonzalez
Date
4 May 2006, Xb v3r3
25 Apr 2018, update Xb

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

void CentralTriggerSimulator::ArrayInit ( )
private
VModule::ResultFlag CentralTriggerSimulator::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 246 of file CentralTriggerSimulator.cc.

References io::eSuccess, and CentralTriggerSimulatorXb::MemoryCleanup().

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 CentralTriggerSimulator::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 91 of file CentralTriggerSimulator.cc.

References io::eSuccess, and utl::microsecond.

void fwk::VModule::InitTiming ( )
inlineinherited

Definition at line 95 of file VModule.h.

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

CentralTriggerSimulatorXb::CentralTriggerSimulator::REGISTER_MODULE ( "CentralTriggerSimulatorXb"  ,
CentralTriggerSimulator   
)
private
VModule::ResultFlag CentralTriggerSimulator::Run ( evt::Event event)
virtual

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 CentralTriggerSimulator.cc.

References sevt::T3::AddStation(), t2::energy, io::eSuccess, evt::Event::HasSEvent(), sevt::T3::HasStation(), t2::ID, INFO, utl::Is(), CentralTriggerSimulatorXb::IsSpecialStation(), utl::microsecond, utl::String::Plural(), utl::s, second_, sevt::T3::SetAlgorithm(), sevt::T3::SetTime(), t2::time, TOTVALUE, WARNING, XbAlgoT2Init(), XbAlgoT2Process(), and XbAlgoT3Build().

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

Member Data Documentation

utl::TimeInterval CentralTriggerSimulatorXb::CentralTriggerSimulator::fDefaultOffset
private

Definition at line 56 of file CentralTriggerSimulator.h.

utl::TimeInterval CentralTriggerSimulatorXb::CentralTriggerSimulator::fDefaultWindow
private

Definition at line 57 of file CentralTriggerSimulator.h.

const int CentralTriggerSimulatorXb::CentralTriggerSimulator::fgMaxStations = 2000
staticprivate

Definition at line 62 of file CentralTriggerSimulator.h.

int fwk::VModule::fInfoLevel = 0
protectedinherited
std::vector<Station> CentralTriggerSimulatorXb::CentralTriggerSimulator::fStations
private

Definition at line 59 of file CentralTriggerSimulator.h.


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

, generated on Tue Sep 26 2023.