ikr.simlib.entities.generators

Class StdGenerator

java.lang.Object

ikr.simlib.entities.Entity

ikr.simlib.entities.generators.Generator

ikr.simlib.entities.generators.StdGenerator

All Implemented Interfaces:

ReflectionConstructable, ReflectionConstructable2<SimNode,Parameters>

public class StdGenerator
extends Generator

StdGenerator generates messages according to a renewal point process for which IAT distribution is provided. If a distribution for the length of a message is provided, it sets the message length in an iid fashion. That is, each time a message is created, the message length is drawn according to the given distribution. A MessageFactory may be provided to create messages other than Message.

If a length distribution is provided, the length of the default Message generated by the MessageFactory is overwritten.

StdGenerator is a very flexible Generator with the following characteristics:

• Messages are generated according to the interarrival time distribution.
• Message length follows an optional discrete distribution. Each time a new message is generated by a MessageFactory, the length is adapted by calling setLength() of the message and passing the new length according to the length distribution.
• If no length distribution is provided, the length of the generated message is not changed. Therefore control of the length remains at the MessageFactory.
• A message factory can be provided by passing it upon generation of StdGenerator.

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 ContinuousDistribution	interArrivalTime
protected DiscreteDistribution	messageLengthDist

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

activated, currentEventToken, 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
StdGenerator(ContinuousDistribution iat, DiscreteDistribution lengthdist, SimNode ownNode, Factory<Message> factory, boolean activateOnStart)

Method Summary

Methods

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

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

activate, deactivate, getMessageFactory, getOutput, handleProcessEvent, 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

interArrivalTime

protected final ContinuousDistribution interArrivalTime

messageLengthDist

protected final DiscreteDistribution messageLengthDist

Constructor Detail

StdGenerator

public StdGenerator(ContinuousDistribution iat,
            DiscreteDistribution lengthdist,
            SimNode ownNode,
            Factory<Message> factory,
            boolean activateOnStart)

Parameters:

iat - Distribution for the interarrival time

lengthdist - Distribution for the message length. May be null, in that case the message length is used as set by the factory.

ownNode - SimNode of the generator

factory - Factory used to create new message objects. May be null, in that case a new MessageFactory is created.

activateOnStart - If true, the generator automatically starts generating messages. Otherwise, Generator.setActivated(boolean) has to be called manually.

Method Detail

createInstance

public static StdGenerator createInstance(SimNode ownNode,
                          Parameters pars)

as required by ReflectionConstructable

createMessage

protected Message createMessage()

Overrides:

createMessage in class Generator

getNextEventTime

protected PointInTime getNextEventTime(PointInTime currentTime)

Specified by:

getNextEventTime in class Generator