Package fr.ifremer.isisfish.simulator

Class SimulationParameterImpl

java.lang.Object

fr.ifremer.isisfish.simulator.SimulationParameterImpl

All Implemented Interfaces:

SimulationParameter

public class SimulationParameterImpl
extends Object
implements SimulationParameter

Real SimulationParameter implementation.

Version:

$Revision$ Last update : $Date$ By : $Author$

Author:

chatellier

Field Summary

Fields

Modifier and Type	Field	Description
protected String	description	Description de la simulation.
protected List<String>	exportNames	Ma liste des exports automatique a faire en fin de simulation.
protected List<String>	extraRules	La liste des regles potentiellement ajoutée par les plans de simulation.
protected String	generatedPreScript	Le script de pre simulation defini par Isis
protected String	isisFishVersion	Isis-fish version that permit to do the simulation.
protected String	libLogLevel	Le niveau de log des librairies à utiliser pendant la simulation.
protected Integer	numberOfMonths	Nombre de mois sur lequel on souhaite simuler.
protected Integer	numberOfSensitivitySimulation	Nombre de simulation constituant l'analyse de sensibilité.
protected Map<Population,org.nuiton.math.matrix.MatrixND>	numbers	Les effectifs initiaux des différentes population.
protected Objective	objective	Fonction d'objectif.
protected Optimization	optimization	Script d'optimisation.
protected Map<ExportInfo,Observation>	optimizationExportsObservations	Exports et observations (optimisation).
protected Integer	optimizationGeneration	If this simulation is generated by Optimization, generation number
protected Integer	optimizationGenerationIndividual	If this simulation is generated by Optimization, individual number in generation
protected List<Population>	populations	La liste des populations a utiliser pour la simulation.
protected String	preScript	Le script de pre simulation a utiliser.
protected Properties	propertiesParameters	Remember last read properties.
protected RegionStorage	region	La region corespondant au parametre regionName.
protected String	regionName	Nom de la region sur lequel on simule.
protected Boolean	resultDeleteAfterExport	Parametre utilisé pour supprimer les résultats à la fin d'une simulation après les exports.
protected Collection<String>	resultEnabled	La liste des resultats qui nous interesse.
protected List<Rule>	rules	La liste des regles de gestions a utiliser pour la simulation.
protected String	scriptLogLevel	Le niveau de log des scripts à utiliser pendant la simulation.
protected SensitivityAnalysis	sensitivityAnalysis	Script utilisé pour les analyses de sensibilités.
protected Boolean	sensitivityAnalysisOnlyKeepFirst	Dans une analyze de sensibilite, conserver les résultats de toutes les simulations est inutile, seule les résultats de la premières sont nécéssaires.
protected List<SensitivityExport>	sensitivityExports	ExportInfo utilisés pour les analyses de sensibilités.
protected Integer	simulationPlanNumber	Le numero de sequence de la liste des plans de simulation.
protected List<SimulationPlan>	simulationPlans	La liste des plans a utiliser pour la simulation.
protected String	simulatorName	Le nom de l'objet script a utiliser pour faire la simulation.
protected String	simulLogLevel	Le niveau de log du simulateur à utiliser pendant la simulation.
protected List<Strategy>	strategies	La liste des strategies a utiliser pour la simulation.
protected Map<String,String>	tagValue	Autre parametre defini par l'utilisateur.
protected Boolean	useCache	Utilisation ou non du cache.
protected Boolean	useComputeResult	Utilisation ou non du timing du calcul des resultats.
protected Boolean	useOptimization	Utilisation d'un script de simulation.
protected Boolean	usePreScript	Utilisation du script de pre simulation.
protected Boolean	useSimulationPlan	Utilisation du plan de simulation.
protected Boolean	useStatistic	Utilisation ou non des statistiques.

Constructor Summary

Constructors

Constructor	Description
SimulationParameterImpl()

Method Summary

