org.hps.record.daqconfig

Class DAQConfigDriver

java.lang.Object

org.lcsim.util.Driver

org.hps.record.daqconfig.DAQConfigDriver

Direct Known Subclasses:

DatabaseDAQConfigDriver

public class DAQConfigDriver
extends org.lcsim.util.Driver

Class DAQConfigDriver is responsible for accessing the DAQ configuration settings, and then passing them to the associated class ConfigurationManager so that they can be accessed by other classes.

The driver may accomplish this by two means. By default, it will check each event for an EvioDAQParser object which contains all of the DAQ configuration information and pass this to the ConfigurationManager. It will continue to update the ConfigurationManager during the run if new parser objects appear, and can thusly account for changing DAQ conditions.

The driver may also be set to read a DAQ configuration from text files containing the DAQ configuration bank information. To enable this mode, the parameter readDataFiles must be set to true and the parameters runNumber and also filepath must be defined. runNumber defines the run number of the configuration to be loaded and the parameter filepath defines the location of the data file repository.

This driver must be included in the driver chain if any other drivers in the chain rely on ConfigurationManager, as it can not be initialized otherwise.

Author:

Kyle McCarty

See Also:

ConfigurationManager

Nested Class Summary

Nested classes/interfaces inherited from class org.lcsim.util.Driver

org.lcsim.util.Driver.AbortRunException, org.lcsim.util.Driver.NextEventException

Field Summary

Fields

Modifier and Type	Field and Description
private int[]	crateNumber
private File[]	dataFiles
private String	filepath
private boolean	firstEvent
private boolean	readDataFiles
private int	runNumber

Fields inherited from class org.lcsim.util.Driver

HLEVEL_DEFAULT, HLEVEL_FULL, HLEVEL_HIGH, HLEVEL_NORMAL, HLEVEL_OFF

Constructor Summary

Constructors

Constructor and Description
DAQConfigDriver()

Method Summary

Modifier and Type	Method and Description
protected static String[][]	getDataFileArrays(BufferedReader[] reader) Converts DAQ configuration data streams into an array of strings where each array entry represents a line in the configuration file.
private static String[][]	getDataFileArrays(File[] dataFiles) Converts DAQ configuration data files into an array of strings where each array entry represents a line in the configuration file.
protected int	getRunNumber() Gets the run number that the DAQConfigDriver is set to use.
void	process(org.lcsim.event.EventHeader event) Checks an event for the DAQ configuration banks and passes them to the ConfigurationManager if the driver is set to read from the EvIO data stream.
void	setDataFileRepository(String filepath) Sets the location of the DAQ configuration data files.
void	setReadDataFiles(boolean state) Sets whether or not to read the DAQ configuration directly from the EvIO data stream or whether to read the configuration from data files.
void	setRunNumber(int run) Sets the run number of the DAQ configuration being processed.
void	startOfData() Verifies the parameter filepath for the data file repository and checks that appropriate data files exist for the requested run number if the driver is set to read from data files.

Methods inherited from class org.lcsim.util.Driver

add, clearStatistics, contains, detectorChanged, drivers, endOfData, getConditionsManager, getHistogramLevel, getLogger, getName, getRandom, printStatistics, processChildren, remove, resume, setHistogramLevel, setLogLevel, setRandom, suspend

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

runNumber

private int runNumber

filepath

private String filepath

firstEvent

private boolean firstEvent

readDataFiles

private boolean readDataFiles

dataFiles

private File[] dataFiles

crateNumber

private int[] crateNumber

Constructor Detail

DAQConfigDriver

public DAQConfigDriver()

Method Detail

startOfData

public void startOfData()

Verifies the parameter filepath for the data file repository and checks that appropriate data files exist for the requested run number if the driver is set to read from data files. Otherwise, this does nothing.

Overrides:

startOfData in class org.lcsim.util.Driver

process

public void process(org.lcsim.event.EventHeader event)

Checks an event for the DAQ configuration banks and passes them to the ConfigurationManager if the driver is set to read from the EvIO data stream. Otherwise, this will parse the data files on the first event and then do nothing.

Overrides:

process in class org.lcsim.util.Driver

Parameters:

event - - The current LCIO event.

getDataFileArrays

private static final String[][] getDataFileArrays(File[] dataFiles)
                                           throws IOException

Converts DAQ configuration data files into an array of strings where each array entry represents a line in the configuration file. The first array index of the returned object corresponds to the file, and the second array index corresponds to the line.

Parameters:

dataFiles - - An array of File objects pointing to the data files that are to be converted. These are expected to be plain text files.

Returns:

Returns a two-dimensional array of String objects where the first array index corresponds to the object of the same index in the File array and the second array index corresponds to the lines in the file referenced by the File object.

Throws:

IOException - Occurs if there is an issue with accessing or reading the objects in the objects referred to by the files pointed to in the dataFiles array.

getDataFileArrays

protected static final String[][] getDataFileArrays(BufferedReader[] reader)
                                             throws IOException

Converts DAQ configuration data streams into an array of strings where each array entry represents a line in the configuration file. The first array index of the returned object corresponds to the stream, and the second array index corresponds to the line.

Parameters:

reader - - An array of BufferedReader objects containing DAQ trigger configuration crate data.

Returns:

Returns a two-dimensional array of String objects where the first array index corresponds to the object of the same index in the BufferedReader array and the second array index corresponds to the lines in the stream referenced by the BufferedReader object.

Throws:

IOException - Occurs if there is an issue with reading data stream.

getRunNumber

protected final int getRunNumber()

Gets the run number that the DAQConfigDriver is set to use. This will be -1 in the event that the driver reads from an EvIO file.

Returns:

Returns the run number as an int primitive. Will return -1 if the driver is set to read from an EvIO file.

setRunNumber

public void setRunNumber(int run)

Sets the run number of the DAQ configuration being processed. This is only used when reading from data files.

Parameters:

run - - The run number of the data files to be used.

setDataFileRepository

public void setDataFileRepository(String filepath)

Sets the location of the DAQ configuration data files. This is only used when reading from the data files.

Parameters:

filepath - - The file path of the data file repository.

setReadDataFiles

public void setReadDataFiles(boolean state)

Sets whether or not to read the DAQ configuration directly from the EvIO data stream or whether to read the configuration from data files. Parameters runNumber and filepath must also be defined if this is set to true.

Parameters:

state - - true indicates that the configuration should be read from data files, and false that it should be read from the EvIO stream.