fr.ifremer.isisfish.simulator
Interface AnalysePlan

All Known Subinterfaces:

AnalysePlanIndependent

public interface AnalysePlan

AnalysePlan.java Created: 1 mars 07 20:27:28

Version:

$Revision: 2431 $ Last update: $Date: 2009-06-25 15:11:31 +0200 (jeu., 25 juin 2009) $ by : $Author: chatellier $ TODO will be renamed to SimulationPlan soon

Author:

poussin

Method Summary

boolean	afterSimulation(AnalysePlanContext context, SimulationStorage lastSimulation) Call after each simulation.
boolean	beforeSimulation(AnalysePlanContext context, SimulationStorage nextSimulation) Call before each simulation.
java.lang.String	getDescription() Return plan description.
java.lang.String[]	getNecessaryResult() Return plan necessary Results.
void	init(AnalysePlanContext context) Use only once before first simulation.

Method Detail

getNecessaryResult

java.lang.String[] getNecessaryResult()

Return plan necessary Results.

Returns:

the necessaryResult name

getDescription

java.lang.String getDescription()
                                throws java.lang.Exception

Return plan description.

Returns:

plan description

Throws:

java.lang.Exception

init

void init(AnalysePlanContext context)
          throws java.lang.Exception

Use only once before first simulation. You can modified Param for all simulation or put value in context.values.

Parameters:

context - plan context

Throws:

java.lang.Exception

beforeSimulation

boolean beforeSimulation(AnalysePlanContext context,
                         SimulationStorage nextSimulation)
                         throws java.lang.Exception

Call before each simulation.

Parameters:

context - plan context

nextSimulation - storage used for next simulation

Returns:

true if we must do next simulation, false to stop plan

Throws:

java.lang.Exception

afterSimulation

boolean afterSimulation(AnalysePlanContext context,
                        SimulationStorage lastSimulation)
                        throws java.lang.Exception

Call after each simulation.

Parameters:

context - plan context

lastSimulation - storage used for simulation

Returns:

true if we must do next simulation, false to stop plan

Throws:

java.lang.Exception