Class Reference for E1039 Core & Analysis Software
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Fun4AllBase Class Reference

#include </dev/shm/kenichi/update-github-e1039-doc/e1039-core/framework/fun4all/Fun4AllBase.h>

+ Inheritance diagram for Fun4AllBase:
+ Collaboration diagram for Fun4AllBase:

Public Types

enum  enu_Verbosity {
  VERBOSITY_QUIET = 0 , VERBOSITY_SOME = 1 , VERBOSITY_MORE = 2 , VERBOSITY_EVEN_MORE = 3 ,
  VERBOSITY_A_LOT = 4 , VERBOSITY_MAX = INT_MAX - 10
}
 

Public Member Functions

virtual ~Fun4AllBase ()
 
virtual const std::string Name () const
 Returns the name of this module. More...
 
virtual void Name (const std::string &name)
 Sets the name of this module. More...
 
virtual void Print (const std::string &what="ALL") const
 
virtual void Verbosity (const int ival)
 Sets the verbosity of this module (0 by default=quiet). More...
 
virtual void Verbosity (enu_Verbosity ival)
 Sets the verbosity of this module (0 by default=quiet). More...
 
virtual int Verbosity () const
 Gets the verbosity of this module. More...
 

Protected Member Functions

 Fun4AllBase (const std::string &name="NONAME")
 

Protected Attributes

std::string ThisName
 
int verbosity
 The verbosity level. 0 means not verbose at all. More...
 

Detailed Description

Base class for all Fun4All Classes

It implements the Name, the Verbosity and the print method

Definition at line 12 of file Fun4AllBase.h.

Member Enumeration Documentation

◆ enu_Verbosity

enum Fun4AllBase::enu_Verbosity
Enumerator
VERBOSITY_QUIET 

Quiet mode. Only output critical messages. Intended for batch production mode.

VERBOSITY_SOME 

Output some useful messages during manual command line running.

VERBOSITY_MORE 

Output more messages.

VERBOSITY_EVEN_MORE 

Output even more messages.

VERBOSITY_A_LOT 

Output a lot of messages.

VERBOSITY_MAX 

Show all messages. Useful for step-by-step debugging.

Definition at line 33 of file Fun4AllBase.h.

Constructor & Destructor Documentation

◆ ~Fun4AllBase()

Fun4AllBase::~Fun4AllBase ( )
virtual

dtor. Does nothing as this is a base class only.

Definition at line 14 of file Fun4AllBase.cc.

References Name(), verbosity, and VERBOSITY_MORE.

+ Here is the call graph for this function:

◆ Fun4AllBase()

Fun4AllBase::Fun4AllBase ( const std::string &  name = "NONAME")
protected

ctor.

Definition at line 7 of file Fun4AllBase.cc.

Member Function Documentation

◆ Name() [1/2]

virtual const std::string Fun4AllBase::Name ( ) const
inlinevirtual

Returns the name of this module.

Definition at line 23 of file Fun4AllBase.h.

References ThisName.

