fr.ifremer.isisfish.simulator

Class SimulationPlanContextInternal

java.lang.Object

fr.ifremer.isisfish.simulator.SimulationPlanContextInternal

All Implemented Interfaces:

SimulationPlanContext

Direct Known Subclasses:

AnalysePlanContext, OptimizationContextInternal

public class SimulationPlanContextInternal
extends Object
implements SimulationPlanContext

Simulation plan context.java Replace old AnalysePlanContext.

Version:

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

Author:

poussin

Field Summary

Fields

Modifier and Type	Field and Description
protected Historic	historic
protected String	id Simulation id.
protected int	number Simulation plan number.
protected SimulationParameter	param Simulation parameters.
protected Map<String,Object>	values Additional context values.

Constructor Summary

Constructors

Constructor and Description
SimulationPlanContextInternal(String id, SimulationParameter param)

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	incNumber() Must be call when new simulation is generated from plan.
void	setValue(String key, Object value) Set plan context value.

Methods inherited from class java.lang.Object

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

Field Detail

id

protected String id

Simulation id.

number

protected int number

Simulation plan number.

param

protected SimulationParameter param

Simulation parameters.

historic

protected Historic historic

values

protected Map<String,Object> values

Additional context values.

Constructor Detail

SimulationPlanContextInternal

public SimulationPlanContextInternal(String id,
                                     SimulationParameter param)

Method Detail

getId

public String getId()

Get id.

Specified by:

getId in interface SimulationPlanContext

Returns:

the id

getNumber

public 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.

Specified by:

getNumber in interface SimulationPlanContext

Returns:

the number

incNumber

public void incNumber()

Must be call when new simulation is generated from plan.

getParam

public SimulationParameter getParam()

Get simulation parameters.

Specified by:

getParam in interface SimulationPlanContext

Returns:

simulation parameters

getValue

public Object getValue(String key)

Get plan context value. Used in script.

Specified by:

getValue in interface SimulationPlanContext

Parameters:

key - key

Returns:

value for key.

setValue

public void setValue(String key,
                     Object value)

Set plan context value. Used in script.

Specified by:

setValue in interface SimulationPlanContext

Parameters:

key - key

value - value

getLastSimulation

public SimulationStorage getLastSimulation()

Get last simulation storage. Used in script.

Specified by:

getLastSimulation in interface SimulationPlanContext

Returns:

last simulation storage

getSimulation

public SimulationStorage getSimulation(int number)

Get SimulationStorage for specified simulation plan number.

Specified by:

getSimulation in interface SimulationPlanContext

Parameters:

number - number

Returns:

SimulationStorage

getHistoric

public Historic getHistoric()

Specified by:

getHistoric in interface SimulationPlanContext