ikr.simlib.control

Class SimulationEnvironment

java.lang.Object

ikr.simlib.control.SimulationEnvironment

public class SimulationEnvironment
extends java.lang.Object

The SimulationEnvironment provides a standard set of command line parameters which are automatically parsed. It is fully compatible with SimTree.

The class Simulation makes use of SimulationEnvironment in order to read command line parameters. The possible parameters are given in the following:

Parameter	Range	Description
n	>0	number of batches
s	0-127	index of seed for random number generator
p		parameter file
f		filter file
l		log file
b		batch log file
e		export file for batch results
i		import file for batch results
g		parse log file
t		test log file
c		type of calendar

If specified the number of given export and import files needs to match to the number of batches. Simultaneous definition of import and export files is not possible.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<PrintResultWriter>	batchLogWriters
protected java.lang.String	calendarType
protected CompressionType	compressionType
protected java.util.List<ResultWriter>	exportWriters
protected java.io.Reader	filterStream
protected java.util.List<ResultReader>	importReaders
protected PrintResultWriter	logWriter
protected int	numberOfBatches
protected java.io.InputStream	parameterStream
protected java.io.PrintWriter	parserLogStream
protected int	seedIndex
static java.lang.String	USAGE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SimulationEnvironment()
	SimulationEnvironment(ArgParser argParser, java.lang.String[] args)
	SimulationEnvironment(java.lang.String name, java.lang.String[] args)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addOptions(ArgParser argParser)
java.util.List<PrintResultWriter>	getBatchLogWriters()
java.lang.String	getCalendarType()
java.util.List<ResultWriter>	getExportWriters()
java.util.List<ResultReader>	getImportReaders()
PrintResultWriter	getLogWriter()
int	getNumberOfBatches()
java.io.InputStream	getParameterStream()
java.io.PrintWriter	getParserLogStream()
int	getSeedIndex()
protected void	init(ArgParser argParser)
boolean	isImportSimulation()

Methods inherited from class java.lang.Object

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

Field Detail

USAGE

public static final java.lang.String USAGE

See Also:

Constant Field Values

numberOfBatches

protected int numberOfBatches

seedIndex

protected int seedIndex

parameterStream

protected java.io.InputStream parameterStream

parserLogStream

protected java.io.PrintWriter parserLogStream

filterStream

protected java.io.Reader filterStream

logWriter

protected PrintResultWriter logWriter

batchLogWriters

protected java.util.List<PrintResultWriter> batchLogWriters

exportWriters

protected java.util.List<ResultWriter> exportWriters

importReaders

protected java.util.List<ResultReader> importReaders

calendarType

protected java.lang.String calendarType

compressionType

protected CompressionType compressionType

Constructor Detail

SimulationEnvironment

protected SimulationEnvironment()

SimulationEnvironment

public SimulationEnvironment(ArgParser argParser,
                     java.lang.String[] args)

SimulationEnvironment

public SimulationEnvironment(java.lang.String name,
                     java.lang.String[] args)

Method Detail

addOptions

protected void addOptions(ArgParser argParser)

init

protected void init(ArgParser argParser)

getNumberOfBatches

public int getNumberOfBatches()

getSeedIndex

public int getSeedIndex()

getParameterStream

public java.io.InputStream getParameterStream()

getParserLogStream

public java.io.PrintWriter getParserLogStream()

getLogWriter

public PrintResultWriter getLogWriter()

getBatchLogWriters

public java.util.List<PrintResultWriter> getBatchLogWriters()

getExportWriters

public java.util.List<ResultWriter> getExportWriters()

getImportReaders

public java.util.List<ResultReader> getImportReaders()

isImportSimulation

public boolean isImportSimulation()

getCalendarType

public java.lang.String getCalendarType()