broadwick.stochastic

Class Observer

java.lang.Object

broadwick.stochastic.Observer

All Implemented Interfaces:

Comparable<Observer>

public abstract class Observer
extends Object
implements Comparable<Observer>

Implementing classes are used to observe certain aspects of simulations (stochastic processes). It is basically just an interface of methods that get called during a simulation together with some common methods useful for many types of observers.

Some observers take repeats into account. If you repeat the simulations, they will yield average data.

Each observer should override the toString method which should return a string representation of its data.

You can register a PrintWriter to the Observer. If you have, the return value of toString is printed if a simulation has finished.

Author:

Florian Erhard (copied from FERN http://www.bio.ifi.lmu.de/FERN/)

Field Summary

Fields

Modifier and Type	Field and Description
private StochasticSimulator	process

Constructor Summary

Constructors

Constructor and Description
Observer(StochasticSimulator sim) Creates an observer dedicated to one process.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Observer o)
abstract void	finished() Gets called when a simulation has finished, directly after the termination check.
abstract void	observeEvent(SimulationEvent event, double tau, int times) Gets called before an event is triggered.
abstract void	started() Gets called when the simulation has started after the initialization and before the termination condition is checked the first time.
abstract void	step() Gets called after each termination check and before Simulator#performStep(fern.simulation.controller.SimulationController) is called.
abstract void	theta(double thetaTime, Collection<Object> events) Gets called by simulators when a certain moment in time is reached.

Methods inherited from class java.lang.Object

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

Field Detail

process

private StochasticSimulator process

Constructor Detail

Observer

public Observer(StochasticSimulator sim)

Creates an observer dedicated to one process. The observer is NOT registered at the process, you have to call Simulator#addObserver(Observer) in order to do this.

Parameters:

sim - the process

Method Detail

compareTo

public final int compareTo(Observer o)

Specified by:

compareTo in interface Comparable<Observer>

started

public abstract void started()

Gets called when the simulation has started after the initialization and before the termination condition is checked the first time.

step

public abstract void step()

Gets called after each termination check and before Simulator#performStep(fern.simulation.controller.SimulationController) is called.

finished

public abstract void finished()

Gets called when a simulation has finished, directly after the termination check.

theta

public abstract void theta(double thetaTime,
                           Collection<Object> events)

Gets called by simulators when a certain moment in time is reached. This moment in time has to be registered with the observer in the StochasticSimulator.

Parameters:

thetaTime - moment in time

events - a collection of events that occur at thetaTime.

observeEvent

public abstract void observeEvent(SimulationEvent event,
                                  double tau,
                                  int times)

Gets called before an event is triggered.

Parameters:

event - the event which is supposed to fire

tau - the time the event occurs (at this time Simulator#getTime()

times - the number of firings