SimulationItem (IsisFish 4.3.0.0 API)

java.lang.Object
- fr.ifremer.isisfish.simulator.launcher.SimulationItem

```
public class SimulationItem
extends Object
```
Objet representant une simulation qui doit être faite. Elle est composée :
- d'un fichier zip (la simulation a simuler)
- les parametres de la simulation
- d'un pre-script
- d'informations supplémentaires utiles à certains launcher :
  - standaloneSimulation : la simulation doit être lancée seule, sinon les simulations sont indépendantes et peuvent être lancées groupées (true par defaut)
  - simulationStandaloneZip : si le fichier zip est different pour toute les simulations ou s'il peut être commun à un ensemble de simulation
  - simulationNumber : simulation number in non standalone simulation
  - simulationsCount : total simulation count
  - lastSimulation : last simulation in a simulation pool
Les valeurs par defaut sont positionnée de telle sorte qu'une simulation est considérée par defaut comme totalement indépendante.
Version:

$Revision: 3798 $ Last update : $Date: 2012-10-30 11:39:32 +0100 (Tue, 30 Oct 2012) $ By : $Author: echatellier $

Author:

poussin

Field Summary

Fields
Modifier and Type	Field and Description
`protected SimulationControl`	`control` Le control pour la simulation.
`protected boolean`	`lastSimulation` last simulation in a simulation pool.
`protected SimulationParameter`	`parameter` Les parametres de simulation.
`protected int`	`simulationNumber` Simulation number in non standalone simulation.
`protected String`	`simulationPrescriptContent` Simulation prescript.
`protected File`	`simulationZip` Le zip contenant la simulation prete a etre executee.
`protected boolean`	`standaloneSimulation` La simulation doit être lancée seule, sinon les simulations sont indépendantes et peuvent être lancées groupées.
`protected boolean`	`standaloneSimulationZip` Si vrai, le fichier zip n'est pas commun à un ensemble de simulations.

Constructor Summary

Constructors
Constructor and Description

SimulationItem(SimulationControl control, SimulationParameter param)
Constructor.

Constructors
Constructor and Description
`SimulationItem(SimulationControl control, SimulationParameter param)` Constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`SimulationControl`	`getControl()` Retourne le control pour la simulation.
`SimulationParameter`	`getParameter()` Retourne les parametres de simulation.
`int`	`getSimulationNumber()`
`String`	`getSimulationPrescriptContent()` Deprecated. use cached simulation parameter instead
`File`	`getSimulationZip()` Retourne le zip contenant la simulation prete a etre executée.
`boolean`	`isLastSimulation()`
`boolean`	`isStandaloneSimulation()`
`boolean`	`isStandaloneSimulationZip()`
`void`	`setLastSimulation(boolean lastSimulation)`
`void`	`setSimulationNumber(int simulationNumber)`
`void`	`setSimulationPrescriptContent(String simulationPrescriptContent)` Deprecated. use cached simulation parameter instead
`void`	`setSimulationZip(File simulationZip)` Permet de mettre le zip apres construction de l'objet.
`void`	`setStandaloneSimulation(boolean standaloneSimulation)`
`void`	`setStandaloneSimulationZip(boolean standaloneSimulationZip)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - control
```
protected SimulationControl control
```
    Le control pour la simulation.
  - parameter
```
protected SimulationParameter parameter
```
    Les parametres de simulation.
  - simulationZip
```
protected File simulationZip
```
    Le zip contenant la simulation prete a etre executee.
  - standaloneSimulationZip
```
protected boolean standaloneSimulationZip
```
    Si vrai, le fichier zip n'est pas commun à un ensemble de simulations. Default to true.
  - simulationPrescriptContent
```
protected String simulationPrescriptContent
```
    Simulation prescript.
  - standaloneSimulation
```
protected boolean standaloneSimulation
```
    La simulation doit être lancée seule, sinon les simulations sont indépendantes et peuvent être lancées groupées. Default to true.
  - simulationNumber
```
protected int simulationNumber
```
    Simulation number in non standalone simulation.
  - lastSimulation
```
protected boolean lastSimulation
```
    last simulation in a simulation pool.
- Constructor Detail
  - SimulationItem
```
public SimulationItem(SimulationControl control,
              SimulationParameter param)
```
    Constructor.
    
    Parameters:
    control - le control pour la simulation.
    param - les parametres de simulation (can be null)
- Method Detail
  - getControl
```
public SimulationControl getControl()
```
    Retourne le control pour la simulation.
    
    Returns:
    le control pour la simulation.
  - getParameter
```
public SimulationParameter getParameter()
```
    Retourne les parametres de simulation. Attention, ce ne sont pas forcement les parametres de la simulation en cours, mais ceux ayant servit à la générer.
    
    Returns:
    les parametres de simulation.
  - setSimulationZip
```
public void setSimulationZip(File simulationZip)
```
    Permet de mettre le zip apres construction de l'objet. Cela est util car la construction du zip prend du temps, et on souhaite pouvoir le monitorer et donc il faut que l'item exist pour etre vu dans la console de queue de simulation.
    
    Parameters:
    simulationZip - zip to set
  - getSimulationZip
```
public File getSimulationZip()
```
    Retourne le zip contenant la simulation prete a etre executée.
    
    Returns:
    le zip contenant la simulation prete a etre executee.
  - isStandaloneSimulationZip
```
public boolean isStandaloneSimulationZip()
```
    Returns:
    the standaloneSimulationZip
  - setStandaloneSimulationZip
```
public void setStandaloneSimulationZip(boolean standaloneSimulationZip)
```
    Parameters:
    standaloneSimulationZip - the standaloneSimulationZip to set
  - getSimulationPrescriptContent
```
public String getSimulationPrescriptContent()
```
    Deprecated. use cached simulation parameter instead
    
    Get simulation prescript.
    
    Returns:
    the simulationPrescriptPath
  - setSimulationPrescriptContent
```
public void setSimulationPrescriptContent(String simulationPrescriptContent)
```
    Deprecated. use cached simulation parameter instead
    
    Set simulation prescript.
    
    Parameters:
    simulationPrescriptContent - the simulationPrescriptContent to set
  - isStandaloneSimulation
```
public boolean isStandaloneSimulation()
```
    Returns:
    the standaloneSimulation
  - setStandaloneSimulation
```
public void setStandaloneSimulation(boolean standaloneSimulation)
```
    Parameters:
    standaloneSimulation - the standaloneSimulation to set
  - getSimulationNumber
```
public int getSimulationNumber()
```
    Returns:
    the simulationNumber
  - setSimulationNumber
```
public void setSimulationNumber(int simulationNumber)
```
    Parameters:
    simulationNumber - the simulationNumber to set
  - isLastSimulation
```
public boolean isLastSimulation()
```
    Returns:
    the lastSimulation
  - setLastSimulation
```
public void setLastSimulation(boolean lastSimulation)
```
    Parameters:
    lastSimulation - the lastSimulation to set

Class SimulationItem

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

control

parameter

simulationZip

standaloneSimulationZip

simulationPrescriptContent

standaloneSimulation

simulationNumber

lastSimulation

Constructor Detail

SimulationItem

Method Detail

getControl

getParameter

setSimulationZip

getSimulationZip

isStandaloneSimulationZip

setStandaloneSimulationZip

getSimulationPrescriptContent

setSimulationPrescriptContent

isStandaloneSimulation

setStandaloneSimulation

getSimulationNumber

setSimulationNumber

isLastSimulation

setLastSimulation