Package org.kigalisim.lang.program

Class ParsedScenario

java.lang.Object

org.kigalisim.lang.program.ParsedScenario

public class ParsedScenario
extends Object

Record of a scenario parsed from the source of a QubecTalk program.

Contains the ordered list of policies which should be applied in this scenario.

Constructor Summary

Constructors

Constructor	Description
ParsedScenario(String name, List<String> policies, int startYear, int endYear, int trials)	Create a new record of a scenario.

Method Summary

Modifier and Type	Method	Description
int	getEndYear()	Get the ending year for the simulation.
String	getName()	Gets the name of the scenario.
Iterable<String>	getPolicies()	Get the ordered list of policies for this scenario.
int	getStartYear()	Get the starting year for the simulation.
int	getTrials()	Get the number of trials for the simulation.

Methods inherited from class java.lang.Object

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

Constructor Details

ParsedScenario

public ParsedScenario(String name,
 List<String> policies,
 int startYear,
 int endYear,
 int trials)

Create a new record of a scenario.

Parameters:

name - The name of the scenario parsed.

policies - The ordered list of policies which should be applied in this scenario excluding default which is always applied first.

startYear - The starting year for the simulation.

endYear - The ending year for the simulation.

trials - The number of trials to run for the simulation.

Method Details

getName

public String getName()

Gets the name of the scenario.

Returns:

The name of the scenario.

getPolicies

public Iterable<String> getPolicies()

Get the ordered list of policies for this scenario.

Does not include the "default" policy which is always applied first.

Returns:

Iterable over the names of the policies which should be applied in this scenario in order.

getStartYear

public int getStartYear()

Get the starting year for the simulation.

Returns:

The starting year.

getEndYear

public int getEndYear()

Get the ending year for the simulation.

Returns:

The ending year.

getTrials

public int getTrials()

Get the number of trials for the simulation.

Returns:

The number of trials.