fr.ifremer.isisfish.simulator

Interface SimulationPlanContext

All Known Subinterfaces:

OptimizationContext

All Known Implementing Classes:

AnalysePlanContext, OptimizationContextInternal, SimulationPlanContextInternal

public interface SimulationPlanContext

Version:

$Revision$ Last update: $Date$ by : $Author$

Author:

poussin

Method Summary

Modifier and Type	Method and Description
Historic	getHistoric()
String	getId() Get id.
SimulationStorage	getLastSimulation() Get last simulation storage.
int	getNumber() Deprecated. use nextSimulation.getParameter().getSimulationPlanNumber()
SimulationParameter	getParam() Get simulation parameters.
SimulationStorage	getSimulation(int number) Get SimulationStorage for specified simulation plan number.
Object	getValue(String key) Get plan context value.
void	setValue(String key, Object value) Set plan context value.

Method Detail

getId

String getId()

Get id.

Returns:

the id

getLastSimulation

SimulationStorage getLastSimulation()

Get last simulation storage. Used in script.

Returns:

last simulation storage

getNumber

int getNumber()

Deprecated. use nextSimulation.getParameter().getSimulationPlanNumber()

Get current simulation plan simulation count. Warning, in after simulation, refer to generated simulation count, not ended simulation number. Depreciated, but no remove this method, it's just to not be used by user script.

Returns:

the number

getParam

SimulationParameter getParam()

Get simulation parameters.

Returns:

simulation parameters

getSimulation

SimulationStorage getSimulation(int number)

Get SimulationStorage for specified simulation plan number.

Parameters:

number - number

Returns:

SimulationStorage

getValue

Object getValue(String key)

Get plan context value. Used in script.

Parameters:

key - key

Returns:

value for key.

setValue

void setValue(String key,
              Object value)

Set plan context value. Used in script.

Parameters:

key - key

value - value

getHistoric

Historic getHistoric()