Modifier and Type	Method	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	fixReloadContext(boolean sensitivityContext)	Remove all parameters non relative to given context.
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	getNumberOfMonths()	Get number of year to run to simulate.
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<ExportInfo,Observation>	getOptimizationExportsObservations()	Get exports and observations map.
int	getOptimizationGeneration()	If this simulation is generated by Optimization, return generation number
int	getOptimizationGenerationIndividual()	If this simulation is generated by Optimization, return individual number in generation
List<Population>	getPopulations()	Get instantiated population list.
String	getPreScript()	Get prescript content.
RegionStorage	getRegion()	Load region corresponding to SimulationParameter.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	getUseComputeResult()
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	isResultDeleteAfterExport()	Delete result after export policy.
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.
void	reloadRegionChangeParameter()	Remove from 'cached' parameter data referring to another region.
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	setNumberOfMonths(int numberOfMonths)	Set number of months to run to simulate.
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<ExportInfo,Observation> optimizationExportsObservations)	Set exports and observations map.
void	setOptimizationGeneration(int optimizationGeneration)	If this simulation is generated by Optimization, set generation number
void	setOptimizationGenerationIndividual(int optimizationGenerationIndividual)	If this simulation is generated by Optimization, set individual number in generation
void	setPopulations(List<Population> populations)
void	setPreScript(String preScript)	Set pre script content.
void	setProperties(Properties props)	Set multiples properties.
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	setResultDeleteAfterExport(boolean resultDeleteAfterExport)	Delete result after export policy.
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	setUseComputeResult(boolean useComputeResult)
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.

Methods inherited from class java.lang.Object

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

Field Details

propertiesParameters

protected Properties propertiesParameters

Remember last read properties.

isisFishVersion

protected String isisFishVersion

Isis-fish version that permit to do the simulation. Must be set just before simulation by simulator.

description

protected String description

Description de la simulation.

regionName

protected String regionName

Nom de la region sur lequel on simule.

numberOfMonths

protected Integer numberOfMonths

Nombre de mois sur lequel on souhaite simuler.

simulatorName

protected String simulatorName

Le nom de l'objet script a utiliser pour faire la simulation.

useCache

protected Boolean useCache

Utilisation ou non du cache.

useStatistic

protected Boolean useStatistic

Utilisation ou non des statistiques.

useComputeResult

protected Boolean useComputeResult

Utilisation ou non du timing du calcul des resultats.

strategies

protected List<Strategy> strategies

La liste des strategies a utiliser pour la simulation.

populations

protected List<Population> populations

La liste des populations a utiliser pour la simulation.

numbers

protected Map<Population,org.nuiton.math.matrix.MatrixND> numbers

Les effectifs initiaux des différentes population.

rules

protected List<Rule> rules

La liste des regles de gestions a utiliser pour la simulation.

extraRules

protected List<String> extraRules

La liste des regles potentiellement ajoutée par les plans de simulation.

simulationPlans

protected List<SimulationPlan> simulationPlans

La liste des plans a utiliser pour la simulation.

exportNames

protected List<String> exportNames

Ma liste des exports automatique a faire en fin de simulation.

usePreScript

protected Boolean usePreScript

Utilisation du script de pre simulation.

preScript

protected String preScript

Le script de pre simulation a utiliser.

generatedPreScript

protected String generatedPreScript

Le script de pre simulation defini par Isis

useSimulationPlan

protected Boolean useSimulationPlan

Utilisation du plan de simulation.

simulationPlanNumber

protected Integer simulationPlanNumber

Le numero de sequence de la liste des plans de simulation. Le premier élement du plan doit etre 0. Si la simulation ne fait pas partie d'un plan la valeur est -1.

sensitivityExports

protected List<SensitivityExport> sensitivityExports

ExportInfo utilisés pour les analyses de sensibilités.

numberOfSensitivitySimulation

protected Integer numberOfSensitivitySimulation

Nombre de simulation constituant l'analyse de sensibilité. FIXME ce parametre ne devrait pas ce trouver à cet endroit. Ce n'est pas un parametres, mais une infos de simulation. Cela permet de savoir combien de simulation il y a au total pour savoir quand elle sont terminées.

sensitivityAnalysisOnlyKeepFirst

protected Boolean sensitivityAnalysisOnlyKeepFirst

