slic::LcioFileNamer Class Reference

#include <LcioFileNamer.hh>

Inheritance diagram for slic::LcioFileNamer:

Inheritance graph
slic::Module
[legend]
Collaboration diagram for slic::LcioFileNamer:

Collaboration graph
slic::Moduleslic::LogStreamslic::LogMessenger
[legend]

List of all members.


Detailed Description

Automatically name LCIO output files according to input settings.

Definition at line 23 of file LcioFileNamer.hh.


Public Types

enum  ModuleStatus { eOkay = 0, eNotInitialized = 1, eBadState = 2, eFatalError = 3 }

Public Member Functions

 LcioFileNamer ()
virtual ~LcioFileNamer ()
std::string makeFileName (std::vector< std::string >)
const std::string & getName () const
const ModuleStatus getStatus () const
virtual void initialize ()
virtual void reset ()
virtual void cleanup ()
bool deleteOnExit ()
LogStreamlog ()
virtual void beginEvent (const G4Event *)
virtual void endEvent (const G4Event *)
virtual void beginRun (const G4Run *)
virtual void endRun (const G4Run *)
virtual void preTracking (const G4Track *)
virtual void postTracking (const G4Track *)
virtual void stepping (const G4Step *)
G4ClassificationOfNewTrack stackingClassifyNewTrack (const G4Track *)
void stackingNewStage ()
void stackingPrepareNewEvent ()

Public Attributes

ModuleStatus m_status
std::string m_name
LogStream m_log
bool m_deleteOnExit

Private Member Functions

std::string getFieldValue (std::string)
std::string makeDefaultFileName ()

Static Private Member Functions

static std::string makeEventName ()
static std::string makeFileBasedName ()
static std::string makeGPSName ()
static std::string makeGunName ()
static std::string makeRunNumberString ()
static std::string makeEventNumberString ()
static std::string getGeant4VersionString ()

Private Attributes

std::vector< std::string > m_defaultFields

Static Private Attributes

static std::string m_sep = "_"

Member Enumeration Documentation

enum slic::Module::ModuleStatus [inherited]

Enumerator:
eOkay 
eNotInitialized 
eBadState 
eFatalError 

Definition at line 29 of file Module.hh.


Constructor & Destructor Documentation

slic::LcioFileNamer::LcioFileNamer (  ) 

Definition at line 31 of file LcioFileNamer.cc.

References m_defaultFields.

virtual slic::LcioFileNamer::~LcioFileNamer (  )  [inline, virtual]

Definition at line 27 of file LcioFileNamer.hh.


Member Function Documentation

std::string slic::LcioFileNamer::makeFileName ( std::vector< std::string >  fieldList  ) 

Definition at line 82 of file LcioFileNamer.cc.

References getFieldValue(), m_sep, and makeDefaultFileName().

Referenced by slic::LcioManager::makeAutoname(), and makeDefaultFileName().

std::string slic::LcioFileNamer::getFieldValue ( std::string  field  )  [private]

Definition at line 41 of file LcioFileNamer.cc.

References LOG::done, LOG::error, slic::PackageInfo::getAbbrevString(), TimeUtil::getDate(), slic::PackageInfo::getVersionString(), Singleton< T >::instance(), slic::Module::log(), makeEventName(), makeEventNumberString(), and makeRunNumberString().

Referenced by makeFileName().

std::string slic::LcioFileNamer::makeDefaultFileName (  )  [private]

Definition at line 104 of file LcioFileNamer.cc.

References m_defaultFields, and makeFileName().

Referenced by makeFileName().

std::string slic::LcioFileNamer::makeEventName (  )  [static, private]

Definition at line 109 of file LcioFileNamer.cc.

References slic::EventSourceManager::eGPS, slic::EventSourceManager::eParticleGun, Singleton< T >::instance(), makeFileBasedName(), makeGPSName(), and makeGunName().

Referenced by getFieldValue().

std::string slic::LcioFileNamer::makeFileBasedName (  )  [static, private]

