broadwick.odesolver

Class Observer

java.lang.Object

broadwick.odesolver.Observer

All Implemented Interfaces:

Comparable<Observer>

public abstract class Observer
extends Object
implements Comparable<Observer>

Implementing classes are used to observe certain aspects of the solver. 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.

Field Summary

Fields

Modifier and Type	Field and Description
private OdeSolver	solver

Constructor Summary

Constructors

Constructor and Description
Observer(OdeSolver solver) Creates an observer dedicated to an ODE solver.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Observer o)
abstract void	finished() Gets called when the ODE solver has finished, directly after the termination check.
abstract void	started() Gets called when the ODE solver 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 the ODE solver 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

solver

private final OdeSolver solver

Constructor Detail

Observer

public Observer(OdeSolver solver)

Creates an observer dedicated to an ODE solver. The observer is NOT registered to the solver until you call OdeSolver.addObserver(Observer).

Parameters:

solver - the solver

Method Detail

started

public abstract void started()

Gets called when the ODE solver 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 the ODE solver has finished, directly after the termination check.

theta

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

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

Parameters:

thetaTime - the time the event has to be triggered.

events - a collection of events that occur at thetaTime.

compareTo

public final int compareTo(Observer o)

Specified by:

compareTo in interface Comparable<Observer>