Dans une analyze de sensibilite, conserver les résultats de toutes les simulations est inutile, seule les résultats de la premières sont nécéssaires. Les resultats peuvent être supprimés après les export de données.

resultDeleteAfterExport

protected Boolean resultDeleteAfterExport

Parametre utilisé pour supprimer les résultats à la fin d'une simulation après les exports.

sensitivityAnalysis

protected SensitivityAnalysis sensitivityAnalysis

Script utilisé pour les analyses de sensibilités.

useOptimization

protected Boolean useOptimization

Utilisation d'un script de simulation.

optimization

protected Optimization optimization

Script d'optimisation.

objective

protected Objective objective

Fonction d'objectif.

optimizationExportsObservations

protected Map<ExportInfo,Observation> optimizationExportsObservations

Exports et observations (optimisation).

optimizationGeneration

protected Integer optimizationGeneration

If this simulation is generated by Optimization, generation number

optimizationGenerationIndividual

protected Integer optimizationGenerationIndividual

If this simulation is generated by Optimization, individual number in generation

resultEnabled

protected Collection<String> resultEnabled

La liste des resultats qui nous interesse.

tagValue

protected Map<String,String> tagValue

Autre parametre defini par l'utilisateur.

simulLogLevel

protected String simulLogLevel

Le niveau de log du simulateur à utiliser pendant la simulation. Par defaut info.

scriptLogLevel

protected String scriptLogLevel

Le niveau de log des scripts à utiliser pendant la simulation. Par defaut info.

libLogLevel

protected String libLogLevel

Le niveau de log des librairies à utiliser pendant la simulation. Par defaut error.

region

protected transient RegionStorage region

La region corespondant au parametre regionName.

Constructor Details

SimulationParameterImpl

public SimulationParameterImpl()

Method Details

check

public List<String> check()

Description copied from interface: SimulationParameter

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.

Specified by:

check in interface SimulationParameter

Returns:

la liste d'erreur

getIsisFishVersion

public String getIsisFishVersion()

Description copied from interface: SimulationParameter

Get isis fish version for the simulation. Default value to : IsisConfig.getVersion().

Specified by:

getIsisFishVersion in interface SimulationParameter

Returns:

the isisFishVersion.

setIsisFishVersion

public void setIsisFishVersion(String isisFishVersion)

Description copied from interface: SimulationParameter

Set isis fish Version.

Specified by:

setIsisFishVersion in interface SimulationParameter

Parameters:

isisFishVersion - The isisFishVersion to set.

getDescription

public String getDescription()

Description copied from interface: SimulationParameter

Get description property. Default value to : "".

Specified by:

getDescription in interface SimulationParameter

Returns:

Description property.

setDescription

public void setDescription(String description)

Description copied from interface: SimulationParameter

Set simulation description.

Specified by:

setDescription in interface SimulationParameter

Parameters:

description - the description to set.

getRegion

public RegionStorage getRegion()

Description copied from interface: SimulationParameter

Load region corresponding to SimulationParameter.getRegionName().

Specified by:

getRegion in interface SimulationParameter

Returns:

the region

getNumberOf

public org.nuiton.math.matrix.MatrixND getNumberOf(Population pop)

Specified by:

getNumberOf in interface SimulationParameter

getExtraRules

public List<String> getExtraRules()

Description copied from interface: SimulationParameter

Get extra rules list.

Specified by:

getExtraRules in interface SimulationParameter

Returns:

Returns the extraRules.

addExtraRules

public void addExtraRules(String... extraRules)

Description copied from interface: SimulationParameter

Add extra rules. Appelé par les plan de simulation, pour ajouter des regles supplémentaires dans être integrés au zip.

Specified by:

addExtraRules in interface SimulationParameter

Parameters:

extraRules - extra rules to add

getPopulations

public List<Population> getPopulations()

Description copied from interface: SimulationParameter

Get instantiated population list.

Specified by:

getPopulations in interface SimulationParameter

Returns:

Returns the populations.

setPopulations

public void setPopulations(List<Population> populations)

Specified by:

