ikr.simlib.untested.trace

Class TraceFile

java.lang.Object

ikr.simlib.untested.trace.TraceFile

All Implemented Interfaces:

ReflectionConstructable, ReflectionConstructable2<SimNode,Parameters>

public class TraceFile
extends java.lang.Object
implements ReflectionConstructable2<SimNode,Parameters>

TraceFile is supportive class which is responsible for handling the trace files. The trace file must have the following structure:

hh:mm:ss.sss length

The time information can either be absolute or relative to the preeceding event (=interarrival time), this can be set by absoluteTime. For absolute time stamps, all time stamps are shifted such that the first event is at time zero.

Further the behavior at the end of the trace file can be determined. If wrapFile is set, the trace file is reread from the beginning. Otherwise the simulation interrupts with an error when the end of the trace file is reached. If time information is absolute, the duration between the last item of run n and the first item of run n+1 is set to twice the duration between the last two items of run n. All following time stamps are shifted such that the remaining interarrival times are the same as the differences of the time values in the trace file.

Comments are initiated by a leading '#'.

TraceFile is a parseable class. It accepts the following keywords in the parameter file:

FileName

The name of the trace file

AbsoluteTime (boolean, optional)

Set to TRUE if the times in the trace file represent absolute times. Set to FALSE if they represent relative times (i.e., time differences). Default is TRUE

WrapFile (boolean, optional)

Set to TRUE if you want the trace to be reread from the beginning once the end is reached. If set to FALSE, an exception will be thrown when the end of the trace file is reached. Default is FALSE.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	absoluteTime Contains the traceFile absolute or relative times
protected TraceItem	currentItem
protected boolean	endOfFile
protected java.io.RandomAccessFile	file
protected java.lang.String	fileName
protected boolean	firstRunFinished
protected Duration	iat
protected TraceItem	previousItem
protected Duration	timeDiffForFirstItem Determined from the first value
protected boolean	wrapFile Behavior, if the end of the file is reached

Fields inherited from interface ikr.simlib.parameters.reflection.ReflectionConstructable

CREATE_INSTANCE_METHOD_NAME

Constructor Summary

Constructors

Constructor and Description
TraceFile(java.lang.String filename)
TraceFile(java.lang.String fileName, boolean absoluteTime, boolean wrapFile)

Method Summary

Methods

Modifier and Type	Method and Description
static TraceFile	createInstance(SimNode ownNode, Parameters pars) as required by ReflectionConstructable
java.lang.String	getFileName()
PointInTime	getNextEventTime(PointInTime currentTime)
int	getNextLength() returns the length of the current message and moves to the next message

Methods inherited from class java.lang.Object

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

Field Detail

fileName

protected final java.lang.String fileName

file

protected final java.io.RandomAccessFile file

absoluteTime

protected final boolean absoluteTime

Contains the traceFile absolute or relative times

wrapFile

protected final boolean wrapFile

Behavior, if the end of the file is reached

timeDiffForFirstItem

protected final Duration timeDiffForFirstItem

Determined from the first value

currentItem

protected TraceItem currentItem

previousItem

protected TraceItem previousItem

iat

protected Duration iat

endOfFile

protected boolean endOfFile

firstRunFinished

protected boolean firstRunFinished

Constructor Detail

TraceFile

public TraceFile(java.lang.String fileName,
         boolean absoluteTime,
         boolean wrapFile)

TraceFile

public TraceFile(java.lang.String filename)

Method Detail

createInstance

public static TraceFile createInstance(SimNode ownNode,
                       Parameters pars)

as required by ReflectionConstructable

getNextEventTime

public PointInTime getNextEventTime(PointInTime currentTime)

getNextLength

public int getNextLength()

returns the length of the current message and moves to the next message

Returns:

length of the next message

getFileName

public java.lang.String getFileName()