Referenced by Fun4AllInputManager::AddFile(), Fun4AllSyncManager::BranchSelect(), PHG4BlockCellReco::CheckEnergy(), PHG4CylinderCellReco::CheckEnergy(), Fun4AllHistoManager::dumpHistos(), AnaChamPlane::End(), Fun4AllHitMatrixInputManager::fileclose(), Fun4AllTrackQAv1InputManager::fileclose(), Fun4AllVectEventInputManager::fileclose(), Fun4AllDstInputManager::fileclose(), Fun4AllPrdfInputManager::fileclose(), Fun4AllHepMCInputManager::fileclose(), Fun4AllOscarInputManager::fileclose(), Fun4AllEVIOInputManager::fileclose(), Fun4AllSRawEventInputManager::fileclose(), Fun4AllRUSInputManager::fileclose(), Fun4AllSyncManager::fileclose(), Fun4AllHepMCInputManager::fileopen(), Fun4AllOscarInputManager::fileopen(), Fun4AllSyncManager::fileopen(), Fun4AllSyncManager::getInputManager(), PHG4ConeSubsystem::Init(), PHG4DetectorGroupSubsystem::Init(), PHG4DetectorSubsystem::Init(), E906SpillSelector::Init(), SQGeomAcc::Init(), HepMCNodeReader::Init(), Fun4AllServer::InitAll(), PHG4DetectorGroupSubsystem::InitializeParameters(), PHG4DetectorGroupSubsystem::InitRun(), PHG4DetectorSubsystem::InitRun(), AnaChamPlane::InitRun(), AnaTrack::InitRun(), CalibDriftDistMod::InitRun(), CalibDriftDist::InitRun(), CalibHodoInTime::InitRun(), PHG4BlockCellReco::InitRun(), PHG4CylinderCellReco::InitRun(), SQChamberRealization::InitRun(), SQDigitizer::InitRun(), SQGeomAcc::InitRun(), PHG4ParticleGeneratorD0::InitRun(), PHG4ParticleGeneratorVectorMeson::InitRun(), PHG4SimpleEventGenerator::InitRun(), PHG4BlockSubsystem::InitRunSubsystem(), PHG4BNLTargetCoilSubsystem::InitRunSubsystem(), PHG4CollimatorSubsystem::InitRunSubsystem(), PHG4CylinderSubsystem::InitRunSubsystem(), PHG4EMCalSubsystem::InitRunSubsystem(), PHG4PolyconSubsystem::InitRunSubsystem(), PHG4SquareTubeSubsystem::InitRunSubsystem(), PHG4TargetCoilSubsystem::InitRunSubsystem(), PHG4TargetCoilV2Subsystem::InitRunSubsystem(), SQG4DipoleMagnetSubsystem::InitRunSubsystem(), Fun4AllServer::outfileclose(), PHG4ConeSubsystem::PHG4ConeSubsystem(), PHG4CylinderCellTPCReco::PHG4CylinderCellTPCReco(), PHG4DetectorGroupSubsystem::PHG4DetectorGroupSubsystem(), PHG4DetectorSubsystem::PHG4DetectorSubsystem(), Print(), Fun4AllDstInputManager::Print(), Fun4AllHistoManager::Print(), Fun4AllInputManager::Print(), Fun4AllServer::Print(), Fun4AllSyncManager::Print(), PHG4BNLTargetCoilSubsystem::Print(), PHG4CylinderSubsystem::Print(), PHG4PolyconSubsystem::Print(), PHG4TargetCoilSubsystem::Print(), PHG4TargetCoilV2Subsystem::Print(), Fun4AllServer::process_event(), CalibDriftDist::process_event(), PHG4BlockCellReco::process_event(), PHG4CylinderCellReco::process_event(), SQDigitizer::process_event(), PHG4ParticleGeneratorBase::process_event(), Fun4AllServer::registerHistoManager(), Fun4AllSyncManager::registerInputManager(), Fun4AllServer::registerOutputManager(), Fun4AllInputManager::registerSubsystem(), Fun4AllServer::registerSubsystem(), Fun4AllServer::registerSyncManager(), Fun4AllInputManager::RejectEvent(), Fun4AllSyncManager::ResetEvent(), Fun4AllInputManager::ResetFileList(), Fun4AllHitMatrixInputManager::run(), Fun4AllTrackQAv1InputManager::run(), Fun4AllVectEventInputManager::run(), Fun4AllDstInputManager::run(), Fun4AllPrdfInputManager::run(), Fun4AllHepMCInputManager::run(), Fun4AllHepMCPileupInputManager::run(), Fun4AllOscarInputManager::run(), Fun4AllEVIOInputManager::run(), Fun4AllSRawEventInputManager::run(), Fun4AllRUSInputManager::run(), Fun4AllSyncManager::run(), SQCosmicGen::set_mom_range(), PHG4ParticleGeneratorBase::set_seed(), SQCosmicGen::set_theta_range(), Fun4AllDstInputManager::setBranches(), Fun4AllSyncManager::setBranches(), Fun4AllHitMatrixInputManager::SyncIt(), Fun4AllTrackQAv1InputManager::SyncIt(), Fun4AllVectEventInputManager::SyncIt(), Fun4AllDstInputManager::SyncIt(), Fun4AllPrdfInputManager::SyncIt(), Fun4AllEVIOInputManager::SyncIt(), Fun4AllSRawEventInputManager::SyncIt(), Fun4AllRUSInputManager::SyncIt(), and ~Fun4AllBase().

