lerfob.carbonbalancetool.sensitivityanalysis

Class CATSensitivityAnalysisSettings

java.lang.Object

lerfob.carbonbalancetool.sensitivityanalysis.CATSensitivityAnalysisSettings

All Implemented Interfaces:

REpiceaShowableUIWithParent, REpiceaUIObjectWithParent

public class CATSensitivityAnalysisSettings
extends java.lang.Object
implements REpiceaShowableUIWithParent

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CATSensitivityAnalysisSettings.VariabilitySource

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	isModelStochastic
protected int	nbMonteCarloRealizations
protected java.util.Map<CATSensitivityAnalysisSettings.VariabilitySource,CATSensitivityAnalysisParameterWrapper>	sensitivityParameterMap

Method Summary

Modifier and Type	Method and Description
void	clear()
static CATSensitivityAnalysisSettings	getInstance() This method returns the singleton instance of the CATSensitivityAnalysisSettings class.
double	getModifier(CATSensitivityAnalysisSettings.VariabilitySource source, MonteCarloSimulationCompliantObject subject, java.lang.String subjectID) This method returns the multiplicative modifier for sensitivity analysis.
int	getNumberOfMonteCarloRealizations() This method returns the number of Monte Carlo realizations for the sensitivity analysis.
java.awt.Component	getUI(java.awt.Container parent) This method returns the GUI interface of the class that implements this interface.
boolean	isModelStochastic()
boolean	isVisible() This method returns true if the GUI is visible.
static void	main(java.lang.String[] args)
void	setModelStochastic(boolean isModelStochastic) This method sets the model to stochastic.
void	setNumberOfMonteCarloRealizations(int nbMonteCarloRealizations) This method sets the number of Monte Carlo realizations for the sensitivity analysis.
void	setVariabilitySource(CATSensitivityAnalysisSettings.VariabilitySource source, Distribution.Type type, boolean enabled, double multiplier) This method sets the different parameters of the sensitivity analysis
void	showUI(java.awt.Window parent) This method shows the GUI interface of the class that implements this interface.

Methods inherited from class java.lang.Object

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

Field Detail

sensitivityParameterMap

protected final java.util.Map<CATSensitivityAnalysisSettings.VariabilitySource,CATSensitivityAnalysisParameterWrapper> sensitivityParameterMap

nbMonteCarloRealizations

protected int nbMonteCarloRealizations

isModelStochastic

protected boolean isModelStochastic

Method Detail

getUI

public java.awt.Component getUI(java.awt.Container parent)

Description copied from interface: REpiceaUIObjectWithParent

This method returns the GUI interface of the class that implements this interface.

Specified by:

getUI in interface REpiceaUIObjectWithParent

Parameters:

parent - a parent Container instance (can be null)

Returns:

a Component instance

showUI

public void showUI(java.awt.Window parent)

Description copied from interface: REpiceaShowableUIWithParent

This method shows the GUI interface of the class that implements this interface.

Specified by:

showUI in interface REpiceaShowableUIWithParent

Parameters:

parent - the parent Window instance (can be null)

getInstance

public static CATSensitivityAnalysisSettings getInstance()

This method returns the singleton instance of the CATSensitivityAnalysisSettings class.

Returns:

a CATSensitivityAnalysisSettings instance

getModifier

public double getModifier(CATSensitivityAnalysisSettings.VariabilitySource source,
                          MonteCarloSimulationCompliantObject subject,
                          java.lang.String subjectID)

This method returns the multiplicative modifier for sensitivity analysis.

Parameters:

source - the source of variability (a VariabilitySource enum)

subject - a MonteCarloSimulationCompliantObject instance

Returns:

a double

isVisible

public boolean isVisible()

Description copied from interface: REpiceaUIObjectWithParent

This method returns true if the GUI is visible.

Specified by:

isVisible in interface REpiceaUIObjectWithParent

Returns:

a boolean

getNumberOfMonteCarloRealizations

public int getNumberOfMonteCarloRealizations()

This method returns the number of Monte Carlo realizations for the sensitivity analysis.

Returns:

an Integer between 1 and 1000

setNumberOfMonteCarloRealizations

public void setNumberOfMonteCarloRealizations(int nbMonteCarloRealizations)

This method sets the number of Monte Carlo realizations for the sensitivity analysis.

Parameters:

nbMonteCarloRealizations - a positive integer between 1 and 1000

setModelStochastic

public void setModelStochastic(boolean isModelStochastic)

This method sets the model to stochastic.

Parameters:

isModelStochastic - a boolean

isModelStochastic

public boolean isModelStochastic()

setVariabilitySource

public void setVariabilitySource(CATSensitivityAnalysisSettings.VariabilitySource source,
                                 Distribution.Type type,
                                 boolean enabled,
                                 double multiplier)

This method sets the different parameters of the sensitivity analysis

Parameters:

source - the source of variability

type - the distribution (either uniform (default) or Gaussian

enabled - true to enable or false to disable

multiplier - a value between 0.0 and 0.5 (50%)

main

public static void main(java.lang.String[] args)

clear

public void clear()