Driver (LCSim 3.1.7 API)

java.lang.Object
- org.lcsim.util.Driver

Direct Known Subclasses:

AbstractStrategyBuilder, AidaSaveDriver, AssociatedHitRemover, CalorimeterLayerSelector, CalorimeterOccupancyDriver, ClusterCalibrationAnalysisDriver, ClusterEnergyAnalysis, ClusteringDriver, CollectionHandler, ConditionsCheckDriver, CreateFinalStateMCParticleList, DigiDriver, Driver.MotherOfAllDrivers, DummyDriver, EmcalMipStubs, EMClusterID, EventMarkerDriver, ExampleDriver, ExampleDriver1, ExampleDriver2, FastMCTrackDriver, FixedConeClusterDriver, GarfieldHitConverter, GarfieldTrackFinder, HelicalTrackHitDriver, HiggsRecoilMassAnalysis, HitMakingDriver, JetDriver, LCIODriver, LCIOFlagDriver, MainTrackingDriver, MakeSensorsDriver, MCFast, MCFastReconstructedParticleDriver, MCFastRonan, MCFastTracking, MCTruthDriver, McTruthLinker, MergeDriver, MergeEventsDriver, MipSamplingFractionAnalysisDriver, MonitorStdhep, NNAlgoClusterAnalysisDriver, NNAlgoClusterDriver, OverlayDriver, PandoraPfoSamplingFractionAnalysislDriver, PfoSelector, PixelDigiSetupDriver, ProcessHitsDriver, ReconstructedParticleAnalysis, RemoveMultipleHelicalTrackHitsCheater, RemoveMultipleTrackHitsCheater, RemoveUnusedTrackerHits, ResetCalorimeterHitEnergy, Runem, SamplingFractionAnalysisDriver, SamplingFractionAnalysisPolyCalDriver, SeedTracker, SeedTrackerTrackStateDriver, SeedTrackerWrapper, SegmentationManager, SimpleTrackAnalysis, SimToDigiDriver, SinglePhotonAnalysis, SingleTrackAnalysisDriver, SiTrackerBarrelSensorSetup, SiTrackerBarrelSensorSetup, SiTrackerEndcap2SensorSetup, SiTrackerEndcap2SensorSetup, SiTrackerEndcapSensorSetup, SiVertexBarrelSensorSetup, SiVertexBarrelSensorSetup, SiVertexEndcapSensorSetup, SiVertexEndcapSensorSetup, StdhepDriver, StrategyDriver, StripDigiSetupDriver, StripIdrupEvent, TrackerHitConverter, TrackerHitDriver, TrackerHitDriver_sidloi2, TrackerHitDriver_User, TrackSubdetectorHitNumbersDriver, WhizardEventFilter
```
public class Driver
extends Object
```
A driver is a steering routine which can deal with event processing, and/or call any number of child drivers. When used as a child driver all parameters such as histogramLevel and logger are inherited from the parent driver.
It also allows controlling the histogram level of the processors being called and handles coordination of random numbers between Monte Carlo processors.

Version:

$Id: Driver.java,v 1.14 2007/09/11 00:21:00 tonyj Exp $

Author:

Tony Johnson

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Driver.AbortRunException` If thrown during the process method of a driver, causes processing of events to be aborted.
`private static class`	`Driver.MotherOfAllDrivers`
`static class`	`Driver.NextEventException` If thrown during the process method of a driver, causes processing of the current event to be aborted.

Field Summary

Fields
Modifier and Type	Field and Description
`private String`	`driverName`
`private int`	`histogramLevel`
`static int`	`HLEVEL_DEFAULT`
`static int`	`HLEVEL_FULL`
`static int`	`HLEVEL_HIGH`
`static int`	`HLEVEL_NORMAL`
`static int`	`HLEVEL_OFF`
`private static Driver`	`mother`
`private int`	`nEvents`
`private long`	`nNanos`
`private Driver`	`parent`
`private Random`	`random`
`private List<Driver>`	`subDrivers`

Constructor Summary

Constructors
Constructor and Description

Driver()
Creates a driver

Driver(String name)

Constructors
Constructor and Description
`Driver()` Creates a driver
`Driver(String name)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`add(Driver driver)` Add a sub-Driver to this Driver.
`void`	`clearStatistics()` Clear statistics
`boolean`	`contains(Driver driver)` Tests to see if a given Driver is already a child of this Driver
`protected void`	`detectorChanged(Detector detector)` Called by the framework before process method when the detector geometry changes.
`(package private) void`	`doProcess(EventHeader event)`
`List<Driver>`	`drivers()` Returns a List of all the drivers added to this Driver
`protected void`	`endOfData()` Called when all data processing is finished.
`private static String`	`formatName(int indent, String name, int width)`
`private static String`	`formatTime(long nanos)`
`ConditionsManager`	`getConditionsManager()`
`int`	`getHistogramLevel()` Get the default histogram level for this driver
`Logger`	`getLogger()` Returns a logger for logging diagnostic messages from this driver
`String`	`getName()` Get the name of this driver.
`Random`	`getRandom()`
`(package private) String`	`pathToMother()`
`void`	`printStatistics(PrintStream out)` Print statistics for this driver and its children
`private void`	`printStatistics(PrintStream out, int indent, long parentNanos)`
`private static void`	`printStatisticsLine(PrintStream out, int indent, String name, int nEvents, long time, long parentTime)`
`protected void`	`process(EventHeader event)` Called by the framework to process an event.
`void`	`processChildren(EventHeader event)` Calls the sub-Drivers process() method.
`void`	`remove(Driver driver)` Removes a sub-Driver from this Driver
`protected void`	`resume()` Called by the framework when event processing is resumed.
`void`	`setHistogramLevel(int level)` Set the histogram level for this driver (and its child drivers)
`void`	`setLogLevel(String logLevel)`
`void`	`setRandom(Random random)` Set default random number generator for this driver and all child drivers.
`protected void`	`startOfData()` Called before the first event is processed, or after a rewind.
`protected void`	`suspend()` Called by the framework when event processing is suspended.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - HLEVEL_DEFAULT
```
public static final int HLEVEL_DEFAULT
```
    See Also:
    Constant Field Values
  - HLEVEL_OFF