Definition at line 130 of file LcioFileNamer.cc.

References slic::FileUtil::basename(), Singleton< T >::instance(), and slic::FileUtil::removeExtension().

Referenced by makeEventName().

std::string slic::LcioFileNamer::makeGPSName (  )  [static, private]

Definition at line 140 of file LcioFileNamer.cc.

References Singleton< T >::instance(), and m_sep.

Referenced by makeEventName().

std::string slic::LcioFileNamer::makeGunName (  )  [static, private]

Definition at line 157 of file LcioFileNamer.cc.

References Singleton< T >::instance(), and m_sep.

Referenced by makeEventName().

std::string slic::LcioFileNamer::makeRunNumberString (  )  [static, private]

Definition at line 173 of file LcioFileNamer.cc.

Referenced by getFieldValue().

std::string slic::LcioFileNamer::makeEventNumberString (  )  [static, private]

Definition at line 178 of file LcioFileNamer.cc.

References Singleton< T >::instance().

Referenced by getFieldValue().

static std::string slic::LcioFileNamer::getGeant4VersionString (  )  [static, private]

const std::string& slic::Module::getName (  )  const [inline, inherited]

Definition at line 48 of file Module.hh.

References slic::Module::m_name.

Referenced by slic::ModuleRegistry::deregisterModule(), slic::Module::Module(), slic::ModuleRegistry::registerModule(), and slic::Module::~Module().

const ModuleStatus slic::Module::getStatus (  )  const [inline, inherited]

Definition at line 52 of file Module.hh.

References slic::Module::m_status.

virtual void slic::Module::initialize (  )  [inline, virtual, inherited]

Reimplemented in slic::SlicApplication.

Definition at line 56 of file Module.hh.

virtual void slic::Module::reset (  )  [inline, virtual, inherited]

Reimplemented in slic::EventSource, slic::EventSourceWithInputFile, slic::LcioManager, and slic::LcioMcpManager.

Definition at line 59 of file Module.hh.

virtual void slic::Module::cleanup ( void   )  [inline, virtual, inherited]

Definition at line 62 of file Module.hh.

bool slic::Module::deleteOnExit (  )  [inline, inherited]

Definition at line 65 of file Module.hh.

References slic::Module::m_deleteOnExit.

LogStream& slic::Module::log (  )  [inline, inherited]

Definition at line 70 of file Module.hh.

References slic::Module::m_log.

