ikr.simlib.entities.generators

Class Generator

java.lang.Object

ikr.simlib.entities.Entity

ikr.simlib.entities.generators.Generator

All Implemented Interfaces:

ReflectionConstructable, ReflectionConstructable2<SimNode,Parameters>

Direct Known Subclasses:

BurstGenerator, DStdGenerator, StdGenerator, TraceGenerator

public abstract class Generator
extends Entity
implements ReflectionConstructable2<SimNode,Parameters>

The class Generator is derived from Entity and is the abstract base class for all message generators. Deriving classes must implement getNextEventTime(double) to calculate the time for the next message to be generated.

Each Generator has to have exactly one MessageFactory. If no MessageFactory is provided, Generator creates a new MessageFactory with an default Message of type Message and length 1. Generator provides the basic functionality for all derived generators:

- The generation of messages is controlled by events.

- Each time an event has been processed, a new event is registered.


The creation of a message is performed by calling createMessage(), which forces an aggregated object derived from the class Factory to create a new message. Almost all details of message generation are therefore hidden within the message factory. The term message is used as a synonym for all possible representations of a messages, which are derived from Message.

- It is possible to set and get message factories during any phase of simulation by calling setMessageFactory(Factory) and getMessageFactory(). Several entities (generators) can share the same message factory.

- For each generator class, there is a corresponding parser class.

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 boolean	activated
protected Event	event
protected Factory<Message>	messageFactory
protected SynchronousOutputPort	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

Modifier	Constructor and Description
protected	Generator(SimNode ownNode)
protected	Generator(SimNode ownNode, Factory<Message> factory, boolean activateOnStart)

Method Summary

Methods

Modifier and Type	Method and Description
void	activate()
protected Message	createMessage()
void	deactivate()
Factory	getMessageFactory()
protected abstract double	getNextEventTime(double currentTime)
OutputPort	getOutput()
void	setActivated(boolean start)
void	setMessageFactory(Factory<Message> Factory)

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

outputPort

protected SynchronousOutputPort outputPort

event

protected Event event

messageFactory

protected Factory<Message> messageFactory

activated

protected boolean activated

Constructor Detail

Generator

protected Generator(SimNode ownNode,
         Factory<Message> factory,
         boolean activateOnStart)

Generator

protected Generator(SimNode ownNode)

Method Detail

getNextEventTime

protected abstract double getNextEventTime(double currentTime)

createMessage

protected Message createMessage()

setActivated

public void setActivated(boolean start)

activate

public final void activate()

deactivate

public final void deactivate()

setMessageFactory

public void setMessageFactory(Factory<Message> Factory)

getMessageFactory

public Factory getMessageFactory()

getOutput

public OutputPort getOutput()