SimulationParameter (IsisFish 4.3.1.1 API)

All Known Implementing Classes:

SimulationParameterCache, SimulationParameterImpl
```
public interface SimulationParameter
```
Contains all parameters for one simulation. SimulationParameter must now be loaded from a Properties object. toProperties() method, now return a new Properties object filled with :
- non modified original properties
- new properties if some objects has been instantiated by getters().
Created: 10 janv. 2006 17:03:37
Version:

$Revision: 3969 $ Last update: $Date: 2014-04-17 18:48:13 +0200 (Thu, 17 Apr 2014) $ By : $Author: echatellier $

Author:

poussin, chatellier

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addExtraRules(String... extraRules)` Add extra rules.
`void`	`addRule(Rule rule)` Add new rule to rules list.
`void`	`addSimulationPlan(SimulationPlan plan)` Add new simulation plan.
`List<String>`	`check()` Permet de verifier que tous les parametres sont bon.
`void`	`clearPlans()` Clear plan list.
`void`	`clearRules()` Clear rule list.
`SimulationParameter`	`copy()` A copy instance of SimulationParameter.
`SimulationParameter`	`deepCopy()` Make a deep copy of current parameters.
`void`	`fromProperties(Properties props)` Load properties from file.
`String`	`getDescription()` Get description property.
`List<String>`	`getExportNames()` Get export names list.
`List<String>`	`getExtraRules()` Get extra rules list.
`String`	`getGeneratedPreScript()` Generated pre script is internal script generated by isis.
`String`	`getIsisFishVersion()` Get isis fish version for the simulation.
`String`	`getLibLogLevel()` Get librairies log level.
`org.nuiton.math.matrix.MatrixND`	`getNumberOf(Population pop)`
`int`	`getNumberOfSensitivitySimulation()` Get number of sensitivity simulation.
`int`	`getNumberOfYear()` Get number of year to run to simulate.
`Objective`	`getObjective()` Return used objective.
`Optimization`	`getOptimization()` Return used optimization script.
`Map<Export,Observation>`	`getOptimizationExportsObservations()` Get exports and observations map.
`List<Population>`	`getPopulations()` Get instantiated population list.
`String`	`getPreScript()` Get prescript content.
`RegionStorage`	`getRegion()` Load region corresponding to `getRegionName()`.
`String`	`getRegionName()` Get region name.
`Collection<String>`	`getResultEnabled()` Get enabled result names list.
`List<Rule>`	`getRules()` Get parameters rules list.
`String`	`getScriptLogLevel()` Get script log level.
`SensitivityAnalysis`	`getSensitivityAnalysis()` Get instantiated sensitivity analysis.
`List<SensitivityExport>`	`getSensitivityExport()` Return loaded sensitivity export.
`int`	`getSimulationPlanNumber()` Get simulation number in simulation plan.
`List<SimulationPlan>`	`getSimulationPlans()` Get instantiated simulation plan list.
`String`	`getSimulatorName()` Set simulator name.
`String`	`getSimulLogLevel()` Get simulator log level.
`List<Strategy>`	`getStrategies()` Get instantiated strategies list.
`Map<String,String>`	`getTagValue()` Get tag values.
`boolean`	`getUseCache()` Return if cache should be used.
`boolean`	`getUseOptimization()`
`boolean`	`getUsePreScript()` Get use prescript.
`boolean`	`getUseSimulationPlan()` Get use simulation plans property.
`boolean`	`getUseStatistic()` Return if statistic should be used.
`boolean`	`isIndependentPlan()` Return `true` if simulation is composed of independent plan only.
`boolean`	`isLibDebugLevel()`
`boolean`	`isLibErrorLevel()`
`boolean`	`isLibInfoLevel()`
`boolean`	`isLibWarnLevel()`
`boolean`	`isScriptDebugLevel()`
`boolean`	`isScriptErrorLevel()`
`boolean`	`isScriptInfoLevel()`
`boolean`	`isScriptWarnLevel()`
`boolean`	`isSensitivityAnalysisOnlyKeepFirst()` Get only keep first result policy.
`boolean`	`isSimulDebugLevel()`
`boolean`	`isSimulErrorLevel()`
`boolean`	`isSimulInfoLevel()`
`boolean`	`isSimulWarnLevel()`
`void`	`reloadContextParameters()` Reload parameters du to context change.
`boolean`	`removeRule(Rule rule)` Remove a rule.
`boolean`	`removeSimulationPlan(SimulationPlan plan)` Remove a plan.
`void`	`setDescription(String description)` Set simulation description.
`void`	`setExportNames(List<String> exportNames)` Set export names list.
`void`	`setGeneratedPreScript(String preScript)` Generated pre script is internal script generated by isis.
`void`	`setIsisFishVersion(String isisFishVersion)` Set isis fish Version.
`void`	`setLibLogLevel(String logLevel)` Set lib log level.
`void`	`setNumberOfSensitivitySimulation(int numberOfSensitivitySimulation)` Set number of sensitivity simulation.
`void`	`setNumberOfYear(int numberOfYear)` Set number of year to run to simulate.
`void`	`setObjective(Objective objective)` Set objective.
`void`	`setOptimization(Optimization optimization)` Set simulation optimization.
`void`	`setOptimizationExportsObservations(Map<Export,Observation> exportsObservations)` Set exports and observations map.
`void`	`setPopulations(List<Population> populations)`
`void`	`setPreScript(String preScript)` Set pre script content.
`void`	`setProperty(String key, String value)` Permet d'ajouter des parametres directement à partir de leur representation chaine.
`void`	`setRegionName(String regionName)` Set region name.
`void`	`setResultEnabled(Collection<String> resultEnabled)` Set enabled result names list.
`void`	`setRules(List<Rule> rules)` Set simulation rules.
`void`	`setScriptLogLevel(String logLevel)` Set script log level.
`void`	`setSensitivityAnalysis(SensitivityAnalysis sensitivityAnalysis)`
`void`	`setSensitivityAnalysisOnlyKeepFirst(boolean onlyKeepFirst)` Change only keep first result policy.
`void`	`setSensitivityExport(List<SensitivityExport> sensitivityExport)`
`void`	`setSimulationPlanNumber(int simulationPlanNumber)` Set simulation number in simulation plan.
`void`	`setSimulationPlans(List<SimulationPlan> plans)` Set plans list.
`void`	`setSimulatorName(String simulatorName)` Set simulator name.
`void`	`setSimulLogLevel(String logLevel)` Set simulator log level.
`void`	`setStrategies(List<Strategy> strategies)` Set strategies list.
`void`	`setTagValue(Map<String,String> tagValue)` Set tag values.
`void`	`setUseCache(boolean useCache)` Change use optimization parameter.
`void`	`setUseOptimization(boolean useOptimization)`
`void`	`setUsePreScript(boolean usePreScript)` Set use prescript property
`void`	`setUseSimulationPlan(boolean useSimulationPlan)` Set use simulation plans property.
`void`	`setUseStatistic(boolean useStatistic)` Change use statistic property.
`Properties`	`toProperties()` Permet de convertir l'objet SimulationParameter en un objet Properties Cela permet de le stocker facilement sur le disque.
`String`	`toString()` The toString() method call getters.

- Method Detail
  - check
```
List<String> check()
```
    Permet de verifier que tous les parametres sont bon. Si ce n'est pas le cas la liste retournée contient la liste des messages d'erreur.
    
    Returns:
    la liste d'erreur
  - getIsisFishVersion
```
String getIsisFishVersion()
```
    Get isis fish version for the simulation. Default value to : IsisConfig.getVersion().
    
    Returns:
    the isisFishVersion.
  - setIsisFishVersion
```
void setIsisFishVersion(String isisFishVersion)
```
    Set isis fish Version.
    
    Parameters:
    isisFishVersion - The isisFishVersion to set.
  - getDescription
```
String getDescription()
```
    Get description property. Default value to : "".
    
    Returns:
    Description property.
  - setDescription
```
void setDescription(String description)
```
    Set simulation description.
    
    Parameters:
    description - the description to set.
  - getRegion
```
RegionStorage getRegion()
```
    Load region corresponding to getRegionName().
    
    Returns:
    the region
  - getNumberOf
```
org.nuiton.math.matrix.MatrixND getNumberOf(Population pop)
```
  - getExtraRules
```
List<String> getExtraRules()
```
    Get extra rules list.
    
    Returns:
    Returns the extraRules.
  - addExtraRules
```
void addExtraRules(String... extraRules)
```
    Add extra rules. Appelé par les plan de simulation, pour ajouter des regles supplémentaires dans être integrés au zip.
    
    Parameters:
    extraRules - extra rules to add
  - getPopulations
```
List<Population> getPopulations()
```
    Get instantiated population list.
    
    Returns:
    Returns the populations.
  - setPopulations
```
void setPopulations(List<Population> populations)
```
    Parameters:
    populations - The populations to set.
  - getStrategies
```
List<Strategy> getStrategies()
```
    Get instantiated strategies list. Defaut to : empty array list
    
    Returns:
    Returns the strategies.
  - setStrategies
```
void setStrategies(List<Strategy> strategies)
```
    Set strategies list.
    
    Parameters:
    strategies - strategies list to set
  - addSimulationPlan
```
void addSimulationPlan(SimulationPlan plan)
```
    Add new simulation plan.
    
    Parameters:
    plan - simulation plan to add
  - removeSimulationPlan
```
boolean removeSimulationPlan(SimulationPlan plan)
```
    Remove a plan.
    
    Parameters:
    plan -
    
    Returns:
    true if this list contained the specified element
  - getSimulationPlans
```
List<SimulationPlan> getSimulationPlans()
```
    Get instantiated simulation plan list. Default to empty list.
    
    Returns:
    the plans.
  - setSimulationPlans
```
void setSimulationPlans(List<SimulationPlan> plans)
```
    Set plans list.
    
    Parameters:
    plans - plans to set
  - isIndependentPlan
```
boolean isIndependentPlan()
```
    Return true if simulation is composed of independent plan only.
    
    Returns:
    true if all SimulationPlan are SimulationPlanIndependent
  - clearPlans
```
void clearPlans()
```
    Clear plan list.
  - addRule
```
void addRule(Rule rule)
```
    Add new rule to rules list.
    
    Parameters:
    rule - rule to add
  - removeRule
```
boolean removeRule(Rule rule)
```
    Remove a rule.
    
    Parameters:
    rule - rule to remove
    
    Returns:
    true if this list contained the specified element
  - getRules
```
List<Rule> getRules()
```
    Get parameters rules list.
    
    Returns:
    the rules
  - setRules
```
void setRules(List<Rule> rules)
```
    Set simulation rules.
    
    Parameters:
    rules - rules to set
  - clearRules
```
void clearRules()
```
    Clear rule list.
  - getUseCache
```
boolean getUseCache()
```
    Return if cache should be used. Default to : true.
    
    Returns:
    use cache
  - setUseCache
```
void setUseCache(boolean useCache)
```
    Change use optimization parameter.
    
    Parameters:
    useCache - use cache to set
  - getUseStatistic
```
boolean getUseStatistic()
```
    Return if statistic should be used. Default to false;
    
    Returns:
    use statistic
  - setUseStatistic
```
void setUseStatistic(boolean useStatistic)
```
    Change use statistic property.
    
    Parameters:
    useStatistic - use statistic to set
  - getExportNames
```
List<String> getExportNames()
```
    Get export names list.
    
    Returns:
    export names list
  - setExportNames
```
void setExportNames(List<String> exportNames)
```
    Set export names list.
    
    Parameters:
    exportNames - export names list to set
  - getNumberOfSensitivitySimulation
```
int getNumberOfSensitivitySimulation()
```
    Get number of sensitivity simulation. Default value to : -1
    
    Returns:
    the numberOfSensitivitySimulation
  - setNumberOfSensitivitySimulation
```
void setNumberOfSensitivitySimulation(int numberOfSensitivitySimulation)
```
    Set number of sensitivity simulation.
    
    Parameters:
    numberOfSensitivitySimulation - number of sensitivity simulation to set
  - getSensitivityAnalysis
```
SensitivityAnalysis getSensitivityAnalysis()
```
    Get instantiated sensitivity analysis. Default to : null.
    
    Returns:
    the sensitivityAnalysis
  - setSensitivityAnalysis
```
void setSensitivityAnalysis(SensitivityAnalysis sensitivityAnalysis)
```
    Parameters:
    sensitivityAnalysis - the sensitivityAnalysis to set
  - isSensitivityAnalysisOnlyKeepFirst
```
boolean isSensitivityAnalysisOnlyKeepFirst()
```
    Get only keep first result policy.
    
    Returns:
    only keep first result policy
    Since:
    
    4.1.1.0
  - setSensitivityAnalysisOnlyKeepFirst
```
void setSensitivityAnalysisOnlyKeepFirst(boolean onlyKeepFirst)
```
    Change only keep first result policy.
    
    Parameters:
    onlyKeepFirst - only keep first result policy
    Since:
    
    4.1.1.0
  - getSensitivityExport
```
List<SensitivityExport> getSensitivityExport()
```
    Return loaded sensitivity export. If exports are null or empty, try to load it from last ready parameters.
    
    Returns:
    the sensitivityExportNames
  - setSensitivityExport
```
void setSensitivityExport(List<SensitivityExport> sensitivityExport)
```
    Parameters:
    sensitivityExport - the sensitivityExportNames to set
  - getUseOptimization
```
boolean getUseOptimization()
```
  - setUseOptimization
```
void setUseOptimization(boolean useOptimization)
```
  - getOptimization
```
Optimization getOptimization()
```
    Return used optimization script.
    
    Returns:
    optimization method
  - setOptimization
```
void setOptimization(Optimization optimization)
```
    Set simulation optimization.
    
    Parameters:
    optimization - optimization
  - getObjective
```
Objective getObjective()
```
    Return used objective.
    
    Returns:
  - setObjective
```
void setObjective(Objective objective)
```
    Set objective.
    
    Parameters:
    objective - objective
  - getOptimizationExportsObservations
```
Map<Export,Observation> getOptimizationExportsObservations()
```
    Get exports and observations map.
    
    Returns:
    exports and observations map
  - setOptimizationExportsObservations
```
void setOptimizationExportsObservations(Map<Export,Observation> exportsObservations)
```
    Set exports and observations map.
    
    Parameters:
    exportsObservations - exports and observations map
  - getUseSimulationPlan
```
boolean getUseSimulationPlan()
```
    Get use simulation plans property.
    
    Returns:
    use simulation plan.
  - setUseSimulationPlan
```
void setUseSimulationPlan(boolean useSimulationPlan)
```
    Set use simulation plans property.
    
    Parameters:
    useSimulationPlan - use simulation plan to set
  - getSimulationPlanNumber
```
int getSimulationPlanNumber()
```
    Get simulation number in simulation plan.
    
    Returns:
    simulation number in simulation plan
  - setSimulationPlanNumber
```
void setSimulationPlanNumber(int simulationPlanNumber)
```
    Set simulation number in simulation plan.
    
    Parameters:
    simulationPlanNumber - simulation plan number to set
  - getNumberOfYear
```
int getNumberOfYear()
```
    Get number of year to run to simulate.
    
    Returns:
    number of year
  - setNumberOfYear
```
void setNumberOfYear(int numberOfYear)
```
    Set number of year to run to simulate.
    
    Parameters:
    numberOfYear - number of year to set
  - getUsePreScript
```
boolean getUsePreScript()
```
    Get use prescript. Default to false.
    
    Returns:
    Returns the usePreScript.
  - setUsePreScript
```
void setUsePreScript(boolean usePreScript)
```
    Set use prescript property
    
    Parameters:
    usePreScript - use preScript to set
  - getPreScript
```
String getPreScript()
```
    Get prescript content.
    
    Returns:
    preScript content
  - setPreScript
```
void setPreScript(String preScript)
```
    Set pre script content.
    
    Parameters:
    preScript - prescript content
  - getGeneratedPreScript
```
String getGeneratedPreScript()
```
    Generated pre script is internal script generated by isis. This script must be executed before user defined preScript.
    
    Returns:
    generated pre script
  - setGeneratedPreScript
```
void setGeneratedPreScript(String preScript)
```
    Generated pre script is internal script generated by isis. This script must be executed before user defined preScript
    
    Parameters:
    preScript - prescript content
  - getRegionName
```
String getRegionName()
```
    Get region name.
    
    Returns:
    region name
  - setRegionName
```
void setRegionName(String regionName)
```
    Set region name.
    
    Parameters:
    regionName - region name to set
  - getSimulatorName
```
String getSimulatorName()
```
    Set simulator name.
    
    Returns:
    simulator name.
  - setSimulatorName
```
void setSimulatorName(String simulatorName)
```
    Set simulator name.
    
    Parameters:
    simulatorName - simulator name to set
  - getResultEnabled
```
Collection<String> getResultEnabled()
```
    Get enabled result names list.
    
    Returns:
    enabled result names list
  - setResultEnabled
```
void setResultEnabled(Collection<String> resultEnabled)
```
    Set enabled result names list.
    
    Parameters:
    resultEnabled - enabled result names list
  - getTagValue
```
Map<String,String> getTagValue()
```
    Get tag values. Default to empty map
    
    Returns:
    Returns the tagValue.
  - setTagValue
```
void setTagValue(Map<String,String> tagValue)
```
    Set tag values.
    
    Parameters:
    tagValue - tagValues to set.
  - getSimulLogLevel
```
String getSimulLogLevel()
```
    Get simulator log level. Default to "info".
    
    Returns:
    simualtor log level
  - setSimulLogLevel
```
void setSimulLogLevel(String logLevel)
```
    Set simulator log level.
    
    Parameters:
    logLevel - simulator log level
  - getScriptLogLevel
```
String getScriptLogLevel()
```
    Get script log level. Default to "info".
    
    Returns:
    script log level
  - setScriptLogLevel
```
void setScriptLogLevel(String logLevel)
```
    Set script log level.
    
    Parameters:
    logLevel - script log level
  - getLibLogLevel
```
String getLibLogLevel()
```
    Get librairies log level. Default to "error".
    
    Returns:
    librairies log level
  - setLibLogLevel
```
void setLibLogLevel(String logLevel)
```
    Set lib log level.
    
    Parameters:
    logLevel -
  - isSimulErrorLevel
```
boolean isSimulErrorLevel()
```
  - isSimulWarnLevel
```
boolean isSimulWarnLevel()
```
  - isSimulInfoLevel
```
boolean isSimulInfoLevel()
```
  - isSimulDebugLevel
```
boolean isSimulDebugLevel()
```
  - isScriptErrorLevel
```
boolean isScriptErrorLevel()
```
  - isScriptWarnLevel
```
boolean isScriptWarnLevel()
```
  - isScriptInfoLevel
```
boolean isScriptInfoLevel()
```
  - isScriptDebugLevel
```
boolean isScriptDebugLevel()
```
  - isLibErrorLevel
```
boolean isLibErrorLevel()
```
  - isLibWarnLevel
```
boolean isLibWarnLevel()
```
  - isLibInfoLevel
```
boolean isLibInfoLevel()
```
  - isLibDebugLevel
```
boolean isLibDebugLevel()
```
  - setProperty
```
void setProperty(String key,
               String value)
