fr.ifremer.isisfish.simulator
Interface SimulationPlan

All Known Subinterfaces:

AnalysePlan, AnalysePlanIndependent, SimulationPlanIndependent

public interface SimulationPlan

Simulation plan. Replace old AnalysePlan.

Version:

$Revision: 3436 $ Last update: $Date: 2011-07-07 16:33:45 +0200 (Thu, 07 Jul 2011) $ by : $Author: chatellier $

Author:

poussin

Method Summary

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

Method Detail

getNecessaryResult

String[] getNecessaryResult()

Return plan necessary Results.

Returns:

the necessaryResult name

getDescription

String getDescription()
                      throws Exception

Return plan description.

Returns:

plan description

Throws:

Exception

init

void init(SimulationPlanContext context)
          throws 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:

Exception

beforeSimulation

boolean beforeSimulation(SimulationPlanContext context,
                         SimulationStorage nextSimulation)
                         throws 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:

Exception

afterSimulation

boolean afterSimulation(SimulationPlanContext context,
                        SimulationStorage lastSimulation)
                        throws 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:

Exception