```
public static final int HLEVEL_OFF
```
    See Also:
    Constant Field Values
  - HLEVEL_NORMAL
```
public static final int HLEVEL_NORMAL
```
    See Also:
    Constant Field Values
  - HLEVEL_HIGH
```
public static final int HLEVEL_HIGH
```
    See Also:
    Constant Field Values
  - HLEVEL_FULL
```
public static final int HLEVEL_FULL
```
    See Also:
    Constant Field Values
  - mother
```
private static Driver mother
```
  - subDrivers
```
private final List<Driver> subDrivers
```
  - parent
```
private Driver parent
```
  - histogramLevel
```
private int histogramLevel
```
  - random
```
private Random random
```
  - driverName
```
private final String driverName
```
  - nEvents
```
private int nEvents
```
  - nNanos
```
private long nNanos
```
- Constructor Detail
  - Driver
```
public Driver()
```
    Creates a driver
  - Driver
```
Driver(String name)
```
- Method Detail
  - add
```
public void add(Driver driver)
```
    Add a sub-Driver to this Driver. Sub-drivers are automatically called from the process method.
    
    Parameters:
    driver - The Driver to be added
  - remove
```
public void remove(Driver driver)
```
    Removes a sub-Driver from this Driver
    
    Parameters:
    driver - The Driver to be removed
  - drivers
```
public List<Driver> drivers()
```
    Returns a List of all the drivers added to this Driver
  - contains
```
public boolean contains(Driver driver)
```
    Tests to see if a given Driver is already a child of this Driver
    
    Parameters:
    driver - Driver to be checked
  - getLogger
```
public Logger getLogger()
```
    Returns a logger for logging diagnostic messages from this driver
  - getName
```
public String getName()
```
    Get the name of this driver. Normally this will be the class name of the driver (without the packaging information).
  - pathToMother
```
String pathToMother()
```
  - getHistogramLevel
```
public int getHistogramLevel()
```
    Get the default histogram level for this driver
  - setHistogramLevel
```
public void setHistogramLevel(int level)
```
    Set the histogram level for this driver (and its child drivers)
  - getConditionsManager
```
public ConditionsManager getConditionsManager()
```
  - suspend
```
protected void suspend()
```
    Called by the framework when event processing is suspended.
  - resume
```
protected void resume()
```
    Called by the framework when event processing is resumed.
  - endOfData
```
protected void endOfData()
```
    Called when all data processing is finished.
  - startOfData
```
protected void startOfData()
```
    Called before the first event is processed, or after a rewind.
  - detectorChanged
```
protected void detectorChanged(Detector detector)
```
    Called by the framework before process method when the detector geometry changes. This method is gauranteed to be called once before the first call to process.
    
    Parameters:
    Detector - The new detector
  - process
```
protected void process(EventHeader event)
```
    Called by the framework to process an event. Don't forget to call super.process(event) to cause the child processes to be executed. In addition the process event call can throw some special exceptions:
    - NextEventException - aborts further processing of this event
    - StopRunException - causes event processing to be stopped
    Parameters:
    event - The event to be processed
    See Also:
    Driver.NextEventException, Driver.AbortRunException
  - clearStatistics
```
public void clearStatistics()
```
    Clear statistics
  - printStatistics
```
public void printStatistics(PrintStream out)
```
    Print statistics for this driver and its children
  - printStatistics
```
private void printStatistics(PrintStream out,
                   int indent,
                   long parentNanos)
```
  - printStatisticsLine
```
private static void printStatisticsLine(PrintStream out,
                       int indent,
                       String name,
                       int nEvents,
                       long time,
                       long parentTime)
```
  - formatName
```
private static String formatName(int indent,
                String name,
                int width)
```
  - formatTime
```
private static String formatTime(long nanos)
```
  - doProcess
```
void doProcess(EventHeader event)
```
  - processChildren
```
public void processChildren(EventHeader event)
```
    Calls the sub-Drivers process() method. Note: This method is only public so that it can be called from Jython, see LCSIM-30
  - getRandom
```
public Random getRandom()
```
  - setRandom
```
public void setRandom(Random random)
```
    Set default random number generator for this driver and all child drivers.
    
    Parameters:
    random - The random number generator, or null to reset to default
  - setLogLevel
```
public void setLogLevel(String logLevel)
```

Class Driver

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

HLEVEL_DEFAULT

HLEVEL_OFF

HLEVEL_NORMAL

HLEVEL_HIGH

HLEVEL_FULL

mother

subDrivers

parent

histogramLevel

random

driverName

nEvents

nNanos

Constructor Detail

Driver

Driver

Method Detail

add

remove

drivers

contains

getLogger

getName

pathToMother

getHistogramLevel

setHistogramLevel

getConditionsManager

suspend

resume

endOfData

startOfData

detectorChanged

process

clearStatistics

printStatistics

printStatistics

printStatisticsLine

formatName

formatTime

doProcess

processChildren

getRandom

setRandom

setLogLevel