◆ Name() [2/2]

virtual void Fun4AllBase::Name ( const std::string &  name)
inlinevirtual

Sets the name of this module.

Definition at line 26 of file Fun4AllBase.h.

References ThisName.

◆ Print()

void Fun4AllBase::Print ( const std::string &  what = "ALL") const
virtual

Print out some info about this module.

Parameters
whatcan be used to specify what to print exactly.

Reimplemented in PHG4Reco, PHG4ParticleGeneratorBase, PHG4TargetCoilV2Subsystem, PHG4TargetCoilSubsystem, PHG4PolyconSubsystem, PHG4CylinderSubsystem, PHG4BNLTargetCoilSubsystem, Fun4AllRUSInputManager, Fun4AllSRawEventInputManager, Fun4AllEVIOInputManager, Fun4AllOscarInputManager, Fun4AllHepMCOutputManager, Fun4AllHepMCInputManager, SubsysReco, Fun4AllSyncManager, Fun4AllServer, Fun4AllPrdfInputManager, Fun4AllOutputManager, Fun4AllInputManager, Fun4AllHistoManager, Fun4AllEventOutputManager, Fun4AllDstOutputManager, Fun4AllDstInputManager, Fun4AllVectEventInputManager, Fun4AllTrackQAv1InputManager, and Fun4AllHitMatrixInputManager.

Definition at line 23 of file Fun4AllBase.cc.

References Name().

+ Here is the call graph for this function:

◆ Verbosity() [1/3]

virtual int Fun4AllBase::Verbosity ( ) const
inlinevirtual

Gets the verbosity of this module.

Definition at line 64 of file Fun4AllBase.h.

References verbosity.

Referenced by Fun4AllSRawEventOutputManagerV2::CloseFile(), Fun4AllSpillSRawEventOutputManager::CloseFile(), Fun4AllSRawEventOutputManager::CloseFile(), AnaSimRunInfo::End(), AnaTrkQA::End(), AnaPileup::End(), TruthEval::End(), RndmEmbed::End(), SRawEventEmbed::End(), SQReco::End(), PatternDBGen::End(), SRMakeRTCurve::ExtractRT(), Fun4AllEVIOInputManager::fileopen(), SQReco::fitTrackCand(), SQChamberRealization::FixChamReso(), Fun4AllHistoManager::getHisto(), SQReco::GetNodes(), E906SpillSelector::Init(), SQDigitizer::Init(), SQReco::InitFastTracking(), SQReco::InitField(), PHG4Reco::InitField(), SQReco::InitGeom(), PHG4DetectorGroupSubsystem::InitRun(), PHG4DetectorSubsystem::InitRun(), CalibDriftDistMod::InitRun(), CalibDriftDist::InitRun(), CalibHodoInTime::InitRun(), SQDigitizer::InitRun(), PHG4EMCalSubsystem::InitRunSubsystem(), SQReco::MakeNodes(), DoEmbedding::OpenEmbDataFile(), Fun4AllSRawEventOutputManagerV2::OpenFile(), Fun4AllSpillSRawEventOutputManager::OpenFile(), Fun4AllSRawEventOutputManager::OpenFile(), PHG4TruthSubsystem::process_after_geant(), PHG4DSTReader::process_event(), PHG4Reco::process_event(), CalibHitPos::process_event(), CheckEventData::process_event(), AnaSimRunInfo::process_event(), AnaTrack::process_event(), DoEmbedding::process_event(), TruthEval::process_event(), SQSingleMuonGen::process_event(), CalibDriftDist::process_event(), CalibHitElementPos::process_event(), CalibHodoInTime::process_event(), RndmEmbed::process_event(), SRawEventEmbed::process_event(), EvtFilter::process_event(), SQReco::process_event(), SQTrackletReco::process_event(), SQVertexing::process_event(), VertexFit::process_event(), SQChamberRealization::process_event(), SQDigitizer::process_event(), HepMCNodeReader::process_event(), SQCosmicGen::process_event(), SQReco::ProcessEventPrep(), Fun4AllHepMCPileupInputManager::run(), SQChamberRealization::ScaleChamReso(), SQCosmicGen::set_mom_range(), SQCosmicGen::set_theta_range(), SQChamberRealization::SetChamEff(), SQChamberRealization::SetPropTubeEff(), VertexFit::setRecEvent(), and SQDigitizer::SQDigitizer().