setPopulations in interface SimulationParameter

Parameters:

populations - The populations to set.

getStrategies

public List<Strategy> getStrategies()

Description copied from interface: SimulationParameter

Get instantiated strategies list. Defaut to : empty array list

Specified by:

getStrategies in interface SimulationParameter

Returns:

Returns the strategies.

setStrategies

public void setStrategies(List<Strategy> strategies)

Description copied from interface: SimulationParameter

Set strategies list.

Specified by:

setStrategies in interface SimulationParameter

Parameters:

strategies - strategies list to set

addSimulationPlan

public void addSimulationPlan(SimulationPlan plan)

Description copied from interface: SimulationParameter

Add new simulation plan.

Specified by:

addSimulationPlan in interface SimulationParameter

Parameters:

plan - simulation plan to add

removeSimulationPlan

public boolean removeSimulationPlan(SimulationPlan plan)

Description copied from interface: SimulationParameter

Remove a plan.

Specified by:

removeSimulationPlan in interface SimulationParameter

Returns:

true if this list contained the specified element

getSimulationPlans

public List<SimulationPlan> getSimulationPlans()

Description copied from interface: SimulationParameter

Get instantiated simulation plan list. Default to empty list.

Specified by:

getSimulationPlans in interface SimulationParameter

Returns:

the plans.

setSimulationPlans

public void setSimulationPlans(List<SimulationPlan> plans)

Description copied from interface: SimulationParameter

Set plans list.

Specified by:

setSimulationPlans in interface SimulationParameter

Parameters:

plans - plans to set

isIndependentPlan

public boolean isIndependentPlan()

Description copied from interface: SimulationParameter

Return true if simulation is composed of independent plan only.

Specified by:

isIndependentPlan in interface SimulationParameter

Returns:

true if all SimulationPlan are SimulationPlanIndependent

clearPlans

public void clearPlans()

Description copied from interface: SimulationParameter

Clear plan list.

Specified by:

clearPlans in interface SimulationParameter

addRule

public void addRule(Rule rule)

Description copied from interface: SimulationParameter

Add new rule to rules list.

Specified by:

addRule in interface SimulationParameter

Parameters:

rule - rule to add

removeRule

public boolean removeRule(Rule rule)

Description copied from interface: SimulationParameter

Remove a rule.

Specified by:

removeRule in interface SimulationParameter

Parameters:

rule - rule to remove

Returns:

true if this list contained the specified element

getRules

public List<Rule> getRules()

Description copied from interface: SimulationParameter

Get parameters rules list.

Specified by:

getRules in interface SimulationParameter

Returns:

the rules

setRules

public void setRules(List<Rule> rules)

Description copied from interface: SimulationParameter

Set simulation rules.

Specified by:

setRules in interface SimulationParameter

Parameters:

rules - rules to set

clearRules

public void clearRules()

Description copied from interface: SimulationParameter

Clear rule list.

Specified by:

clearRules in interface SimulationParameter

getUseCache

public boolean getUseCache()

Description copied from interface: SimulationParameter

Return if cache should be used. Default to : true.

Specified by:

getUseCache in interface SimulationParameter

Returns:

use cache

setUseCache

public void setUseCache(boolean useCache)

Description copied from interface: SimulationParameter

Change use optimization parameter.

Specified by:

setUseCache in interface SimulationParameter

Parameters:

useCache - use cache to set

getUseStatistic

public boolean getUseStatistic()

Description copied from interface: SimulationParameter

Return if statistic should be used. Default to false;

Specified by:

getUseStatistic in interface SimulationParameter

Returns:

use statistic

setUseStatistic

public void setUseStatistic(boolean useStatistic)

Description copied from interface: SimulationParameter

Change use statistic property.

Specified by:

setUseStatistic in interface SimulationParameter

Parameters:

useStatistic - use statistic to set

getUseComputeResult

public boolean getUseComputeResult()

Specified by:

getUseComputeResult in interface SimulationParameter

setUseComputeResult

public void setUseComputeResult(boolean useComputeResult)

Specified by:

setUseComputeResult in interface SimulationParameter