```
    Permet d'ajouter des parametres directement à partir de leur representation chaine. A ne pas utiliser normalement, sert uniquement dans les prescripts des simulation des AS.
    
    Parameters:
    key - key
    value - value
    Since:
    
    3.4.0.0
  - copy
```
SimulationParameter copy()
```
    A copy instance of SimulationParameter. Warning, this is not a deep copy, already instancied objects are not duplicated.
    
    Returns:
    a copy of this instance
  - deepCopy
```
SimulationParameter deepCopy()
```
    Make a deep copy of current parameters. Bump all current parameters to properties and make a new one with those propeties.
    
    Returns:
    new parameters instance
  - toString
```
String toString()
```
    The toString() method call getters. So make instances of rules/export/plans...
    
    Overrides:
    
    toString in class Object
  - toProperties
```
Properties toProperties()
```
    Permet de convertir l'objet SimulationParameter en un objet Properties Cela permet de le stocker facilement sur le disque. Recopie certaines proprietes si elle n'ont pas été instancié :
    - strategies
    - rules
    - simulationplans
    - sensitivityexports
    - sensitivityanalysis
    Returns:
    L'objet Properties representant les parametres
    See Also:
    fromProperties(Properties)
  - fromProperties
```
void fromProperties(Properties props)
```
    Load properties from file.
    
    Parameters:
    props - property to read
  - reloadContextParameters
```
void reloadContextParameters()
                             throws org.nuiton.topia.TopiaException