◆ Verbosity() [2/3]

virtual void Fun4AllBase::Verbosity ( const int  ival)
inlinevirtual

Sets the verbosity of this module (0 by default=quiet).

Definition at line 58 of file Fun4AllBase.h.

References verbosity.

◆ Verbosity() [3/3]

virtual void Fun4AllBase::Verbosity ( enu_Verbosity  ival)
inlinevirtual

Sets the verbosity of this module (0 by default=quiet).

Definition at line 61 of file Fun4AllBase.h.

References verbosity.

Member Data Documentation

◆ ThisName

std::string Fun4AllBase::ThisName
protected

Definition at line 72 of file Fun4AllBase.h.

Referenced by Fun4AllHitMatrixInputManager::fileopen(), Fun4AllTrackQAv1InputManager::fileopen(), Fun4AllDstInputManager::fileopen(), Fun4AllPrdfInputManager::fileopen(), Fun4AllHepMCInputManager::fileopen(), Fun4AllOscarInputManager::fileopen(), Fun4AllEVIOInputManager::fileopen(), Fun4AllSRawEventInputManager::fileopen(), Fun4AllVectEventInputManager::fileopen(), Fun4AllRUSInputManager::fileopen(), Fun4AllServer::identify(), Name(), Fun4AllNoSyncDstInputManager::NoRunTTree(), Fun4AllDstOutputManager::Print(), Fun4AllEventOutputManager::Print(), Fun4AllOutputManager::Print(), Fun4AllHepMCOutputManager::Print(), Fun4AllDstInputManager::PushBackEvents(), Fun4AllPrdfInputManager::PushBackEvents(), Fun4AllHepMCInputManager::PushBackEvents(), Fun4AllDstInputManager::ReadNextEventSyncObject(), Fun4AllPrdfInputManager::run(), Fun4AllEVIOInputManager::run(), Fun4AllSyncManager::run(), Fun4AllDstInputManager::SyncIt(), Fun4AllDstOutputManager::Write(), Fun4AllFileOutStream::WriteEventOut(), and Fun4AllRolloverFileOutStream::WriteEventOut().

◆ verbosity

int Fun4AllBase::verbosity
protected

The verbosity level. 0 means not verbose at all.

Definition at line 75 of file Fun4AllBase.h.