getExportNames

public List<String> getExportNames()

Description copied from interface: SimulationParameter

Get export names list.

Specified by:

getExportNames in interface SimulationParameter

Returns:

export names list

setExportNames

public void setExportNames(List<String> exportNames)

Description copied from interface: SimulationParameter

Set export names list.

Specified by:

setExportNames in interface SimulationParameter

Parameters:

exportNames - export names list to set

getNumberOfSensitivitySimulation

public int getNumberOfSensitivitySimulation()

Description copied from interface: SimulationParameter

Get number of sensitivity simulation. Default value to : -1

Specified by:

getNumberOfSensitivitySimulation in interface SimulationParameter

Returns:

the numberOfSensitivitySimulation

setNumberOfSensitivitySimulation

public void setNumberOfSensitivitySimulation(int numberOfSensitivitySimulation)

Description copied from interface: SimulationParameter

Set number of sensitivity simulation.

Specified by:

setNumberOfSensitivitySimulation in interface SimulationParameter

Parameters:

numberOfSensitivitySimulation - number of sensitivity simulation to set

getSensitivityAnalysis

public SensitivityAnalysis getSensitivityAnalysis()

Description copied from interface: SimulationParameter

Get instantiated sensitivity analysis. Default to : null.

Specified by:

getSensitivityAnalysis in interface SimulationParameter

Returns:

the sensitivityAnalysis

setSensitivityAnalysis

public void setSensitivityAnalysis(SensitivityAnalysis sensitivityAnalysis)

Specified by:

setSensitivityAnalysis in interface SimulationParameter

Parameters:

sensitivityAnalysis - the sensitivityAnalysis to set

getSensitivityExport

public List<SensitivityExport> getSensitivityExport()

Description copied from interface: SimulationParameter

Return loaded sensitivity export. If exports are null or empty, try to load it from last ready parameters.

Specified by:

getSensitivityExport in interface SimulationParameter

Returns:

the sensitivityExportNames

setSensitivityExport

public void setSensitivityExport(List<SensitivityExport> sensitivityExport)

Specified by:

setSensitivityExport in interface SimulationParameter

Parameters:

sensitivityExport - the sensitivityExportNames to set

getOptimization

public Optimization getOptimization()

Description copied from interface: SimulationParameter

Return used optimization script.

Specified by:

getOptimization in interface SimulationParameter

Returns:

optimization method

getUseOptimization

public boolean getUseOptimization()

Specified by:

getUseOptimization in interface SimulationParameter

setUseOptimization

public void setUseOptimization(boolean useOptimization)

Specified by:

setUseOptimization in interface SimulationParameter

setOptimization

public void setOptimization(Optimization optimization)

Description copied from interface: SimulationParameter

Set simulation optimization.

Specified by:

setOptimization in interface SimulationParameter

Parameters:

optimization - optimization

getObjective

public Objective getObjective()

Description copied from interface: SimulationParameter

Return used objective.

Specified by:

getObjective in interface SimulationParameter

Returns:

setObjective

public void setObjective(Objective objective)

Description copied from interface: SimulationParameter

Set objective.

Specified by:

setObjective in interface SimulationParameter

Parameters:

objective - objective

getOptimizationExportsObservations

public Map<ExportInfo,Observation> getOptimizationExportsObservations()

Description copied from interface: SimulationParameter

Get exports and observations map.

Specified by:

getOptimizationExportsObservations in interface SimulationParameter

Returns:

exports and observations map

setOptimizationExportsObservations

public void setOptimizationExportsObservations(Map<ExportInfo,Observation> optimizationExportsObservations)

Description copied from interface: SimulationParameter

Set exports and observations map.

Specified by:

setOptimizationExportsObservations in interface SimulationParameter

Parameters:

optimizationExportsObservations - exports and observations map

getUseSimulationPlan

public boolean getUseSimulationPlan()

Description copied from interface: SimulationParameter

Get use simulation plans property.

Specified by:

getUseSimulationPlan in interface SimulationParameter

Returns:

use simulation plan.

setUseSimulationPlan

