slic::CommandQueue Class Reference

#include <CommandQueue.hh>

Inheritance diagram for slic::CommandQueue:

[legend]

Collaboration diagram for slic::CommandQueue:

[legend]

List of all members.

---

Detailed Description

A queue of G4 commands to be executed in order.

Note:

Created by CommandLineProcessor from the command line arguments.

Definition at line 19 of file CommandQueue.hh.

Public Types
typedef std::vector< std::string >	CmdVecType
typedef std::string	CmdType
typedef size_t	SizeType
enum	ModuleStatus { eOkay = 0, eNotInitialized = 1, eBadState = 2, eFatalError = 3 }
Public Member Functions
	CommandQueue ()
virtual	~CommandQueue ()
void	add (const CmdType &g4cmd)
void	add (const char *g4cmd)
CmdVecType::iterator	cmdsBegin ()
CmdVecType::iterator	cmdsEnd ()
void	printOut ()
void	execute ()
void	clear ()
CmdVecType::iterator	find (const std::string &str)
const std::string &	getName () const
const ModuleStatus	getStatus () const
virtual void	initialize ()
virtual void	reset ()
virtual void	cleanup ()
bool	deleteOnExit ()
LogStream &	log ()
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 Attributes
CmdVecType	m_commands

---

Member Typedef Documentation

typedef std::vector<std::string> slic::CommandQueue::CmdVecType

Definition at line 23 of file CommandQueue.hh.

typedef std::string slic::CommandQueue::CmdType

Definition at line 24 of file CommandQueue.hh.

typedef size_t slic::CommandQueue::SizeType

Definition at line 25 of file CommandQueue.hh.

---

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::CommandQueue::CommandQueue

(

)

[inline]

Definition at line 29 of file CommandQueue.hh.

virtual slic::CommandQueue::~CommandQueue

(

)

[inline, virtual]

Definition at line 33 of file CommandQueue.hh.

---

Member Function Documentation

void slic::CommandQueue::add

(

const CmdType &

g4cmd

)

[inline]

Add a command to the queue.

Definition at line 39 of file CommandQueue.hh.

References m_commands.

Referenced by slic::CommandLineProcessor::process(), and slic::CommandLineProcessor::processOptions().

void slic::CommandQueue::add

(

const char *

g4cmd

)

[inline]

Add a command using char* type.

Definition at line 47 of file CommandQueue.hh.

CmdVecType::iterator slic::CommandQueue::cmdsBegin

(

)

[inline]

Get the begin iterator of the queue.

Definition at line 56 of file CommandQueue.hh.

References m_commands.

Referenced by execute(), and printOut().

CmdVecType::iterator slic::CommandQueue::cmdsEnd

(

)

[inline]

Get the end iterator of the queue.

Definition at line 64 of file CommandQueue.hh.

References m_commands.

Referenced by execute(), and printOut().

void slic::CommandQueue::printOut

(

)

Print the queue to the log.

Definition at line 10 of file CommandQueue.cc.

References LOG::always, cmdsBegin(), cmdsEnd(), LOG::done, and slic::Module::log().

Referenced by slic::SlicApplication::run().

void slic::CommandQueue::execute

(

)

Execute the commands in the queue sequentially.

Definition at line 24 of file CommandQueue.cc.

References cmdsBegin(), and cmdsEnd().

Referenced by slic::SlicApplication::run().

void slic::CommandQueue::clear

(

)

[inline]

Clear all the commands in the queue.

Definition at line 82 of file CommandQueue.hh.

References m_commands.

Referenced by slic::SlicApplication::run().

CommandQueue::CmdVecType::iterator slic::CommandQueue::find

(

const std::string &

str

)

Find the first command that matches a string.

Definition at line 34 of file CommandQueue.cc.

References m_commands.

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(), slic::LcioFileNamer::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(), 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

CmdVecType slic::CommandQueue::m_commands [private]

Definition at line 93 of file CommandQueue.hh.

Referenced by add(), clear(), cmdsBegin(), cmdsEnd(), and find().

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:

• CommandQueue.hh
• CommandQueue.cc

---