ikr.simlib.entities.generators

Class TraceGenerator

java.lang.Object

ikr.simlib.entities.Entity

ikr.simlib.entities.generators.Generator

ikr.simlib.entities.generators.TraceGenerator

All Implemented Interfaces:

ReflectionConstructable, ReflectionConstructable2<SimNode,Parameters>

public class TraceGenerator
extends Generator

TraceGenerator generates messages at timestamps, which are given in a trace file. Further the length of the message is provided by the trace file. The type of the message depends on the default message, handled by the according message factory. TraceGenerator has two helper classes, namely TraceFile and TraceItem. The trace file must have have following format:
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 the boolean attribute absoluteTime in the constructor, or in the parameter file when the generator is parsed. Further the behaviour at the end of the trace file can be determined. If wrapFile is set to true, the trace file is reread from the beginning, but in the case of absolute time only the IAT between two succeeding events is considered. In the other case the simulation interrupts with an error, if the end of the trace file is reached. Comments are initiated by a leading '#'.

Nested Class Summary

Nested classes/interfaces inherited from class ikr.simlib.entities.Entity

Entity.PortAlias

Field Summary

Fields

Modifier and Type	Field and Description
protected int	msgCounter
protected TraceFile	traceFile

Fields inherited from class ikr.simlib.entities.generators.Generator

activated, event, messageFactory, outputPort

Fields inherited from class ikr.simlib.entities.Entity

portAliases, ports, simNode

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

CREATE_INSTANCE_METHOD_NAME

Constructor Summary

Constructors

Constructor and Description
TraceGenerator(java.lang.String filename, SimNode ownNode, boolean absoluteTime, boolean wrapFile, Factory<Message> factory)
TraceGenerator(java.lang.String filename, SimNode ownNode, boolean absoluteTime, boolean wrapFile, Factory<Message> factory, boolean activateOnStart)
TraceGenerator(java.lang.String filename, SimNode ownNode, Factory<Message> factory)
TraceGenerator(java.lang.String filename, SimNode ownNode, Factory<Message> factory, boolean activateOnStart)

Method Summary

Methods

Modifier and Type	Method and Description
static TraceGenerator	createInstance(SimNode ownNode, Parameters pars) as required by ReflectionConstructable
protected Message	createMessage()
protected double	getNextEventTime(double currentTime)

Methods inherited from class ikr.simlib.entities.generators.Generator

activate, deactivate, getMessageFactory, getOutput, setActivated, setMessageFactory

Methods inherited from class ikr.simlib.entities.Entity

addPort, aliasPort, aliasPort, connect, disconnect, getName, getNode, getPortByName, getPorts, isPortKnown, unaliasPort

Methods inherited from class java.lang.Object

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

Field Detail

traceFile

protected TraceFile traceFile

msgCounter

protected int msgCounter

Constructor Detail

TraceGenerator

public TraceGenerator(java.lang.String filename,
              SimNode ownNode,
              Factory<Message> factory,
              boolean activateOnStart)

TraceGenerator

public TraceGenerator(java.lang.String filename,
              SimNode ownNode,
              Factory<Message> factory)

TraceGenerator

public TraceGenerator(java.lang.String filename,
              SimNode ownNode,
              boolean absoluteTime,
              boolean wrapFile,
              Factory<Message> factory,
              boolean activateOnStart)

TraceGenerator

public TraceGenerator(java.lang.String filename,
              SimNode ownNode,
              boolean absoluteTime,
              boolean wrapFile,
              Factory<Message> factory)

Method Detail

createInstance

public static TraceGenerator createInstance(SimNode ownNode,
                            Parameters pars)

as required by ReflectionConstructable

createMessage

protected Message createMessage()

Overrides:

createMessage in class Generator

getNextEventTime

protected double getNextEventTime(double currentTime)

Specified by:

getNextEventTime in class Generator