Referenced by slic::PhysicsListFactory::addBuilder(), slic::EventDebugger::addDebugEvent(), slic::LcioHitsCollectionBuilder::addMcpContribs(), slic::StdHepToLcioConvertor::addMcpDaughter(), slic::StdHepToLcioConvertor::addMcpParent(), slic::TrajectoryManager::addTrackIDToTrajectoryLink(), slic::EventAction::BeginOfEventAction(), slic::EventSourceWithInputFile::beginRun(), slic::StdHepToLcioConvertor::checkParentage(), slic::LcioMcpPrinter::colLabels(), slic::TrajectoryManager::copySecondaryTrackInformationFromParent(), slic::PhysicsListFactory::create(), slic::LcioMcpFactory::createDaughtersFromPrimary(), slic::EventSourceManager::createEventSource(), slic::LcioHitsCollectionBuilder::createHit(), slic::LcioHitsCollectionBuilder::createHitCollections(), slic::LcioMcpManager::createMcpCollection(), slic::LcioMcpFactory::createMcpFromInitialAndPrimary(), slic::StdHepToLcioConvertor::createMcpFromStdHep(), slic::StdHepLoader::dumpCurrentEvent(), slic::StdHepEventSource::dumpCurrentEvent(), slic::ParticleGunEventSource::dumpCurrentEvent(), slic::LcioEventSource::dumpCurrentEvent(), slic::GPSEventSource::dumpCurrentEvent(), slic::EventDebugger::execCleanupMacro(), slic::EventDebugger::execDebugMacro(), slic::StdHepToLcioConvertor::fillCurrentMcpCollectionFromStdHep(), slic::TrajectoryManager::fillTrackIDToTrajectoryMap(), slic::LcioMcpFilter::filterSimParticles(), slic::LcioHitsCollectionBuilder::findMcpHitContribByTrackID(), slic::TrajectoryManager::findTrajectory(), slic::LcioMcpPrinter::flagLabels(), slic::LcioMcpPrinter::foot(), slic::G4MagIntegratorStepperFactory::G4MagIntegratorStepperFactory(), slic::EventSourceManager::generate(), slic::LcioEventSource::getCurrentMcpLCCollection(), getFieldValue(), slic::TrajectoryManager::getNumberOfSecondariesAtEnd(), slic::EventSourceManager::getSourceTypeFromFileExtension(), slic::TrajectoryManager::handleSecondaryTrack(), slic::LcioMcpPrinter::head(), slic::SlicApplication::initialize(), slic::PhysicsListManager::initializePhysicsList(), slic::SlicApplication::initializeUI(), slic::LcioMcpPrinter::line(), slic::SlicMain::main(), slic::LcioManager::makeAutoname(), slic::StdHepToLcioConvertor::makeIndexVec(), slic::Module::Module(), slic::LcioEventSource::open(), slic::LcioManager::openLcioFile(), slic::StdHepLoader::openStdHepFile(), slic::TrajectoryManager::postTracking(), slic::TrajectoryManager::preTracking(), slic::ModuleRegistry::print(), slic::PhysicsListFactory::printAvailableLists(), slic::PrimaryGeneratorAction::printBeginEventMessage(), slic::RunAction::printBeginOfRunMessage(), slic::StdHepToLcioConvertor::printDaughters(), slic::EventAction::printEndEventMessage(), slic::RunAction::printEndOfRunMessage(), slic::StdHepToLcioConvertor::printIndex(), slic::LcioMcpMaps::printInitMcpToMcpMap(), slic::LcioMcpMaps::printMaps(), slic::LcioMcpPrinter::printMcp(), slic::LcioMcpPrinter::printMcpCollection(), slic::LcioMcpManager::printMcpCollection(), slic::LcioMcpMaps::printMcpToPrimaryMap(), slic::StdHepToLcioConvertor::printMothers(), slic::EventSourceManager::printNumEventsGenerated(), slic::CommandLineProcessor::printOptions(), slic::CommandQueue::printOut(), slic::TrajectoryManager::printPhysVolDbg(), slic::TrajectoryManager::printSecondaries(), slic::SlicApplication::printSplashScreen(), slic::TrajectoryManager::printStatusFlags(), slic::TrajectoryManager::printTrack(), slic::StdHepToLcioConvertor::printTrack(), slic::TrajectoryManager::printTrackIDToTrajectoryMap(), slic::LcioMcpMaps::printTrackToMcpMap(), slic::TrajectoryManager::printTrajectory(), slic::CommandLineProcessor::printUsage(), slic::CommandLineProcessor::printVersion(), slic::CommandLineProcessor::process(), slic::StdHepLoader::readNextEvent(), slic::LcioMcpManager::registerMcpCollection(), slic::ModuleRegistry::registerModule(), slic::SlicApplication::run(), slic::LcioMcpPrinter::sep(), slic::PhysicsListManager::setCurrentListName(), slic::LcioManager::setDetectorName(), slic::LcioManager::setFileExistsAction(), slic::EventSourceWithInputFile::setFilename(), slic::LcioHitsCollectionBuilder::setLongFlag(), slic::SlicApplicationMessenger::SetNewValue(), slic::PhysicsMessenger::SetNewValue(), slic::GeneratorMessenger::SetNewValue(), slic::FieldMessenger::SetNewValue(), slic::LcioHitsCollectionBuilder::setPDGFlag(), slic::LcioManager::setRunNumber(), slic::TrajectoryManager::setTrajectoryFinalStatus(), slic::StdHepToLcioConvertor::setupDaughters(), slic::EventSourceManager::setupEventSource(), slic::PhysicsListManager::setupOpticalProcesses(), slic::StdHepToLcioConvertor::setupParents(), slic::PhysicsListManager::setupUserLimitsProcesses(), slic::SlicApplication::SlicApplication(), slic::EventAction::startEventTimer(), slic::RunAction::startRunTimer(), slic::EventAction::stopEventTimer(), slic::RunAction::stopRunTimer(), slic::Module::~Module(), and slic::SlicApplication::~SlicApplication().