```
    Reload parameters du to context change. ie : in simulators when rollbacking transaction Actually : reload rules parameters
    
    Throws:
    
    org.nuiton.topia.TopiaException

Interface SimulationParameter

Method Summary

Method Detail

check

getIsisFishVersion

setIsisFishVersion

getDescription

setDescription

getRegion

getNumberOf

getExtraRules

addExtraRules

getPopulations

setPopulations

getStrategies

setStrategies

addSimulationPlan

removeSimulationPlan

getSimulationPlans

setSimulationPlans

isIndependentPlan

clearPlans

addRule

removeRule

getRules

setRules

clearRules

getUseCache

setUseCache

getUseStatistic

setUseStatistic

getExportNames

setExportNames

getNumberOfSensitivitySimulation

setNumberOfSensitivitySimulation

getSensitivityAnalysis

setSensitivityAnalysis

isSensitivityAnalysisOnlyKeepFirst

setSensitivityAnalysisOnlyKeepFirst

getSensitivityExport

setSensitivityExport

getUseOptimization

setUseOptimization

getOptimization

setOptimization

getObjective

setObjective

getOptimizationExportsObservations

setOptimizationExportsObservations

getUseSimulationPlan

setUseSimulationPlan

getSimulationPlanNumber

setSimulationPlanNumber

getNumberOfYear

setNumberOfYear

getUsePreScript

setUsePreScript

getPreScript

setPreScript

getGeneratedPreScript

setGeneratedPreScript

getRegionName

setRegionName

getSimulatorName

setSimulatorName

getResultEnabled

setResultEnabled

getTagValue

setTagValue

getSimulLogLevel

setSimulLogLevel

getScriptLogLevel

setScriptLogLevel

getLibLogLevel

setLibLogLevel

isSimulErrorLevel

isSimulWarnLevel

isSimulInfoLevel

isSimulDebugLevel

isScriptErrorLevel