public void setUseSimulationPlan(boolean useSimulationPlan)

Description copied from interface: SimulationParameter

Set use simulation plans property.

Specified by:

setUseSimulationPlan in interface SimulationParameter

Parameters:

useSimulationPlan - use simulation plan to set

getSimulationPlanNumber

public int getSimulationPlanNumber()

Description copied from interface: SimulationParameter

Get simulation number in simulation plan.

Specified by:

getSimulationPlanNumber in interface SimulationParameter

Returns:

simulation number in simulation plan

setSimulationPlanNumber

public void setSimulationPlanNumber(int simulationPlanNumber)

Description copied from interface: SimulationParameter

Set simulation number in simulation plan.

Specified by:

setSimulationPlanNumber in interface SimulationParameter

Parameters:

simulationPlanNumber - simulation plan number to set

getOptimizationGeneration

public int getOptimizationGeneration()

If this simulation is generated by Optimization, return generation number

Specified by:

getOptimizationGeneration in interface SimulationParameter

setOptimizationGeneration

public void setOptimizationGeneration(int optimizationGeneration)

If this simulation is generated by Optimization, set generation number

Specified by:

setOptimizationGeneration in interface SimulationParameter

getOptimizationGenerationIndividual

public int getOptimizationGenerationIndividual()

If this simulation is generated by Optimization, return individual number in generation

Specified by:

getOptimizationGenerationIndividual in interface SimulationParameter

setOptimizationGenerationIndividual

public void setOptimizationGenerationIndividual(int optimizationGenerationIndividual)

If this simulation is generated by Optimization, set individual number in generation

Specified by:

setOptimizationGenerationIndividual in interface SimulationParameter

isSensitivityAnalysisOnlyKeepFirst

public boolean isSensitivityAnalysisOnlyKeepFirst()

Description copied from interface: SimulationParameter

Get only keep first result policy.

Specified by:

isSensitivityAnalysisOnlyKeepFirst in interface SimulationParameter

Returns:

only keep first result policy

setSensitivityAnalysisOnlyKeepFirst

public void setSensitivityAnalysisOnlyKeepFirst(boolean onlyKeepFirst)

Description copied from interface: SimulationParameter

Change only keep first result policy.

Specified by:

setSensitivityAnalysisOnlyKeepFirst in interface SimulationParameter

Parameters:

onlyKeepFirst - only keep first result policy

isResultDeleteAfterExport

public boolean isResultDeleteAfterExport()

Description copied from interface: SimulationParameter

Delete result after export policy.

Specified by:

isResultDeleteAfterExport in interface SimulationParameter

setResultDeleteAfterExport

public void setResultDeleteAfterExport(boolean resultDeleteAfterExport)

Description copied from interface: SimulationParameter

Delete result after export policy.

Specified by:

setResultDeleteAfterExport in interface SimulationParameter

Parameters:

resultDeleteAfterExport - delete result after export policy

getNumberOfYear

public int getNumberOfYear()

Description copied from interface: SimulationParameter

Get number of year to run to simulate.

Specified by:

getNumberOfYear in interface SimulationParameter

Returns:

number of year

setNumberOfYear

public void setNumberOfYear(int numberOfYear)

Description copied from interface: SimulationParameter

Set number of year to run to simulate.

Specified by:

setNumberOfYear in interface SimulationParameter

Parameters:

numberOfYear - number of year to set

getNumberOfMonths

public int getNumberOfMonths()

Description copied from interface: SimulationParameter

Get number of year to run to simulate.

Specified by:

getNumberOfMonths in interface SimulationParameter

Returns:

number of year

setNumberOfMonths

public void setNumberOfMonths(int numberOfMonths)

Description copied from interface: SimulationParameter

Set number of months to run to simulate.

Specified by:

setNumberOfMonths in interface SimulationParameter

Parameters:

numberOfMonths - number of months to set

getUsePreScript

public boolean getUsePreScript()

Description copied from interface: SimulationParameter

Get use prescript. Default to false.

Specified by:

getUsePreScript in interface SimulationParameter

Returns:

Returns the usePreScript.

setUsePreScript