Referenced by Fun4AllInputManager::AddFile(), Fun4AllInputManager::AddListFile(), Fun4AllServer::BeginRun(), Fun4AllDstInputManager::BranchSelect(), PHG4BlockCellReco::CheckEnergy(), PHG4CylinderCellReco::CheckEnergy(), Fun4AllHepMCInputManager::ConvertFromOscar(), Fun4AllOscarInputManager::ConvertFromOscar(), Fun4AllServer::CountOutNodesRecursive(), PHG4Reco::DefineMaterials(), Fun4AllHistoManager::dumpHistos(), Fun4AllServer::End(), Fun4AllServer::EndRun(), Fun4AllHitMatrixInputManager::fileopen(), Fun4AllTrackQAv1InputManager::fileopen(), Fun4AllDstInputManager::fileopen(), Fun4AllPrdfInputManager::fileopen(), Fun4AllHepMCInputManager::fileopen(), Fun4AllOscarInputManager::fileopen(), Fun4AllEVIOInputManager::fileopen(), Fun4AllSRawEventInputManager::fileopen(), Fun4AllVectEventInputManager::fileopen(), Fun4AllRUSInputManager::fileopen(), Fun4AllServer::getHistoManager(), Fun4AllHistoManager::getHistoName(), Fun4AllServer::getOutputManager(), Fun4AllServer::getSubsysReco(), PHG4Reco::getSubsystem(), PHG4Reco::Init(), PHG4CylinderCellTPCReco::Init(), PHG4Reco::InitField(), VertexFit::InitRun(), PHG4BlockCellReco::InitRun(), PHG4CylinderCellReco::InitRun(), PHG4PSScanGenerator::InitRun(), PHG4Reco::InitRun(), PHG4SimpleEventGenerator::InitRun(), Fun4AllHitMatrixInputManager::OpenNextFile(), Fun4AllTrackQAv1InputManager::OpenNextFile(), Fun4AllVectEventInputManager::OpenNextFile(), Fun4AllDstInputManager::OpenNextFile(), Fun4AllPrdfInputManager::OpenNextFile(), Fun4AllHepMCInputManager::OpenNextFile(), Fun4AllOscarInputManager::OpenNextFile(), Fun4AllEVIOInputManager::OpenNextFile(), Fun4AllSRawEventInputManager::OpenNextFile(), Fun4AllRUSInputManager::OpenNextFile(), Fun4AllServer::outfileclose(), Fun4AllPrdfOutputManager::outfileopen(), PHG4CylinderCellTPCReco::populate_zbins(), PHG4CylinderCellTPCReco::populate_zigzag_phibins(), Fun4AllServer::process_event(), TruthEval::process_event(), PHHepMCParticleSelectorDecayProductChain::process_event(), VertexFit::process_event(), PHG4BlockCellReco::process_event(), PHG4CylinderCellReco::process_event(), PHG4CylinderCellTPCReco::process_event(), PHG4GenHit::process_event(), HepMCNodeReader::process_event(), PHG4HeadReco::process_event(), PHG4InputFilter::process_event(), PHG4ParticleGenerator::process_event(), PHG4ParticleGeneratorD0::process_event(), PHG4ParticleGeneratorVectorMeson::process_event(), PHG4ParticleGun::process_event(), PHG4PSScanGenerator::process_event(), PHG4SimpleEventGenerator::process_event(), Fun4AllPrdfInputManager::PushBackEvents(), Fun4AllHepMCInputManager::PushBackEvents(), Fun4AllDstInputManager::ReadNextEventSyncObject(), Fun4AllHistoManager::registerHisto(), Fun4AllServer::registerHistoManager(), Fun4AllSyncManager::registerInputManager(), Fun4AllServer::registerOutputManager(), Fun4AllInputManager::registerSubsystem(), Fun4AllServer::registerSubsystem(), Fun4AllServer::registerSyncManager(), Fun4AllInputManager::RejectEvent(), Fun4AllServer::Reset(), Fun4AllSyncManager::ResetEvent(), Fun4AllServer::ResetNodeTree(), PHG4ParticleGeneratorBase::ReuseExistingVertex(), Fun4AllHitMatrixInputManager::run(), Fun4AllTrackQAv1InputManager::run(), Fun4AllVectEventInputManager::run(), Fun4AllDstInputManager::run(), Fun4AllPrdfInputManager::run(), Fun4AllHepMCInputManager::run(), Fun4AllHepMCPileupInputManager::run(), Fun4AllOscarInputManager::run(), Fun4AllEVIOInputManager::run(), Fun4AllSRawEventInputManager::run(), Fun4AllRUSInputManager::run(), Fun4AllSyncManager::run(), Fun4AllServer::run(), Fun4AllDummyInputManager::run(), PHG4Reco::set_field_map(), Fun4AllDstInputManager::setBranches(), Fun4AllDstInputManager::SyncIt(), Fun4AllServer::unregisterSubsystemsNow(), Fun4AllServer::UpdateEventSelector(), Verbosity(), Fun4AllDstOutputManager::Write(), Fun4AllEventOutStream::WriteEvent(), Fun4AllRolloverFileOutStream::WriteEventOut(), ~Fun4AllBase(), Fun4AllInputManager::~Fun4AllInputManager(), Fun4AllServer::~Fun4AllServer(), and Fun4AllSyncManager::~Fun4AllSyncManager().

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