virtual void slic::Module::beginEvent ( const G4Event *   )  [inline, virtual, inherited]

Reimplemented in slic::EventDebugger, slic::EventSource, slic::EventSourceManager, slic::EventSourceWithInputFile, slic::LcioEventSource, slic::LcioMcpManager, slic::StdHepEventSource, and slic::TrajectoryManager.

Definition at line 75 of file Module.hh.

virtual void slic::Module::endEvent ( const G4Event *   )  [inline, virtual, inherited]

Reimplemented in slic::EventDebugger, slic::EventSource, slic::EventSourceManager, slic::LcioManager, and slic::LcioMcpManager.

Definition at line 78 of file Module.hh.

virtual void slic::Module::beginRun ( const G4Run *   )  [inline, virtual, inherited]

Reimplemented in slic::EventDebugger, slic::EventSource, slic::EventSourceManager, slic::EventSourceWithInputFile, slic::LcioEventSource, slic::LcioManager, and slic::StdHepEventSource.

Definition at line 81 of file Module.hh.

virtual void slic::Module::endRun ( const G4Run *   )  [inline, virtual, inherited]

Reimplemented in slic::EventSource, slic::EventSourceManager, and slic::LcioManager.

Definition at line 84 of file Module.hh.

virtual void slic::Module::preTracking ( const G4Track *   )  [inline, virtual, inherited]

Reimplemented in slic::TrajectoryManager.

Definition at line 87 of file Module.hh.

virtual void slic::Module::postTracking ( const G4Track *   )  [inline, virtual, inherited]

Reimplemented in slic::TrajectoryManager.

Definition at line 90 of file Module.hh.

virtual void slic::Module::stepping ( const G4Step *   )  [inline, virtual, inherited]

Reimplemented in slic::TrajectoryManager.

Definition at line 93 of file Module.hh.

G4ClassificationOfNewTrack slic::Module::stackingClassifyNewTrack ( const G4Track *   )  [inline, inherited]

Definition at line 96 of file Module.hh.

void slic::Module::stackingNewStage (  )  [inline, inherited]

Definition at line 103 of file Module.hh.

void slic::Module::stackingPrepareNewEvent (  )  [inline, inherited]

Definition at line 106 of file Module.hh.


Member Data Documentation

std::string slic::LcioFileNamer::m_sep = "_" [static, private]

Definition at line 51 of file LcioFileNamer.hh.

Referenced by makeFileName(), makeGPSName(), and makeGunName().

std::vector<std::string> slic::LcioFileNamer::m_defaultFields [private]

Definition at line 52 of file LcioFileNamer.hh.

Referenced by LcioFileNamer(), and makeDefaultFileName().

ModuleStatus slic::Module::m_status [inherited]

Definition at line 110 of file Module.hh.

Referenced by slic::Module::getStatus().

std::string slic::Module::m_name [inherited]

Reimplemented in slic::EventSource.

Definition at line 111 of file Module.hh.

Referenced by slic::Module::getName(), and slic::Module::Module().

LogStream slic::Module::m_log [inherited]

Definition at line 112 of file Module.hh.

Referenced by slic::Module::log(), and slic::Module::Module().

bool slic::Module::m_deleteOnExit [inherited]

Definition at line 113 of file Module.hh.

Referenced by slic::Module::deleteOnExit().


The documentation for this class was generated from the following files:
Generated on Thu Nov 15 15:24:39 2007 for Simulator for the Linear Collider by  doxygen 1.5.4