public void setUsePreScript(boolean usePreScript)

Description copied from interface: SimulationParameter

Set use prescript property

Specified by:

setUsePreScript in interface SimulationParameter

Parameters:

usePreScript - use preScript to set

getPreScript

public String getPreScript()

Description copied from interface: SimulationParameter

Get prescript content.

Specified by:

getPreScript in interface SimulationParameter

Returns:

preScript content

setPreScript

public void setPreScript(String preScript)

Description copied from interface: SimulationParameter

Set pre script content.

Specified by:

setPreScript in interface SimulationParameter

Parameters:

preScript - prescript content

getGeneratedPreScript

public String getGeneratedPreScript()

Description copied from interface: SimulationParameter

Generated pre script is internal script generated by isis. This script must be executed before user defined preScript.

Specified by:

getGeneratedPreScript in interface SimulationParameter

Returns:

generated pre script

setGeneratedPreScript

public void setGeneratedPreScript(String preScript)

Description copied from interface: SimulationParameter

Generated pre script is internal script generated by isis. This script must be executed before user defined preScript

Specified by:

setGeneratedPreScript in interface SimulationParameter

Parameters:

preScript - prescript content

getRegionName

public String getRegionName()

Description copied from interface: SimulationParameter

Get region name.

Specified by:

getRegionName in interface SimulationParameter

Returns:

region name

setRegionName

public void setRegionName(String regionName)

Description copied from interface: SimulationParameter

Set region name.

Specified by:

setRegionName in interface SimulationParameter

Parameters:

regionName - region name to set

getSimulatorName

public String getSimulatorName()

Description copied from interface: SimulationParameter

Set simulator name.

Specified by:

getSimulatorName in interface SimulationParameter

Returns:

simulator name.

setSimulatorName

public void setSimulatorName(String simulatorName)

Description copied from interface: SimulationParameter

Set simulator name.

Specified by:

setSimulatorName in interface SimulationParameter

Parameters:

simulatorName - simulator name to set

getResultEnabled

public Collection<String> getResultEnabled()

Description copied from interface: SimulationParameter

Get enabled result names list.

Specified by:

getResultEnabled in interface SimulationParameter

Returns:

enabled result names list

setResultEnabled

public void setResultEnabled(Collection<String> resultEnabled)

Description copied from interface: SimulationParameter

Set enabled result names list.

Specified by:

setResultEnabled in interface SimulationParameter

Parameters:

resultEnabled - enabled result names list

getTagValue

public Map<String,String> getTagValue()

Description copied from interface: SimulationParameter

Get tag values. Default to empty map

Specified by:

getTagValue in interface SimulationParameter

Returns:

Returns the tagValue.

setTagValue

public void setTagValue(Map<String,String> tagValue)

Description copied from interface: SimulationParameter

Set tag values.

Specified by:

setTagValue in interface SimulationParameter

Parameters:

tagValue - tagValues to set.

getSimulLogLevel

public String getSimulLogLevel()

Description copied from interface: SimulationParameter

Get simulator log level. Default to "info".

Specified by:

getSimulLogLevel in interface SimulationParameter

Returns:

simulator log level

setSimulLogLevel

public void setSimulLogLevel(String logLevel)

Description copied from interface: SimulationParameter

Set simulator log level.

Specified by:

setSimulLogLevel in interface SimulationParameter

Parameters:

logLevel - simulator log level

getScriptLogLevel

public String getScriptLogLevel()

Description copied from interface: SimulationParameter

Get script log level. Default to "info".

Specified by:

getScriptLogLevel in interface SimulationParameter

Returns:

script log level

setScriptLogLevel

public void setScriptLogLevel(String logLevel)

Description copied from interface: SimulationParameter

Set script log level.

Specified by:

setScriptLogLevel in interface SimulationParameter

Parameters:

logLevel - script log level

getLibLogLevel

public String getLibLogLevel()

Description copied from interface: SimulationParameter

Get librairies log level. Default to "error".

Specified by:

getLibLogLevel in interface SimulationParameter

Returns:

librairies log level

setLibLogLevel

public void setLibLogLevel(String logLevel)

Description copied from interface: SimulationParameter

Set lib log level.

Specified by:

setLibLogLevel in interface SimulationParameter

isSimulErrorLevel

public boolean isSimulErrorLevel()

Specified by:

isSimulErrorLevel in interface SimulationParameter

isSimulWarnLevel

public boolean isSimulWarnLevel()

Specified by:

isSimulWarnLevel in interface SimulationParameter

isSimulInfoLevel

public boolean isSimulInfoLevel()

Specified by:

isSimulInfoLevel in interface SimulationParameter

isSimulDebugLevel

public boolean isSimulDebugLevel()

Specified by:

isSimulDebugLevel in interface SimulationParameter

isScriptErrorLevel

public boolean isScriptErrorLevel()

Specified by:

isScriptErrorLevel in interface SimulationParameter

isScriptWarnLevel

public boolean isScriptWarnLevel()

Specified by:

isScriptWarnLevel in interface SimulationParameter

isScriptInfoLevel

public boolean isScriptInfoLevel()

Specified by:

isScriptInfoLevel in interface SimulationParameter

isScriptDebugLevel

public boolean isScriptDebugLevel()

Specified by:

isScriptDebugLevel in interface SimulationParameter

isLibErrorLevel

public boolean isLibErrorLevel()

Specified by:

isLibErrorLevel in interface SimulationParameter

isLibWarnLevel

public boolean isLibWarnLevel()

Specified by:

isLibWarnLevel in interface SimulationParameter

isLibInfoLevel

public boolean isLibInfoLevel()

Specified by:

isLibInfoLevel in interface SimulationParameter

isLibDebugLevel

public boolean isLibDebugLevel()

Specified by:

isLibDebugLevel in interface SimulationParameter

setProperty

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

Specified by:

setProperty in interface SimulationParameter

Parameters:

key - key

value - value

Since:

3.4.0.0

setProperties

public void setProperties(Properties props)

Description copied from interface: SimulationParameter

Set multiples properties.

Specified by:

setProperties in interface SimulationParameter

Parameters:

props - props

copy

public SimulationParameter copy()

Description copied from interface: SimulationParameter

A copy instance of SimulationParameter. Warning, this is not a deep copy, already instancied objects are not duplicated.

Specified by:

copy in interface SimulationParameter

Returns:

a copy of this instance

deepCopy

public SimulationParameter deepCopy()

Description copied from interface: SimulationParameter

Make a deep copy of current parameters. Bump all current parameters to properties and make a new one with those propeties.

Specified by:

deepCopy in interface SimulationParameter

Returns:

new parameters instance

toString

public String toString()

Description copied from interface: SimulationParameter

The toString() method call getters. So make instances of rules/export/plans...

Specified by:

toString in interface SimulationParameter

Overrides:

toString in class Object

toProperties

public Properties toProperties()

Description copied from interface: SimulationParameter

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

Specified by:

toProperties in interface SimulationParameter

Returns:

L'objet Properties representant les parametres

See Also:

• SimulationParameter.fromProperties(Properties)

fromProperties

public void fromProperties(Properties props)

Description copied from interface: SimulationParameter

Load properties from file.

Specified by:

fromProperties in interface SimulationParameter

Parameters:

props - property to read

reloadContextParameters

public void reloadContextParameters()
                             throws org.nuiton.topia.TopiaException

Description copied from interface: SimulationParameter

Reload parameters du to context change. ie : in simulators when rollbacking transaction Actually : reload rules parameters

Specified by:

reloadContextParameters in interface SimulationParameter

Throws:

org.nuiton.topia.TopiaException

reloadRegionChangeParameter

public void reloadRegionChangeParameter()

Remove from 'cached' parameter data referring to another region. Strategies, populations, and objects with potential parameters values.

Specified by:

reloadRegionChangeParameter in interface SimulationParameter

fixReloadContext

public void fixReloadContext(boolean sensitivityContext)

Description copied from interface: SimulationParameter

Remove all parameters non relative to given context.

Specified by:

fixReloadContext in interface SimulationParameter