Index

A B C D E F G H I J K L M N O P Q R S T U V X Y Z
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AboutStanzaFragment - Class in org.kigalisim.lang.fragment

A fragment representing an about stanza.

AboutStanzaFragment() - Constructor for class org.kigalisim.lang.fragment.AboutStanzaFragment

Create a new fragment for an about stanza.

accumulateRecharge(EngineNumber, EngineNumber) - Method in class org.kigalisim.engine.state.StreamParameterization

Accumulate recharge parameters.

accumulateRecharge(UseKey, EngineNumber, EngineNumber) - Method in class org.kigalisim.engine.state.SimulationState

Accumulate recharge parameters.

add() - Method in interface org.kigalisim.lang.machine.PushDownMachine

Add the two numbers on top of the stack.

add() - Method in class org.kigalisim.lang.machine.SingleThreadPushDownMachine

Add the two numbers on top of the stack.

add(CharSequence) - Method in class org.kigalisim.util.EmulatedStringJoiner

Adds a new element to the string sequence.

add(EngineNumber, EngineNumber) - Method in class org.kigalisim.engine.state.RechargeInformation

Add population and intensity to this recharge information with weighted-average intensity.

AdditionOperation - Class in org.kigalisim.lang.operation

Calculation that adds two other calculations together.

AdditionOperation(Operation, Operation) - Constructor for class org.kigalisim.lang.operation.AdditionOperation

Create a new AdditionOperation.

and() - Method in interface org.kigalisim.lang.machine.PushDownMachine

Perform a logical AND operation on the two numbers on top of the stack.

and() - Method in class org.kigalisim.lang.machine.SingleThreadPushDownMachine

Perform a logical AND operation on the two numbers on top of the stack.

APPLICATION_CONTEXT - Static variable in class org.kigalisim.engine.state.EngineConstants

Application context level for variables accessible within an application.

ApplicationFragment - Class in org.kigalisim.lang.fragment

A fragment containing a parsed application.

ApplicationFragment(ParsedApplication) - Constructor for class org.kigalisim.lang.fragment.ApplicationFragment

Create a new fragment containing a parsed application.

B

build() - Method in class org.kigalisim.engine.recalc.RecalcKitBuilder

Build the RecalcKit.

build() - Method in class org.kigalisim.engine.recalc.RecalcOperationBuilder

Build the RecalcOperation from the configured strategies.

build() - Method in class org.kigalisim.engine.recalc.SalesStreamDistributionBuilder

Build a sales stream distribution based on provided values.

build() - Method in class org.kigalisim.engine.recalc.StreamUpdateBuilder

Builds the StreamUpdate.

build() - Method in class org.kigalisim.engine.serializer.EngineResultBuilder

Check that the builder is complete and create a new result.

build() - Method in class org.kigalisim.engine.state.SimulationStateUpdateBuilder

Builds the SimulationStateUpdate.

build() - Method in class org.kigalisim.engine.support.ChangeExecutorConfigBuilder

Builds the ChangeExecutorConfig.

buildYearMatcher(PushDownMachine) - Method in class org.kigalisim.lang.time.ParsedDuring

Build a YearMatcher from this parsed version of a during statement.

BY_UNITS - Enum constant in enum class org.kigalisim.lang.operation.DisplacementType

By units displacement - always convert to units and displace by equipment count.

BY_VOLUME - Enum constant in enum class org.kigalisim.lang.operation.DisplacementType

By volume displacement - always convert to kg and displace by volume.

C

CalculatedTimePointFuture - Class in org.kigalisim.lang.time

A future timepoint which resolves to a calculated value.

CalculatedTimePointFuture(Operation) - Constructor for class org.kigalisim.lang.time.CalculatedTimePointFuture

Create a new CalculatedTimePointFuture.

calculateRechargeVolume(UseKey, StateGetter, SimulationState, Engine) - Static method in class org.kigalisim.engine.support.RechargeVolumeCalculator

Calculate the recharge volume for the given application and substance.

call() - Method in class org.kigalisim.command.RunCommand

Executes the run command.

call() - Method in class org.kigalisim.command.ValidateCommand

Executes the validate command.

canHandle(String, int, int) - Method in class org.kigalisim.lang.localization.MixedParseStrategy

canHandle(String, int, int) - Method in interface org.kigalisim.lang.localization.NumberParseUtilStrategy

Determine if this strategy can handle the given separator pattern.

canHandle(String, int, int) - Method in class org.kigalisim.lang.localization.OnlyCommasParseStrategy

canHandle(String, int, int) - Method in class org.kigalisim.lang.localization.OnlyPeriodsParseStrategy

cap(String, EngineNumber, YearMatcher, String, DisplacementType) - Method in interface org.kigalisim.engine.Engine

Cap a stream at a maximum value.

cap(String, EngineNumber, YearMatcher, String, DisplacementType) - Method in class org.kigalisim.engine.SingleThreadEngine

CapDisplacingOperation - Class in org.kigalisim.lang.operation

Operation that caps a stream value to a specified maximum and displaces the excess.

CapDisplacingOperation(String, Operation, String) - Constructor for class org.kigalisim.lang.operation.CapDisplacingOperation

Create a new CapDisplacingOperation that applies to all years.

CapDisplacingOperation(String, Operation, String, ParsedDuring) - Constructor for class org.kigalisim.lang.operation.CapDisplacingOperation

Create a new CapDisplacingOperation that applies to a specific time period.

CapOperation - Class in org.kigalisim.lang.operation

Operation that caps a stream value to a specified maximum and optionally displaces the excess.

CapOperation(String, Operation) - Constructor for class org.kigalisim.lang.operation.CapOperation

Create a new CapOperation that applies to all years.

CapOperation(String, Operation, String) - Constructor for class org.kigalisim.lang.operation.CapOperation

Create a new CapOperation that applies to all years with displacement.

CapOperation(String, Operation, String, DisplacementType) - Constructor for class org.kigalisim.lang.operation.CapOperation

Create a new CapOperation that applies to all years with displacement and displacement type.

CapOperation(String, Operation, String, ParsedDuring) - Constructor for class org.kigalisim.lang.operation.CapOperation

Create a new CapOperation that applies to a specific time period with displacement.

CapOperation(String, Operation, String, ParsedDuring, DisplacementType) - Constructor for class org.kigalisim.lang.operation.CapOperation

Create a new CapOperation that applies to a specific time period with displacement and displacement type.

CapOperation(String, Operation, ParsedDuring) - Constructor for class org.kigalisim.lang.operation.CapOperation

Create a new CapOperation that applies to a specific time period.

ChangeExecutor - Class in org.kigalisim.engine.support

Handles change operations for different types of streams.

ChangeExecutor(Engine) - Constructor for class org.kigalisim.engine.support.ChangeExecutor

Creates a new ChangeExecutor for the given engine.

ChangeExecutorConfig - Class in org.kigalisim.engine.support

Configuration for change executor operations.

ChangeExecutorConfig(String, EngineNumber, Optional<YearMatcher>, UseKey) - Constructor for class org.kigalisim.engine.support.ChangeExecutorConfig

Creates a new ChangeExecutorConfig.

ChangeExecutorConfig(String, EngineNumber, UseKey) - Constructor for class org.kigalisim.engine.support.ChangeExecutorConfig

Creates a new ChangeExecutorConfig without a year matcher.

ChangeExecutorConfig(String, EngineNumber, YearMatcher, UseKey) - Constructor for class org.kigalisim.engine.support.ChangeExecutorConfig

Creates a new ChangeExecutorConfig with a YearMatcher.

ChangeExecutorConfigBuilder - Class in org.kigalisim.engine.support

Builder for creating ChangeExecutorConfig instances with fluent interface.

ChangeExecutorConfigBuilder() - Constructor for class org.kigalisim.engine.support.ChangeExecutorConfigBuilder

Create a new ChangeExecutorConfigBuilder.

ChangeOperation - Class in org.kigalisim.lang.operation

Operation that changes a stream value by a specified amount.

ChangeOperation(String, Operation) - Constructor for class org.kigalisim.lang.operation.ChangeOperation

Create a new ChangeOperation that applies to all years.

ChangeOperation(String, Operation, ParsedDuring) - Constructor for class org.kigalisim.lang.operation.ChangeOperation

Create a new ChangeOperation that applies to a specific time period.

changeStream(String, EngineNumber, YearMatcher) - Method in interface org.kigalisim.engine.Engine

Change a stream value by a delta amount with default scope.

changeStream(String, EngineNumber, YearMatcher) - Method in class org.kigalisim.engine.SingleThreadEngine

changeStream(String, EngineNumber, YearMatcher, UseKey) - Method in interface org.kigalisim.engine.Engine

Change a stream value by a delta amount.

changeStream(String, EngineNumber, YearMatcher, UseKey) - Method in class org.kigalisim.engine.SingleThreadEngine

changeStreamWithDisplacementContext(String, EngineNumber, Scope) - Method in class org.kigalisim.engine.support.StreamUpdateShortcuts

Change a stream value with proper displacement context for correct GWP calculations.

changeStreamWithDisplacementContext(String, EngineNumber, Scope, boolean) - Method in class org.kigalisim.engine.support.StreamUpdateShortcuts

Change a stream value with proper displacement context for correct GWP calculations.

changeStreamWithoutReportingUnits(String, EngineNumber, Optional<YearMatcher>, Optional<UseKey>) - Method in class org.kigalisim.engine.support.StreamUpdateShortcuts

Change a stream value without reporting units to the last units tracking system.

changeStreamWithoutReportingUnits(String, EngineNumber, Optional<YearMatcher>, Optional<UseKey>, boolean) - Method in class org.kigalisim.engine.support.StreamUpdateShortcuts

Change a stream value without reporting units to the last units tracking system.

changeUnits(String) - Method in interface org.kigalisim.lang.machine.PushDownMachine

Change the units of the number at the top of the stack.

changeUnits(String) - Method in class org.kigalisim.lang.machine.SingleThreadPushDownMachine

Change the units of the number at the top of the stack.

changeUnits(String, boolean) - Method in interface org.kigalisim.lang.machine.PushDownMachine

Change the units of the number at the top of the stack, optionally forcing the change.

changeUnits(String, boolean) - Method in class org.kigalisim.lang.machine.SingleThreadPushDownMachine

Change the units of the number at the top of the stack, optionally forcing the change.

ChangeUnitsOperation - Class in org.kigalisim.lang.operation

Description of a calculation which changes the units of an EngineNumber.

ChangeUnitsOperation(Operation, String) - Constructor for class org.kigalisim.lang.operation.ChangeUnitsOperation

Create a new ChangeUnitsOperation.

clearAmortizedUnitVolume() - Method in class org.kigalisim.engine.state.OverridingConverterStateGetter

Clear the amortized unit volume override to use the inner getter's value.

clearDistribution() - Method in class org.kigalisim.engine.recalc.StreamUpdateBuilder

Clears the distribution.

clearDistribution() - Method in class org.kigalisim.engine.state.SimulationStateUpdateBuilder

Clears the distribution.

clearKey() - Method in class org.kigalisim.engine.recalc.StreamUpdateBuilder

Clears the use key.

clearLastSpecifiedValue(String) - Method in class org.kigalisim.engine.state.StreamParameterization

Clear the last specified value in this parameterization.

clearLastSpecifiedValue(UseKey, String) - Method in class org.kigalisim.engine.state.SimulationState

Clear the last specified value in the parameterization for the given use key.

clearPopulation() - Method in class org.kigalisim.engine.state.OverridingConverterStateGetter

Clear the population override to use the inner getter's value.

clearUnitsToRecord() - Method in class org.kigalisim.engine.recalc.StreamUpdateBuilder

Clears the units to record.

clearVolume() - Method in class org.kigalisim.engine.state.OverridingConverterStateGetter

Clear the volume override to use the inner getter's value.

CommandInterpretResult - Class in org.kigalisim.command

Result of interpreting QubecTalk code.

CommandInterpretResult() - Constructor for class org.kigalisim.command.CommandInterpretResult

Creates a successful interpretation result without a program.

CommandInterpretResult(String) - Constructor for class org.kigalisim.command.CommandInterpretResult

Creates a failed interpretation result.

CommandInterpretResult(ParsedProgram) - Constructor for class org.kigalisim.command.CommandInterpretResult

Creates a successful interpretation result.

ComparisonOperation - Class in org.kigalisim.lang.operation

Calculation that compares two other calculations.

ComparisonOperation(Operation, Operation, String) - Constructor for class org.kigalisim.lang.operation.ComparisonOperation

Create a new ComparisonOperation.

ConditionalOperation - Class in org.kigalisim.lang.operation

Calculation that performs a conditional operation (if-else) on three other calculations.

ConditionalOperation(Operation, Operation, Operation) - Constructor for class org.kigalisim.lang.operation.ConditionalOperation

Create a new ConditionalOperation.

ConsumptionCalculator - Class in org.kigalisim.engine.support

Calculator class for consumption stream calculations.

ConsumptionCalculator() - Constructor for class org.kigalisim.engine.support.ConsumptionCalculator

Constructs a new ConsumptionCalculator.

ConsumptionRecalcStrategy - Class in org.kigalisim.engine.recalc

Strategy for recalculating consumption.

ConsumptionRecalcStrategy(Optional<UseKey>) - Constructor for class org.kigalisim.engine.recalc.ConsumptionRecalcStrategy

Create a new ConsumptionRecalcStrategy.

convert(EngineNumber, String) - Method in class org.kigalisim.engine.number.UnitConverter

Convert a number to new units.

ConverterStateGetter - Class in org.kigalisim.engine.state

Class providing state information needed for unit conversions.

ConverterStateGetter(Engine) - Constructor for class org.kigalisim.engine.state.ConverterStateGetter

Create a new converter state getter.

convertResultsToCsv(List<EngineResult>) - Static method in class org.kigalisim.KigaliSimFacade

Convert a list of EngineResult objects to a CSV string.

createUnitConverterWithTotal(Engine, String) - Static method in class org.kigalisim.engine.support.EngineSupportUtils

Creates a unit converter with total values initialized (convenience method).

createUnitConverterWithTotal(ConverterStateGetter, String, EngineNumber, EngineNumber) - Static method in class org.kigalisim.engine.support.EngineSupportUtils

Creates a unit converter with total values initialized.

D

defineVariable(String) - Method in interface org.kigalisim.engine.Engine

Create a user-defined variable in the current scope.

defineVariable(String) - Method in class org.kigalisim.engine.SingleThreadEngine

defineVariable(String) - Method in class org.kigalisim.engine.state.Scope

Define a variable in the current scope.

defineVariable(String) - Method in class org.kigalisim.engine.state.VariableManager

Define a new variable in the current context level.

DefineVariableOperation - Class in org.kigalisim.lang.operation

Operation that defines a variable and sets its value in the engine.

DefineVariableOperation(String, Operation) - Constructor for class org.kigalisim.lang.operation.DefineVariableOperation

Create a new DefineVariableOperation.

DisplaceExecutor - Class in org.kigalisim.engine.support

Executor for displacement operations in cap, floor, and recover commands.

DisplaceExecutor(Engine) - Constructor for class org.kigalisim.engine.support.DisplaceExecutor

Creates a new DisplaceExecutor for the given engine.

DisplacementType - Enum Class in org.kigalisim.lang.operation

Enum representing the type of displacement for cap and floor operations.

divide() - Method in interface org.kigalisim.lang.machine.PushDownMachine

Divide the two numbers on top of the stack.

divide() - Method in class org.kigalisim.lang.machine.SingleThreadPushDownMachine

Divide the two numbers on top of the stack.

divideWithZero(BigDecimal, BigDecimal) - Static method in class org.kigalisim.engine.support.DivisionHelper

Divide with a check for division by zero.

DivisionHelper - Class in org.kigalisim.engine.support

Helper class for mathematical division operations.

DivisionOperation - Class in org.kigalisim.lang.operation

Calculation that divides two other calculations.

DivisionOperation(Operation, Operation) - Constructor for class org.kigalisim.lang.operation.DivisionOperation

Create a new DivisionOperation.

drawNormal() - Method in interface org.kigalisim.lang.machine.PushDownMachine

Draw a random number from a normal distribution.

drawNormal() - Method in class org.kigalisim.lang.machine.SingleThreadPushDownMachine

Draw a random number from a normal distribution.

DrawNormalOperation - Class in org.kigalisim.lang.operation

Calculation that samples from a normal distribution.

DrawNormalOperation(Operation, Operation) - Constructor for class org.kigalisim.lang.operation.DrawNormalOperation

Create a new DrawNormalOperation.

drawUniform() - Method in interface org.kigalisim.lang.machine.PushDownMachine

Draw a random number from a uniform distribution.

drawUniform() - Method in class org.kigalisim.lang.machine.SingleThreadPushDownMachine

Draw a random number from a uniform distribution.

DrawUniformOperation - Class in org.kigalisim.lang.operation

Calculation that samples from a uniform distribution.

DrawUniformOperation(Operation, Operation) - Constructor for class org.kigalisim.lang.operation.DrawUniformOperation

Create a new DrawUniformOperation.

DuplicateValidationException - Exception Class in org.kigalisim.lang.validation

Exception thrown when duplicate names are detected during program validation.

DuplicateValidationException(String, String, String) - Constructor for exception class org.kigalisim.lang.validation.DuplicateValidationException

Create a new duplicate validation exception.

DuplicateValidationException(String, String, String, String) - Constructor for exception class org.kigalisim.lang.validation.DuplicateValidationException

Create a new duplicate validation exception with a custom message.

DuplicateValidator - Class in org.kigalisim.lang.validation

Utility class for validating unique names and preventing duplicates.

DuplicateValidator() - Constructor for class org.kigalisim.lang.validation.DuplicateValidator

Constructs a new DuplicateValidator.

DuringFragment - Class in org.kigalisim.lang.fragment

A fragment containing a parsed during expression.

DuringFragment(ParsedDuring) - Constructor for class org.kigalisim.lang.fragment.DuringFragment

Create a new DuringFragment.

DynamicCapFuture - Class in org.kigalisim.lang.time

A future timepoint which resolves to a dynamic cap value.

DynamicCapFuture(String) - Constructor for class org.kigalisim.lang.time.DynamicCapFuture

Create a new DynamicCapFuture.

E

EmulatedStringJoiner - Class in org.kigalisim.util

A WebAssembly-compatible string joiner that builds sequences with delimiters.

EmulatedStringJoiner(CharSequence) - Constructor for class org.kigalisim.util.EmulatedStringJoiner

Constructs a new EmulatedStringJoiner with the specified delimiter.

enable(String, Optional<YearMatcher>) - Method in interface org.kigalisim.engine.Engine

Enable a stream without setting its value.

enable(String, Optional<YearMatcher>) - Method in class org.kigalisim.engine.SingleThreadEngine

EnableOperation - Class in org.kigalisim.lang.operation

Operation that enables a stream in the engine without setting a value.

EnableOperation(String) - Constructor for class org.kigalisim.lang.operation.EnableOperation

Create a new EnableOperation that applies to all years.

EnableOperation(String, ParsedDuring) - Constructor for class org.kigalisim.lang.operation.EnableOperation

Create a new EnableOperation that applies to a specific time period.

Engine - Interface in org.kigalisim.engine

Engine entry-point which maintains and updates simulation state.

EngineConstants - Class in org.kigalisim.engine.state

Constants for engine state management.

EngineNumber - Class in org.kigalisim.engine.number

Representation of a number with units within the engine.

EngineNumber(double, String) - Constructor for class org.kigalisim.engine.number.EngineNumber

Create a new number with units from a double value.

EngineNumber(BigDecimal, String) - Constructor for class org.kigalisim.engine.number.EngineNumber

Create a new number with units.

EngineResult - Class in org.kigalisim.engine.serializer

Engine execution result for a specific substance, application, and year.

EngineResult(EngineResultBuilder) - Constructor for class org.kigalisim.engine.serializer.EngineResult

Constructor for creating an EngineResult instance from a builder.

EngineResultBuilder - Class in org.kigalisim.engine.serializer

Builder pattern implementation for creating EngineResult objects.

EngineResultBuilder() - Constructor for class org.kigalisim.engine.serializer.EngineResultBuilder

Create builder without any values initialized.

EngineResultSerializer - Class in org.kigalisim.engine.serializer

Decorator around an engine to serialize out results.

EngineResultSerializer(Engine, ConverterStateGetter) - Constructor for class org.kigalisim.engine.serializer.EngineResultSerializer

Create a new decorator to produce engine result snapshots.

EngineSupportUtils - Class in org.kigalisim.engine.support

Static utility methods for engine operations.

ensurePositive(BigDecimal) - Static method in class org.kigalisim.engine.support.EngineSupportUtils

Ensures a value is positive, clamping to zero if negative.

ensureSubstance(UseKey) - Method in class org.kigalisim.engine.state.SimulationState

Ensure a substance exists for a key, creating it if needed.

EOL - Enum constant in enum class org.kigalisim.lang.operation.RecoverOperation.RecoveryStage

Recovery at end of life.

EolEmissionsRecalcStrategy - Class in org.kigalisim.engine.recalc

Strategy for recalculating end-of-life emissions.

EolEmissionsRecalcStrategy(Optional<UseKey>) - Constructor for class org.kigalisim.engine.recalc.EolEmissionsRecalcStrategy

Create a new EolEmissionsRecalcStrategy.

EqualityOperation - Class in org.kigalisim.lang.operation

Calculation that performs an equality comparison on two other calculations.

EqualityOperation(Operation, Operation, String) - Constructor for class org.kigalisim.lang.operation.EqualityOperation

Create a new EqualityOperation.

equals() - Method in interface org.kigalisim.lang.machine.PushDownMachine

Perform an equality comparison on the two numbers on top of the stack.

equals() - Method in class org.kigalisim.lang.machine.SingleThreadPushDownMachine

Perform an equality comparison on the two numbers on top of the stack.

equals(EngineNumber, YearMatcher) - Method in interface org.kigalisim.engine.Engine

Set GHG equivalency (GWP - Global Warming Potential) for the current application and substance.

equals(EngineNumber, YearMatcher) - Method in class org.kigalisim.engine.SingleThreadEngine

EqualsOperation - Class in org.kigalisim.lang.operation

Operation that sets a consumption value in the engine.

EqualsOperation(Operation) - Constructor for class org.kigalisim.lang.operation.EqualsOperation

Create a new EqualsOperation that applies to all years.

EqualsOperation(Operation, ParsedDuring) - Constructor for class org.kigalisim.lang.operation.EqualsOperation

Create a new EqualsOperation that applies to a specific time period.

EquipmentChangeUtil - Class in org.kigalisim.engine.support

Handles equipment stream operations with proper recharge accounting.

EquipmentChangeUtil(Engine) - Constructor for class org.kigalisim.engine.support.EquipmentChangeUtil

Creates a new EquipmentChangeUtil for the given engine.

EQUIVALENT - Enum constant in enum class org.kigalisim.lang.operation.DisplacementType

Equivalent displacement - displaces based on context (volume if last specified as volume, units if units).

ExceptionsGenerator - Class in org.kigalisim.engine.support

Generator for exceptions used in recalculation operations.

ExceptionsGenerator() - Constructor for class org.kigalisim.engine.support.ExceptionsGenerator

Constructs a new ExceptionsGenerator.

execute(String) - Static method in class org.kigalisim.KigaliWasmSimFacade

Executes all scenarios in the provided QubecTalk code and returns the results.

execute(String, EngineNumber, BigDecimal, String, DisplacementType) - Method in class org.kigalisim.engine.support.DisplaceExecutor

Executes a displacement operation to offset a change in one stream with a change in another.

execute(Engine) - Method in class org.kigalisim.engine.recalc.RecalcOperation

Execute all strategies in order on the target engine.

execute(Engine) - Method in class org.kigalisim.engine.support.ConsumptionCalculator

Execute the consumption calculation and save the result to the engine.

execute(Engine, RecalcKit) - Method in class org.kigalisim.engine.recalc.ConsumptionRecalcStrategy

execute(Engine, RecalcKit) - Method in class org.kigalisim.engine.recalc.EolEmissionsRecalcStrategy

Recalculate end-of-life emissions based on the retirement delta.

execute(Engine, RecalcKit) - Method in class org.kigalisim.engine.recalc.PopulationChangeRecalcStrategy

execute(Engine, RecalcKit) - Method in interface org.kigalisim.engine.recalc.RecalcStrategy

Execute the recalculation strategy with the given engine and RecalcKit.

execute(Engine, RecalcKit) - Method in class org.kigalisim.engine.recalc.RechargeEmissionsRecalcStrategy

execute(Engine, RecalcKit) - Method in class org.kigalisim.engine.recalc.RetireRecalcStrategy

execute(Engine, RecalcKit) - Method in class org.kigalisim.engine.recalc.SalesRecalcStrategy

execute(EngineNumber, String, String, YearMatcher) - Method in class org.kigalisim.engine.support.ReplaceExecutor

Executes a substance replacement operation.

execute(StreamUpdate) - Method in class org.kigalisim.engine.support.StreamUpdateExecutor

Executes a complete stream update operation with all side effects.

execute(PushDownMachine) - Method in class org.kigalisim.lang.operation.AdditionOperation

Execute the calculation and leave the result at the top of the stack.

execute(PushDownMachine) - Method in class org.kigalisim.lang.operation.CapDisplacingOperation

Execute the calculation and leave the result at the top of the stack.

execute(PushDownMachine) - Method in class org.kigalisim.lang.operation.CapOperation

Execute the calculation and leave the result at the top of the stack.

execute(PushDownMachine) - Method in class org.kigalisim.lang.operation.ChangeOperation

Execute the calculation and leave the result at the top of the stack.

execute(PushDownMachine) - Method in class org.kigalisim.lang.operation.ChangeUnitsOperation

Execute the calculation and leave the result at the top of the stack.

execute(PushDownMachine) - Method in class org.kigalisim.lang.operation.ComparisonOperation

Execute the calculation and leave the result at the top of the stack.

execute(PushDownMachine) - Method in class org.kigalisim.lang.operation.ConditionalOperation

Execute the calculation and leave the result at the top of the stack.

execute(PushDownMachine) - Method in class org.kigalisim.lang.operation.DefineVariableOperation

Executes the variable definition operation.

execute(PushDownMachine) - Method in class org.kigalisim.lang.operation.DivisionOperation

Execute the calculation and leave the result at the top of the stack.

execute(PushDownMachine) - Method in class org.kigalisim.lang.operation.DrawNormalOperation

Execute the calculation and leave the result at the top of the stack.

execute(PushDownMachine) - Method in class org.kigalisim.lang.operation.DrawUniformOperation

Execute the calculation and leave the result at the top of the stack.

execute(PushDownMachine) - Method in class org.kigalisim.lang.operation.EnableOperation

Execute the calculation and leave the result at the top of the stack.

execute(PushDownMachine) - Method in class org.kigalisim.lang.operation.EqualityOperation

Execute the calculation and leave the result at the top of the stack.

execute(PushDownMachine) - Method in class org.kigalisim.lang.operation.EqualsOperation

Execute the calculation and leave the result at the top of the stack.

execute(PushDownMachine) - Method in class org.kigalisim.lang.operation.FloorDisplacingOperation

Execute the calculation and leave the result at the top of the stack.

execute(PushDownMachine) - Method in class org.kigalisim.lang.operation.FloorOperation

Execute the calculation and leave the result at the top of the stack.

execute(PushDownMachine) - Method in class org.kigalisim.lang.operation.GetStreamOperation

Execute the calculation and leave the result at the top of the stack.

execute(PushDownMachine) - Method in class org.kigalisim.lang.operation.GetVariableOperation

Execute the calculation and leave the result at the top of the stack.

execute(PushDownMachine) - Method in class org.kigalisim.lang.operation.InitialChargeOperation

Execute the calculation and leave the result at the top of the stack.

execute(PushDownMachine) - Method in class org.kigalisim.lang.operation.JointOperation

execute(PushDownMachine) - Method in class org.kigalisim.lang.operation.LimitOperation

Execute the calculation and leave the result at the top of the stack.

execute(PushDownMachine) - Method in class org.kigalisim.lang.operation.LogicalOperation

Execute the calculation and leave the result at the top of the stack.

execute(PushDownMachine) - Method in class org.kigalisim.lang.operation.MultiplicationOperation

Execute the calculation and leave the result at the top of the stack.

execute(PushDownMachine) - Method in interface org.kigalisim.lang.operation.Operation

Execute the calculation and leave the result at the top of the stack.

execute(PushDownMachine) - Method in class org.kigalisim.lang.operation.PowerOperation

Execute the calculation and leave the result at the top of the stack.

execute(PushDownMachine) - Method in class org.kigalisim.lang.operation.PreCalculatedOperation

Execute the calculation and leave the result at the top of the stack.

execute(PushDownMachine) - Method in class org.kigalisim.lang.operation.RechargeOperation

Execute the calculation and leave the result at the top of the stack.

execute(PushDownMachine) - Method in class org.kigalisim.lang.operation.RecoverOperation

Executes the recovery operation.

execute(PushDownMachine) - Method in class org.kigalisim.lang.operation.RemoveUnitsOperation

execute(PushDownMachine) - Method in class org.kigalisim.lang.operation.ReplaceOperation

Execute the calculation and leave the result at the top of the stack.

execute(PushDownMachine) - Method in class org.kigalisim.lang.operation.RetireOperation

Execute the retire operation on the given push-down machine.

execute(PushDownMachine) - Method in class org.kigalisim.lang.operation.RetireWithReplacementOperation

Execute the retire and replacement operation.

execute(PushDownMachine) - Method in class org.kigalisim.lang.operation.SetOperation

Execute the calculation and leave the result at the top of the stack.

execute(PushDownMachine) - Method in class org.kigalisim.lang.operation.SubtractionOperation

Execute the calculation and leave the result at the top of the stack.

executeCap(String, EngineNumber, YearMatcher, String, DisplacementType) - Method in class org.kigalisim.engine.support.LimitExecutor

Executes a cap operation to limit a stream to a maximum value.

executeChange(String, EngineNumber, YearMatcher, UseKey) - Method in class org.kigalisim.engine.support.ChangeExecutor

Execute a change operation by routing to the appropriate handler.

executeChange(ChangeExecutorConfig) - Method in class org.kigalisim.engine.support.ChangeExecutor

Execute a change operation using configuration object.

executeFloor(String, EngineNumber, YearMatcher, String, DisplacementType) - Method in class org.kigalisim.engine.support.LimitExecutor

Executes a floor operation to enforce a minimum value on a stream.

executeScenario(String, String) - Static method in class org.kigalisim.KigaliWasmSimFacade

Executes a single scenario from the provided QubecTalk code.

executeStreamUpdate(StreamUpdate) - Method in interface org.kigalisim.engine.Engine

Execute a stream update operation using a StreamUpdate object.

executeStreamUpdate(StreamUpdate) - Method in class org.kigalisim.engine.SingleThreadEngine

F

FlexibleNumberParseResult - Class in org.kigalisim.lang.localization

Result of a flexible number parsing operation.

FlexibleNumberParseResult(String) - Constructor for class org.kigalisim.lang.localization.FlexibleNumberParseResult

Creates a failed parse result with an error message.

FlexibleNumberParseResult(BigDecimal) - Constructor for class org.kigalisim.lang.localization.FlexibleNumberParseResult

Creates a successful parse result.

floor(String, EngineNumber, YearMatcher, String, DisplacementType) - Method in interface org.kigalisim.engine.Engine

Set a minimum floor value for a stream.

floor(String, EngineNumber, YearMatcher, String, DisplacementType) - Method in class org.kigalisim.engine.SingleThreadEngine

FloorDisplacingOperation - Class in org.kigalisim.lang.operation

Operation that floors a stream value to a specified minimum and displaces the excess.

FloorDisplacingOperation(String, Operation, String) - Constructor for class org.kigalisim.lang.operation.FloorDisplacingOperation

Create a new FloorDisplacingOperation that applies to all years.

FloorDisplacingOperation(String, Operation, String, ParsedDuring) - Constructor for class org.kigalisim.lang.operation.FloorDisplacingOperation

Create a new FloorDisplacingOperation that applies to a specific time period.

FloorOperation - Class in org.kigalisim.lang.operation

Operation that floors a stream value to a specified minimum and optionally displaces the excess.

FloorOperation(String, Operation) - Constructor for class org.kigalisim.lang.operation.FloorOperation

Create a new FloorOperation that applies to all years.

FloorOperation(String, Operation, String) - Constructor for class org.kigalisim.lang.operation.FloorOperation

Create a new FloorOperation that applies to all years with displacement.

FloorOperation(String, Operation, String, DisplacementType) - Constructor for class org.kigalisim.lang.operation.FloorOperation

Create a new FloorOperation that applies to all years with displacement and displacement type.

FloorOperation(String, Operation, String, ParsedDuring) - Constructor for class org.kigalisim.lang.operation.FloorOperation

Create a new FloorOperation that applies to a specific time period with displacement.

FloorOperation(String, Operation, String, ParsedDuring, DisplacementType) - Constructor for class org.kigalisim.lang.operation.FloorOperation

Create a new FloorOperation that applies to a specific time period with displacement and displacement type.

FloorOperation(String, Operation, ParsedDuring) - Constructor for class org.kigalisim.lang.operation.FloorOperation

Create a new FloorOperation that applies to a specific time period.

Fragment - Class in org.kigalisim.lang.fragment

Description of a part of a parsed QubecTalk program.

Fragment() - Constructor for class org.kigalisim.lang.fragment.Fragment

Constructs a new Fragment.

G

getAmortizedUnitConsumption() - Method in class org.kigalisim.engine.state.ConverterStateGetter

Get the consumption ratio per unit of population.

getAmortizedUnitConsumption() - Method in class org.kigalisim.engine.state.OverridingConverterStateGetter

Get the amortized unit consumption value.

getAmortizedUnitConsumption() - Method in interface org.kigalisim.engine.state.StateGetter

Get the amortized unit consumption.

getAmortizedUnitVolume() - Method in class org.kigalisim.engine.state.ConverterStateGetter

Get the amortized initial charge volume per unit for sales.

getAmortizedUnitVolume() - Method in class org.kigalisim.engine.state.OverridingConverterStateGetter

Get the amortized unit volume value.

getAmortizedUnitVolume() - Method in interface org.kigalisim.engine.state.StateGetter

Get the amortized unit volume.

getAmount() - Method in class org.kigalisim.engine.support.ChangeExecutorConfig

Gets the change amount.

getApplication() - Method in class org.kigalisim.engine.serializer.EngineResult

Get the application.

getApplication() - Method in class org.kigalisim.engine.serializer.EngineResultBuilder

Get the application value.

getApplication() - Method in class org.kigalisim.engine.state.Scope

Get the name of the application where this scope resides.

getApplication() - Method in class org.kigalisim.engine.state.SimpleUseKey

getApplication() - Method in class org.kigalisim.engine.state.SubstanceInApplicationId

Get the name of the application.

getApplication() - Method in interface org.kigalisim.engine.state.UseKey

Get the application name.

getApplication() - Method in class org.kigalisim.lang.fragment.ApplicationFragment

Get the application parsed from the source of this fragment.

getApplication() - Method in class org.kigalisim.lang.fragment.Fragment

Get the application parsed from the source of this fragment.

getApplication(String) - Method in class org.kigalisim.lang.program.ParsedPolicy

Get a specific application by name.

getApplicationOptional() - Method in class org.kigalisim.engine.state.Scope

Get the name of the application where this scope resides as an Optional.

getApplications() - Method in class org.kigalisim.lang.program.ParsedPolicy

Get the names of all applications defined in this policy.

getAppliedRechargeAmount() - Method in class org.kigalisim.engine.state.PriorEquipmentBases

Get the applied recharge amount.

getAppliedRechargeAmount() - Method in class org.kigalisim.engine.state.StreamParameterization

Get the applied recharge amount for cumulative calculations.

getAppliedRechargeAmount(UseKey) - Method in class org.kigalisim.engine.state.SimulationState

Get the applied recharge amount for cumulative calculations.

getAppliedRetirementAmount() - Method in class org.kigalisim.engine.state.PriorEquipmentBases

Get the applied retirement amount.

getAppliedRetirementAmount() - Method in class org.kigalisim.engine.state.StreamParameterization

Get the applied retirement amount for cumulative calculations.

getAppliedRetirementAmount(UseKey) - Method in class org.kigalisim.engine.state.SimulationState

Get the applied retirement amount for cumulative calculations.

getBankChangeKg() - Method in class org.kigalisim.engine.serializer.EngineResult

Get the bank change kg value.

getBankChangeKg() - Method in class org.kigalisim.engine.serializer.EngineResultBuilder

Get the bank change kg value.

getBankChangeTco2e() - Method in class org.kigalisim.engine.serializer.EngineResult

Get the bank change tCO2e value.

getBankChangeTco2e() - Method in class org.kigalisim.engine.serializer.EngineResultBuilder

Get the bank change tCO2e value.

getBankKg() - Method in class org.kigalisim.engine.serializer.EngineResult

Get the bank kg value.

getBankKg() - Method in class org.kigalisim.engine.serializer.EngineResultBuilder

Get the bank kg value.

getBankTco2e() - Method in class org.kigalisim.engine.serializer.EngineResult

Get the bank tCO2e value.

getBankTco2e() - Method in class org.kigalisim.engine.serializer.EngineResultBuilder

Get the bank tCO2e value.

getBasePopulation() - Method in class org.kigalisim.engine.recalc.RetireBackgroundInfo

Get the base population for retirement calculations.

getBaseUnits(String) - Static method in class org.kigalisim.engine.state.EngineConstants

Get the base units for a given stream name.

getConsumption() - Method in class org.kigalisim.engine.serializer.EngineResult

Get the total consumption.

getConsumption(boolean) - Method in class org.kigalisim.engine.serializer.EngineResult

Get the total consumption with optional recycling inclusion.

getContext() - Method in exception class org.kigalisim.lang.validation.DuplicateValidationException

Get the context where the duplication occurred.

getCurrentEquipment() - Method in class org.kigalisim.engine.recalc.RetireBackgroundInfo

Get the current total equipment value.

getCurrentPrior() - Method in class org.kigalisim.engine.recalc.RetireBackgroundInfo

Get the current prior equipment value.

getCurrentRetired() - Method in class org.kigalisim.engine.recalc.RetireBackgroundInfo

Get the current retired value.

getCurrentYear() - Method in class org.kigalisim.engine.state.SimulationState

Get the current year for this simulation state.

getDetailedErrorMessage(ParseResult) - Static method in class org.kigalisim.KigaliSimFacade

Get a formatted error message from a ParseResult.

getDisplacementType() - Method in class org.kigalisim.lang.operation.CapOperation

Get the displacement type.

getDisplacementType() - Method in class org.kigalisim.lang.operation.FloorOperation

Get the displacement type.

getDistributedRecharge(String, EngineNumber, UseKey, SimulationState) - Static method in class org.kigalisim.engine.support.EngineSupportUtils

Gets the distributed recharge amount for a specific stream.

getDistribution() - Method in class org.kigalisim.engine.recalc.StreamUpdate

Gets the optional pre-calculated distribution for sales streams.

getDistribution() - Method in class org.kigalisim.engine.state.SimulationStateUpdate

Gets the optional pre-calculated distribution for sales streams.

getDistribution(UseKey) - Method in class org.kigalisim.engine.state.SimulationState

Get a sales stream distribution for the given substance/application.

getDistribution(UseKey, boolean) - Method in class org.kigalisim.engine.state.SimulationState

Get a sales stream distribution for the given substance/application.

getDomestic() - Method in class org.kigalisim.engine.serializer.EngineResult

Get the domestic value.

getDomesticConsumption() - Method in class org.kigalisim.engine.serializer.EngineResult

Get the domestic consumption value.

getDomesticConsumptionValue() - Method in class org.kigalisim.engine.serializer.EngineResultBuilder

Get the domestic consumption value.

getDomesticValue() - Method in class org.kigalisim.engine.serializer.EngineResultBuilder

Get the domestic value.

getDuplicateName() - Method in exception class org.kigalisim.lang.validation.DuplicateValidationException

Get the name that is duplicated.

getDuplicateType() - Method in exception class org.kigalisim.lang.validation.DuplicateValidationException

Get the type of item that is duplicated.

getDuring() - Method in class org.kigalisim.lang.fragment.DuringFragment

getDuring() - Method in class org.kigalisim.lang.fragment.Fragment

Get the during that should be applied in filtering if an operation should be applied.

getDynamicCap() - Method in class org.kigalisim.lang.time.TimePointRealized

Get the dynamic cap value.

getEnd() - Method in class org.kigalisim.engine.state.YearMatcher

Get the end of the year range.

getEnd() - Method in class org.kigalisim.lang.time.ParsedDuring

Get the end of the period.

getEndYear() - Method in interface org.kigalisim.engine.Engine

Get the ending year of the simulation.

getEndYear() - Method in class org.kigalisim.engine.SingleThreadEngine

getEndYear() - Method in class org.kigalisim.lang.program.ParsedScenario

Get the ending year for the simulation.

getEnergyConsumption() - Method in class org.kigalisim.engine.serializer.EngineResult

Get the energy consumption value.

getEnergyConsumption() - Method in class org.kigalisim.engine.serializer.EngineResultBuilder

Get the energy consumption value.

getEnergyConsumption() - Method in class org.kigalisim.engine.state.ConverterStateGetter

Get the total energy consumption for the current state.

getEnergyConsumption() - Method in class org.kigalisim.engine.state.OverridingConverterStateGetter

Get the energy consumption value.

getEnergyConsumption() - Method in interface org.kigalisim.engine.state.StateGetter

Get the total energy consumption.

getEnergyIntensity() - Method in class org.kigalisim.engine.state.ConverterStateGetter

Get the energy consumption intensity per unit volume.

getEnergyIntensity() - Method in class org.kigalisim.engine.state.OverridingConverterStateGetter

Get the energy intensity value.

getEnergyIntensity() - Method in interface org.kigalisim.engine.state.StateGetter

Get the energy intensity.

getEnergyIntensity() - Method in class org.kigalisim.engine.state.StreamParameterization

Get the energy intensity.

getEnergyIntensity(UseKey) - Method in class org.kigalisim.engine.state.SimulationState

Get the energy intensity for a key.

getEngine() - Method in interface org.kigalisim.lang.machine.PushDownMachine

Get the engine in which this machine is running.

getEngine() - Method in class org.kigalisim.lang.machine.SingleThreadPushDownMachine

Get the engine in which this machine is running.

getEolEmissions() - Method in class org.kigalisim.engine.serializer.EngineResult

Get the greenhouse gas emissions from end-of-life equipment.

getEolEmissions() - Method in class org.kigalisim.engine.serializer.EngineResultBuilder

Get the end-of-life emissions value.

getEqualsEnergyIntensity() - Method in interface org.kigalisim.engine.Engine

Retrieve the energy intensity for the current application and substance.

getEqualsEnergyIntensity() - Method in class org.kigalisim.engine.SingleThreadEngine

getEqualsEnergyIntensityFor(UseKey) - Method in interface org.kigalisim.engine.Engine

Retrieve the energy intensity for the given UseKey.

getEqualsEnergyIntensityFor(UseKey) - Method in class org.kigalisim.engine.SingleThreadEngine

getEqualsGhgIntensity() - Method in interface org.kigalisim.engine.Engine

Retrieve the tCO2e intensity (GWP - Global Warming Potential) for the current application and substance.

getEqualsGhgIntensity() - Method in class org.kigalisim.engine.SingleThreadEngine

getEqualsGhgIntensityFor(UseKey) - Method in interface org.kigalisim.engine.Engine

Retrieve the tCO2e intensity (GWP - Global Warming Potential) for the given UseKey.

getEqualsGhgIntensityFor(UseKey) - Method in class org.kigalisim.engine.SingleThreadEngine

getError() - Method in class org.kigalisim.lang.localization.FlexibleNumberParseResult

Gets the error message if parsing failed.

getErrorMessage() - Method in class org.kigalisim.command.CommandInterpretResult

Returns the error message if interpretation failed.

getErrors() - Method in class org.kigalisim.lang.parse.ParseResult

Get the list of parsing errors.

getExport() - Method in class org.kigalisim.engine.serializer.EngineResult

Get the export value.

getExportConsumption() - Method in class org.kigalisim.engine.serializer.EngineResult

Get the export consumption value.

getExportConsumptionValue() - Method in class org.kigalisim.engine.serializer.EngineResultBuilder

Get the export consumption value.

getExportInitialChargeConsumption() - Method in class org.kigalisim.engine.serializer.TradeSupplement

Get the consumption associated with initial charge of exported equipment.

getExportInitialChargeValue() - Method in class org.kigalisim.engine.serializer.TradeSupplement

Get the volume of substance exported via initial charge on exported equipment.

getExportValue() - Method in class org.kigalisim.engine.serializer.EngineResultBuilder

Get the export value.

getForceUseFullRecharge() - Method in class org.kigalisim.engine.recalc.StreamUpdate

Gets whether to force full recharge for sales substreams.

getGhgConsumption() - Method in class org.kigalisim.engine.state.ConverterStateGetter

Get the total ghg consumption for the current state.

getGhgConsumption() - Method in class org.kigalisim.engine.state.OverridingConverterStateGetter

Get the GHG consumption value.

getGhgConsumption() - Method in interface org.kigalisim.engine.state.StateGetter

Get the total GHG consumption.

getGhgIntensity() - Method in class org.kigalisim.engine.state.StreamParameterization

Get the greenhouse gas intensity.

getGhgIntensity(UseKey) - Method in interface org.kigalisim.engine.Engine

Get the GHG intensity (GWP - Global Warming Potential) associated with a substance.

getGhgIntensity(UseKey) - Method in class org.kigalisim.engine.SingleThreadEngine

getGhgIntensity(UseKey) - Method in class org.kigalisim.engine.state.SimulationState

Get the greenhouse gas intensity for a key.

getHasReplacementThisStep() - Method in class org.kigalisim.engine.state.PriorEquipmentBases

Get whether replacement was used in this step's retire commands.

getHasReplacementThisStep() - Method in class org.kigalisim.engine.state.StreamParameterization

Get the replacement mode for this step's retire commands.

getHasReplacementThisStep(UseKey) - Method in class org.kigalisim.engine.state.SimulationState

Get the replacement mode for retire commands this step.

getImplicitRechargeStateUpdate() - Method in class org.kigalisim.engine.support.ImplicitRechargeUpdate

Gets the optional state update for the implicitRecharge stream.

getImport() - Method in class org.kigalisim.engine.serializer.EngineResult

Get the import value.

getImportConsumption() - Method in class org.kigalisim.engine.serializer.EngineResult

Get the import consumption value.

getImportConsumptionValue() - Method in class org.kigalisim.engine.serializer.EngineResultBuilder

Get the import consumption value.

getImportInitialChargeConsumption() - Method in class org.kigalisim.engine.serializer.TradeSupplement

Get the consumption associated with initial charge of imported equipment.

getImportInitialChargeValue() - Method in class org.kigalisim.engine.serializer.TradeSupplement

Get the volume of substance imported via initial charge on imported equipment.

getImportPopulation() - Method in class org.kigalisim.engine.serializer.TradeSupplement

Get the number of new units imported.

getImportValue() - Method in class org.kigalisim.engine.serializer.EngineResultBuilder

Get the import value.

getInductionRate() - Method in class org.kigalisim.engine.state.StreamParameterization

Get the induction rate percentage for recycling.

getInductionRate(UseKey) - Method in class org.kigalisim.engine.state.SimulationState

Get the induction rate percentage for recycling for a key.

getInductionRate(UseKey, RecoverOperation.RecoveryStage) - Method in class org.kigalisim.engine.state.SimulationState

Get the induction rate percentage for recycling for a key with a specific stage.

getInductionRate(RecoverOperation.RecoveryStage) - Method in class org.kigalisim.engine.state.StreamParameterization

Get the induction rate percentage for recycling for a specific stage.

getInductionStream(UseKey, RecoverOperation.RecoveryStage) - Method in class org.kigalisim.engine.state.SimulationState

Get the induction stream value for a specific recovery stage.

getInductionStream(UseKey, RecoverOperation.RecoveryStage, boolean) - Method in class org.kigalisim.engine.state.SimulationState

Get the induction stream value for a specific recovery stage.

getInitialCharge(String) - Method in interface org.kigalisim.engine.Engine

Get the initial charge value for a given stream.

getInitialCharge(String) - Method in class org.kigalisim.engine.SingleThreadEngine

getInitialCharge(String) - Method in class org.kigalisim.engine.state.StreamParameterization

Get the initial charge for a stream.

getInitialCharge(UseKey, String) - Method in class org.kigalisim.engine.state.SimulationState

Get the initial charge for a key.

getInitialChargeEmissions() - Method in class org.kigalisim.engine.serializer.EngineResult

Get the greenhouse gas emissions from initial charge activities.

getInitialChargeEmissions() - Method in class org.kigalisim.engine.serializer.EngineResultBuilder

Get the initial charge emissions value.

getInRange(int) - Method in class org.kigalisim.engine.state.YearMatcher

Determine if a year is included in this range.

getIntensity() - Method in class org.kigalisim.engine.state.RechargeInformation

Get the recharge intensity.

getInvalidatesPriorEquipment() - Method in class org.kigalisim.engine.state.SimulationStateUpdate

Gets whether this update should invalidate prior equipment cumulative bases.

getIsDone() - Method in interface org.kigalisim.engine.Engine

Determine if the engine has reached its final year.

getIsDone() - Method in class org.kigalisim.engine.SingleThreadEngine

getIsFailure() - Method in class org.kigalisim.command.CommandInterpretResult

Checks if the interpretation failed.

getIsInRange(Optional<YearMatcher>, int) - Static method in class org.kigalisim.engine.support.EngineSupportUtils

Check if a year matcher is in range for the given current year.

getIsInRange(YearMatcher, int) - Static method in class org.kigalisim.engine.support.EngineSupportUtils

Check if a year matcher is in range for the given current year.

getIsSalesStream(String, boolean) - Static method in class org.kigalisim.engine.support.EngineSupportUtils

Check if a stream is a sales-related stream.

getIsStanzaPolicyOrDefault() - Method in class org.kigalisim.lang.fragment.AboutStanzaFragment

getIsStanzaPolicyOrDefault() - Method in class org.kigalisim.lang.fragment.Fragment

Check if this fragment is a policy stanza (or default).

getIsStanzaPolicyOrDefault() - Method in class org.kigalisim.lang.fragment.PolicyFragment

getIsStanzaPolicyOrDefault() - Method in class org.kigalisim.lang.fragment.ScenariosFragment

getIsStanzaScenarios() - Method in class org.kigalisim.lang.fragment.AboutStanzaFragment

getIsStanzaScenarios() - Method in class org.kigalisim.lang.fragment.Fragment

Check if this fragment is a scenarios stanza.

getIsStanzaScenarios() - Method in class org.kigalisim.lang.fragment.PolicyFragment

getIsStanzaScenarios() - Method in class org.kigalisim.lang.fragment.ScenariosFragment

getIsSuccess() - Method in class org.kigalisim.command.CommandInterpretResult

Checks if the interpretation was successful.

getKey() - Method in class org.kigalisim.engine.recalc.StreamUpdate

Gets the optional use key specifying the application/substance scope.

getKey() - Method in class org.kigalisim.engine.state.Scope

Get a unique key for this scope based on application and substance.

getKey() - Method in class org.kigalisim.engine.state.SimpleUseKey

Gets the key string used to identify substance streams.

getKey() - Method in interface org.kigalisim.engine.state.UseKey

Gets the key string used to identify substance streams.

getLastSpecifiedValue(String) - Method in class org.kigalisim.engine.state.StreamParameterization

Get the last specified value for a stream.

getLastSpecifiedValue(UseKey, String) - Method in class org.kigalisim.engine.state.SimulationState

Get the last specified value for a stream.

getLine() - Method in class org.kigalisim.lang.parse.ParseError

Returns the line number where the parsing error occurred.

getMessage() - Method in class org.kigalisim.lang.parse.ParseError

Returns the error message describing the parsing failure.

getName() - Method in class org.kigalisim.engine.recalc.StreamUpdate

Gets the name of the stream to update.

getName() - Method in class org.kigalisim.engine.state.SimulationStateUpdate

Gets the name of the stream to set.

getName() - Method in class org.kigalisim.lang.program.ParsedApplication

Get the name of this application.

getName() - Method in class org.kigalisim.lang.program.ParsedPolicy

Get the name of this policy.

getName() - Method in class org.kigalisim.lang.program.ParsedScenario

Gets the name of the scenario.

getName() - Method in class org.kigalisim.lang.program.ParsedSubstance

Get the name of this substance.

getNewEquipment() - Method in class org.kigalisim.engine.recalc.PostRetireNewLevels

Get the new total equipment value.

getNewPrior() - Method in class org.kigalisim.engine.recalc.PostRetireNewLevels

Get the new prior equipment value.

getNewRetired() - Method in class org.kigalisim.engine.recalc.PostRetireNewLevels

Get the new retired value.

getNumberTotalTrials(ParsedProgram) - Static method in class org.kigalisim.KigaliSimFacade

Calculate the total number of trials across all scenarios in a program.

getOperation() - Method in class org.kigalisim.lang.fragment.Fragment

Get the calculation parsed from the source of this fragment.

getOperation() - Method in class org.kigalisim.lang.fragment.OperationFragment

Get the operation parsed from the source of this fragment.

getOperations() - Method in class org.kigalisim.lang.program.ParsedSubstance

Get the operations defined for this substance.

getOptimizeRecalcs() - Method in interface org.kigalisim.engine.Engine

Gets whether recalc optimizations are enabled.

getOptimizeRecalcs() - Method in class org.kigalisim.engine.SingleThreadEngine

getParsedNumber() - Method in class org.kigalisim.lang.localization.FlexibleNumberParseResult

Gets the parsed number if parsing was successful.

getPercentDomestic() - Method in class org.kigalisim.engine.recalc.SalesStreamDistribution

Get the percentage of sales attributed to domestic.

getPercentExport() - Method in class org.kigalisim.engine.recalc.SalesStreamDistribution

Get the percentage of sales attributed to export.

getPercentImport() - Method in class org.kigalisim.engine.recalc.SalesStreamDistribution

Get the percentage of sales attributed to import.

getPointValue() - Method in class org.kigalisim.lang.time.TimePointRealized

Get the specific timepoint value.

getPolicies() - Method in class org.kigalisim.lang.program.ParsedProgram

Get the names of all policies defined in this program.

getPolicies() - Method in class org.kigalisim.lang.program.ParsedScenario

Get the ordered list of policies for this scenario.

getPolicy() - Method in class org.kigalisim.lang.fragment.Fragment

Get the policy parsed from the source of this fragment.

getPolicy() - Method in class org.kigalisim.lang.fragment.PolicyFragment

Get the policy parsed from the source of this fragment.

getPolicy(String) - Method in class org.kigalisim.lang.program.ParsedProgram

Get a specific policy by name.

getPopulation() - Method in class org.kigalisim.engine.serializer.EngineResult

Get the population value.

getPopulation() - Method in class org.kigalisim.engine.state.ConverterStateGetter

Get the current equipment population.

getPopulation() - Method in class org.kigalisim.engine.state.OverridingConverterStateGetter

Get the population value.

getPopulation() - Method in class org.kigalisim.engine.state.RechargeInformation

Get the recharge population rate.

getPopulation() - Method in interface org.kigalisim.engine.state.StateGetter

Get the current population.

getPopulationChange(UnitConverter) - Method in class org.kigalisim.engine.state.ConverterStateGetter

Calculate the change in population between prior and current equipment.

getPopulationChange(UnitConverter) - Method in class org.kigalisim.engine.state.OverridingConverterStateGetter

Get the population change value.

getPopulationChange(UnitConverter) - Method in interface org.kigalisim.engine.state.StateGetter

Get the population change.

getPopulationNew() - Method in class org.kigalisim.engine.serializer.EngineResult

Get the amount of new equipment added this year.

getPopulationNew() - Method in class org.kigalisim.engine.serializer.EngineResultBuilder

Get the population new value.

getPopulationValue() - Method in class org.kigalisim.engine.serializer.EngineResultBuilder

Get the population value.

getPriorGhgConsumption() - Method in class org.kigalisim.engine.state.ConverterStateGetter

Get the prior year GHG consumption.

getPriorGhgConsumption() - Method in class org.kigalisim.engine.state.OverridingConverterStateGetter

Get the prior GHG consumption value.

getPriorGhgConsumption() - Method in interface org.kigalisim.engine.state.StateGetter

Get the prior year GHG consumption.

getPriorPopulation() - Method in class org.kigalisim.engine.state.ConverterStateGetter

Get the prior year population.

getPriorPopulation() - Method in class org.kigalisim.engine.state.OverridingConverterStateGetter

Get the prior population value.

getPriorPopulation() - Method in interface org.kigalisim.engine.state.StateGetter

Get the prior year population.

getPriorVolume() - Method in class org.kigalisim.engine.state.ConverterStateGetter

Get the prior year volume from sales stream.

getPriorVolume() - Method in class org.kigalisim.engine.state.OverridingConverterStateGetter

Get the prior volume value.

getPriorVolume() - Method in interface org.kigalisim.engine.state.StateGetter

Get the prior year volume.

getPriorYearsElapsed() - Method in class org.kigalisim.engine.state.ConverterStateGetter

Get the prior years elapsed (max of getYearsElapsed - 1 and 0).

getPriorYearsElapsed() - Method in class org.kigalisim.engine.state.OverridingConverterStateGetter

Get the prior years elapsed value.

getPriorYearsElapsed() - Method in interface org.kigalisim.engine.state.StateGetter

Get the prior years elapsed (max of getYearsElapsed - 1 and 0).

getProgram() - Method in class org.kigalisim.command.CommandInterpretResult

Returns the parsed program if interpretation succeeded.

getProgram() - Method in class org.kigalisim.lang.fragment.Fragment

Get the program parsed from the source of this fragment.

getProgram() - Method in class org.kigalisim.lang.fragment.ProgramFragment

Get the program parsed from the source of this fragment.

getProgram() - Method in class org.kigalisim.lang.parse.ParseResult

Get the parsed program.

getPropagateChanges() - Method in class org.kigalisim.engine.recalc.StreamUpdate

Gets whether this update should trigger recalculations.

getRawInitialChargeFor(UseKey, String) - Method in interface org.kigalisim.engine.Engine

Get the initial charge for a specific application and substance.

getRawInitialChargeFor(UseKey, String) - Method in class org.kigalisim.engine.SingleThreadEngine

getRechargeBasePopulation() - Method in class org.kigalisim.engine.state.PriorEquipmentBases

Get the recharge base population.

getRechargeBasePopulation() - Method in class org.kigalisim.engine.state.StreamParameterization

Get the recharge base population for cumulative calculations.

getRechargeBasePopulation(UseKey) - Method in class org.kigalisim.engine.state.SimulationState

Get the recharge base population for cumulative calculations.

getRechargeEmissions() - Method in class org.kigalisim.engine.serializer.EngineResult

Get the greenhouse gas emissions from recharge activities.

getRechargeEmissions() - Method in class org.kigalisim.engine.serializer.EngineResultBuilder

Get the recharge emissions value.

getRechargeIntensity() - Method in interface org.kigalisim.engine.Engine

Get the recharge intensity for the current application and substance.

getRechargeIntensity() - Method in class org.kigalisim.engine.SingleThreadEngine

getRechargeIntensity() - Method in class org.kigalisim.engine.state.StreamParameterization

Get the recharge intensity.

getRechargeIntensity(UseKey) - Method in class org.kigalisim.engine.state.SimulationState

Get the recharge intensity for a key.

getRechargePopulation() - Method in class org.kigalisim.engine.state.StreamParameterization

Get the recharge population percentage.

getRechargePopulation(UseKey) - Method in class org.kigalisim.engine.state.SimulationState

Get the recharge population percentage for a key.

getRechargeVolume() - Method in interface org.kigalisim.engine.Engine

Get the recharge volume for the current application and substance.

getRechargeVolume() - Method in class org.kigalisim.engine.SingleThreadEngine

getRecoveryRate() - Method in class org.kigalisim.engine.state.StreamParameterization

Get the recovery rate percentage.

getRecoveryRate(UseKey) - Method in class org.kigalisim.engine.state.SimulationState

Get the recovery rate percentage for a key.

getRecoveryRate(UseKey, RecoverOperation.RecoveryStage) - Method in class org.kigalisim.engine.state.SimulationState

Get the recovery rate percentage for a key with a specific stage.

getRecoveryRate(RecoverOperation.RecoveryStage) - Method in class org.kigalisim.engine.state.StreamParameterization

Get the recovery rate percentage for a specific stage.

getRecycle() - Method in class org.kigalisim.engine.serializer.EngineResult

Get the recycle value.

getRecycleConsumption() - Method in class org.kigalisim.engine.serializer.EngineResult

Get the recycle consumption value.

getRecycleConsumptionValue() - Method in class org.kigalisim.engine.serializer.EngineResultBuilder

Get the recycle consumption value.

getRecycleValue() - Method in class org.kigalisim.engine.serializer.EngineResultBuilder

Get the recycle value.

getRecyclingCalculatedThisStep() - Method in class org.kigalisim.engine.state.PriorEquipmentBases

Get whether recycling has been calculated this step.

getRegisteredSubstances() - Method in class org.kigalisim.engine.state.SimulationState

Get all registered substance-application pairs.

getResult() - Method in interface org.kigalisim.lang.machine.PushDownMachine

Get the result of the machine's calculations.

getResult() - Method in class org.kigalisim.lang.machine.SingleThreadPushDownMachine

Get the result of the machine's calculations.

getResult(UseKey, int) - Method in class org.kigalisim.engine.serializer.EngineResultSerializer

Serialize the results for an application and substance in a given year.

getResults() - Method in interface org.kigalisim.engine.Engine

Get the results for all registered substances.

getResults() - Method in class org.kigalisim.engine.SingleThreadEngine

getRetireCalculatedThisStep() - Method in class org.kigalisim.engine.state.PriorEquipmentBases

Get whether retire has been calculated this step.

getRetireCalculatedThisStep() - Method in class org.kigalisim.engine.state.StreamParameterization

Get whether retire has been calculated this step.

getRetireCalculatedThisStep(UseKey) - Method in class org.kigalisim.engine.state.SimulationState

Get whether retire has been calculated this step.

getRetirementBasePopulation() - Method in class org.kigalisim.engine.state.PriorEquipmentBases

Get the retirement base population.

getRetirementBasePopulation() - Method in class org.kigalisim.engine.state.StreamParameterization

Get the retirement base population for cumulative calculations.

getRetirementBasePopulation(UseKey) - Method in class org.kigalisim.engine.state.SimulationState

Get the retirement base population for cumulative calculations.

getRetirementRate() - Method in interface org.kigalisim.engine.Engine

Get the retirement rate for the current application and substance.

getRetirementRate() - Method in class org.kigalisim.engine.SingleThreadEngine

getRetirementRate() - Method in class org.kigalisim.engine.state.StreamParameterization

Get the retirement rate percentage.

getRetirementRate(UseKey) - Method in class org.kigalisim.engine.state.SimulationState

Get the retirement rate percentage for a key.

getScenario() - Method in class org.kigalisim.lang.fragment.Fragment

Get the scenario parsed from the source of this fragment.

getScenario() - Method in class org.kigalisim.lang.fragment.ScenarioFragment

Get the scenario parsed from the source of this fragment.

getScenario(String) - Method in class org.kigalisim.lang.program.ParsedProgram

Get a specific scenario by name.

getScenario(String) - Method in class org.kigalisim.lang.program.ParsedScenarios

Get a specific scenario by name.

getScenarioName() - Method in interface org.kigalisim.engine.Engine

Get the scenario name.

getScenarioName() - Method in class org.kigalisim.engine.serializer.EngineResult

Get the scenario name.

getScenarioName() - Method in class org.kigalisim.engine.serializer.EngineResultBuilder

Get the scenario name value.

getScenarioName() - Method in class org.kigalisim.engine.SingleThreadEngine

Get the scenario name.

getScenarios() - Method in class org.kigalisim.lang.fragment.Fragment

Get the scenarios parsed from the source of this fragment.

getScenarios() - Method in class org.kigalisim.lang.fragment.ScenariosFragment

getScenarios() - Method in class org.kigalisim.lang.program.ParsedProgram

Get the names of all scenarios defined in this program.

getScenarios() - Method in class org.kigalisim.lang.program.ParsedScenarios

Get the names of all scenarios defined in this simulations stanza.

getScope() - Method in interface org.kigalisim.engine.Engine

Get the engine's current scope.

getScope() - Method in class org.kigalisim.engine.SingleThreadEngine

getSeparator() - Method in class org.kigalisim.lang.localization.OnlyCommasParseStrategy

getSeparator() - Method in class org.kigalisim.lang.localization.OnlyPeriodsParseStrategy

getSeparator() - Method in class org.kigalisim.lang.localization.SingleDelimiterTemplate

Get the separator character used by this strategy.

getSeparatorCount(int, int) - Method in class org.kigalisim.lang.localization.OnlyCommasParseStrategy

getSeparatorCount(int, int) - Method in class org.kigalisim.lang.localization.OnlyPeriodsParseStrategy

getSeparatorCount(int, int) - Method in class org.kigalisim.lang.localization.SingleDelimiterTemplate

Get the count of this strategy's separator from the total counts.

getStage() - Method in class org.kigalisim.lang.operation.RecoverOperation

Get the recovery stage.

getStanza() - Method in class org.kigalisim.engine.state.Scope

Get the name of the stanza where this scope resides.

getStanzaOptional() - Method in class org.kigalisim.engine.state.Scope

Get the name of the stanza where this scope resides as an Optional.

getStart() - Method in class org.kigalisim.engine.state.YearMatcher

Get the start of the year range.

getStart() - Method in class org.kigalisim.lang.time.ParsedDuring

Get the start of the period.

getStartYear() - Method in interface org.kigalisim.engine.Engine

Get the starting year of the simulation.

getStartYear() - Method in class org.kigalisim.engine.SingleThreadEngine

getStartYear() - Method in class org.kigalisim.lang.program.ParsedScenario

Get the starting year for the simulation.

getStateGetter() - Method in interface org.kigalisim.engine.Engine

Get the state getter for converter operations.

getStateGetter() - Method in class org.kigalisim.engine.recalc.RecalcKit

Get the state getter.

getStateGetter() - Method in class org.kigalisim.engine.SingleThreadEngine

getStrategyName() - Method in class org.kigalisim.lang.localization.OnlyCommasParseStrategy

getStrategyName() - Method in class org.kigalisim.lang.localization.OnlyPeriodsParseStrategy

getStrategyName() - Method in class org.kigalisim.lang.localization.SingleDelimiterTemplate

Get the name of this strategy for error messages.

getStream() - Method in class org.kigalisim.engine.support.ChangeExecutorConfig

Gets the stream identifier.

getStream() - Method in class org.kigalisim.lang.operation.EnableOperation

Get the name of the stream this operation enables.

getStream(String) - Method in interface org.kigalisim.engine.Engine

Get the stream value with default scope and no conversion.

getStream(String) - Method in class org.kigalisim.engine.SingleThreadEngine

getStream(String, Optional<UseKey>, Optional<String>) - Method in interface org.kigalisim.engine.Engine

Get the stream value for a given application and substance key.

getStream(String, Optional<UseKey>, Optional<String>) - Method in class org.kigalisim.engine.SingleThreadEngine

getStream(UseKey, String) - Method in class org.kigalisim.engine.state.SimulationState

Get the value of a specific stream using key.

getStream(UseKey, String, boolean) - Method in class org.kigalisim.engine.state.SimulationState

Get the value of a specific stream using key from this or prior year.

getStreamFor(UseKey, String) - Method in interface org.kigalisim.engine.Engine

Get the stream value without any conversion.

getStreamFor(UseKey, String) - Method in class org.kigalisim.engine.SingleThreadEngine

getStreamKeeper() - Method in interface org.kigalisim.engine.Engine

Get the simulation state for this engine.

getStreamKeeper() - Method in class org.kigalisim.engine.recalc.RecalcKit

Get the simulation state.

getStreamKeeper() - Method in class org.kigalisim.engine.SingleThreadEngine

GetStreamOperation - Class in org.kigalisim.lang.operation

Operation to get a stream value.

GetStreamOperation(String) - Constructor for class org.kigalisim.lang.operation.GetStreamOperation

Create a new GetStreamOperation.

GetStreamOperation(String, String) - Constructor for class org.kigalisim.lang.operation.GetStreamOperation

Create a new GetStreamOperation with unit conversion.

GetStreamOperation(String, String, String) - Constructor for class org.kigalisim.lang.operation.GetStreamOperation

Create a new GetStreamOperation with scope resolution and unit conversion.

getString() - Method in class org.kigalisim.lang.fragment.Fragment

Get the string parsed from the source of this fragment.

getString() - Method in class org.kigalisim.lang.fragment.StringFragment

getSubstance() - Method in class org.kigalisim.engine.serializer.EngineResult

Get the substance.

getSubstance() - Method in class org.kigalisim.engine.serializer.EngineResultBuilder

Get the substance value.

getSubstance() - Method in class org.kigalisim.engine.state.Scope

Get the name of the substance where this scope resides.

getSubstance() - Method in class org.kigalisim.engine.state.SimpleUseKey

getSubstance() - Method in class org.kigalisim.engine.state.SubstanceInApplicationId

Get the name of the substance.

getSubstance() - Method in interface org.kigalisim.engine.state.UseKey

Get the substance name.

getSubstance() - Method in class org.kigalisim.lang.fragment.Fragment

Get the substance parsed from the source of this fragment.

getSubstance() - Method in class org.kigalisim.lang.fragment.SubstanceFragment

Get the substance parsed from the source of this fragment.

getSubstance(String) - Method in class org.kigalisim.lang.program.ParsedApplication

Get a specific substance by name.

getSubstanceConsumption() - Method in class org.kigalisim.engine.state.ConverterStateGetter

Get the consumption ratio per unit volume of substance.

getSubstanceConsumption() - Method in class org.kigalisim.engine.state.OverridingConverterStateGetter

Get the substance consumption value.

getSubstanceConsumption() - Method in interface org.kigalisim.engine.state.StateGetter

Get the substance consumption rate.

getSubstanceOptional() - Method in class org.kigalisim.engine.state.Scope

Get the name of the substance where this scope resides as an Optional.

getSubstances() - Method in class org.kigalisim.lang.program.ParsedApplication

Get the names of all substances defined in this application.

getSubtractRecycling() - Method in class org.kigalisim.engine.recalc.StreamUpdate

Gets whether recycling should be subtracted from the value.

getSubtractRecycling() - Method in class org.kigalisim.engine.state.SimulationStateUpdate

Gets whether recycling should be subtracted from the value.

getTotalInductionStream(UseKey) - Method in class org.kigalisim.engine.state.SimulationState

Get total induction across all stages.

getTotalInductionStream(UseKey, boolean) - Method in class org.kigalisim.engine.state.SimulationState

Get total induction across all stages.

getTradeSupplement() - Method in class org.kigalisim.engine.serializer.EngineResult

Get the trade supplement data.

getTradeSupplement() - Method in class org.kigalisim.engine.serializer.EngineResultBuilder

Get the trade supplement data.

getTrialNumber() - Method in interface org.kigalisim.engine.Engine

Get the trial number.

getTrialNumber() - Method in class org.kigalisim.engine.serializer.EngineResult

Get the trial number.

getTrialNumber() - Method in class org.kigalisim.engine.serializer.EngineResultBuilder

Get the trial number value.

getTrialNumber() - Method in class org.kigalisim.engine.SingleThreadEngine

Get the trial number.

getTrials() - Method in class org.kigalisim.lang.program.ParsedScenario

Get the number of trials for the simulation.

getUnit() - Method in class org.kigalisim.lang.fragment.Fragment

Get the units that should be applied to the result of a calculation or to an EngineNumber.

getUnit() - Method in class org.kigalisim.lang.fragment.UnitFragment

getUnitConverter() - Method in interface org.kigalisim.engine.Engine

Get the unit converter for this engine.

getUnitConverter() - Method in class org.kigalisim.engine.recalc.RecalcKit

Get the unit converter.

getUnitConverter() - Method in class org.kigalisim.engine.SingleThreadEngine

getUnits() - Method in class org.kigalisim.engine.number.EngineNumber

Get the units associated with this number.

getUnitsToRecord() - Method in class org.kigalisim.engine.recalc.StreamUpdate

Gets the optional units string to record for this operation.

getUseKey() - Method in class org.kigalisim.engine.state.SimulationStateUpdate

Gets the use key containing application and substance.

getUseKeyEffective() - Method in class org.kigalisim.engine.support.ChangeExecutorConfig

Gets the effective use key.

getValue() - Method in class org.kigalisim.engine.number.EngineNumber

Get the value of this number.

getValue() - Method in class org.kigalisim.engine.recalc.StreamUpdate

Gets the value to set for the stream.

getValue() - Method in class org.kigalisim.engine.state.SimulationStateUpdate

Gets the pre-calculated value to set for the stream.

getValueToSet() - Method in class org.kigalisim.engine.support.ImplicitRechargeUpdate

Gets the adjusted value to set for the stream.

getVariable(String) - Method in interface org.kigalisim.engine.Engine

Get the value of a user-defined variable in the current scope.

getVariable(String) - Method in class org.kigalisim.engine.SingleThreadEngine

getVariable(String) - Method in class org.kigalisim.engine.state.Scope

Get the value of a variable already defined.

getVariable(String) - Method in class org.kigalisim.engine.state.VariableManager

Get the value of a variable already defined.

GetVariableOperation - Class in org.kigalisim.lang.operation

Operation that retrieves a variable's value from the engine.

GetVariableOperation(String) - Constructor for class org.kigalisim.lang.operation.GetVariableOperation

Create a new GetVariableOperation.

getVersion() - Static method in class org.kigalisim.KigaliWasmSimFacade

Returns the version of KigaliSim.

getVolume() - Method in class org.kigalisim.engine.state.ConverterStateGetter

Get the total volume from sales for the current state.

getVolume() - Method in class org.kigalisim.engine.state.OverridingConverterStateGetter

Get the volume value.

getVolume() - Method in interface org.kigalisim.engine.state.StateGetter

Get the current volume.

getWithApplication(String) - Method in class org.kigalisim.engine.state.Scope

Create a new scope derived from this scope at the application level.

getWithLevel(int) - Method in class org.kigalisim.engine.state.VariableManager

Make a new variable manager occupying this namespace but at a different context level.

getWithStanza(String) - Method in class org.kigalisim.engine.state.Scope

Create a new scope derived from this scope at the stanza level.

getWithSubstance(String) - Method in class org.kigalisim.engine.state.Scope

Create a new scope derived from this scope at the substance level.

getYear() - Method in interface org.kigalisim.engine.Engine

Get the year that the engine is currently simulating.

getYear() - Method in class org.kigalisim.engine.serializer.EngineResult

Get the year the result is relevant to.

getYear() - Method in class org.kigalisim.engine.serializer.EngineResultBuilder

Get the year value.

getYear() - Method in class org.kigalisim.engine.SingleThreadEngine

getYearMatcher() - Method in class org.kigalisim.engine.recalc.StreamUpdate

Gets the optional year matcher constraining when this update applies.

getYearMatcher() - Method in class org.kigalisim.engine.support.ChangeExecutorConfig

Gets the year matcher.

getYearsElapsed() - Method in class org.kigalisim.engine.state.ConverterStateGetter

Get number of years in the simulation since the last step.

getYearsElapsed() - Method in class org.kigalisim.engine.state.OverridingConverterStateGetter

Get the years elapsed value.

getYearsElapsed() - Method in interface org.kigalisim.engine.state.StateGetter

Get the years elapsed.

getYieldRate() - Method in class org.kigalisim.engine.state.StreamParameterization

Get the yield rate percentage for recycling.

getYieldRate(UseKey) - Method in class org.kigalisim.engine.state.SimulationState

Get the yield rate percentage for recycling for a key.

getYieldRate(UseKey, RecoverOperation.RecoveryStage) - Method in class org.kigalisim.engine.state.SimulationState

Get the yield rate percentage for recycling for a key with a specific stage.

getYieldRate(RecoverOperation.RecoveryStage) - Method in class org.kigalisim.engine.state.StreamParameterization

Get the yield rate percentage for recycling for a specific stage.

GLOBAL_CONTEXT - Static variable in class org.kigalisim.engine.state.EngineConstants

Global context level for variables accessible throughout the system.

greaterThan() - Method in interface org.kigalisim.lang.machine.PushDownMachine

Perform a greater-than comparison on the two numbers on top of the stack.

greaterThan() - Method in class org.kigalisim.lang.machine.SingleThreadPushDownMachine

Perform a greater-than comparison on the two numbers on top of the stack.

greaterThanOrEqual() - Method in interface org.kigalisim.lang.machine.PushDownMachine

Perform a greater-than-or-equal comparison on the two numbers on top of the stack.

greaterThanOrEqual() - Method in class org.kigalisim.lang.machine.SingleThreadPushDownMachine

Perform a greater-than-or-equal comparison on the two numbers on top of the stack.

H

handleAmbiguousCase(String, char, int, int) - Method in class org.kigalisim.lang.localization.OnlyCommasParseStrategy

handleAmbiguousCase(String, char, int, int) - Method in class org.kigalisim.lang.localization.OnlyPeriodsParseStrategy

handleAmbiguousCase(String, char, int, int) - Method in class org.kigalisim.lang.localization.SingleDelimiterTemplate

Handle ambiguous case where exactly 3 digits follow a single separator.

handleCap(EngineNumber, String) - Method in class org.kigalisim.engine.support.EquipmentChangeUtil

Handle capping equipment to a maximum value.

handleChange(EngineNumber) - Method in class org.kigalisim.engine.support.EquipmentChangeUtil

Handle changing equipment by a delta amount.

handleFloor(EngineNumber, String) - Method in class org.kigalisim.engine.support.EquipmentChangeUtil

Handle flooring equipment to a minimum value.

handleImplicitRecharge(UseKey, String, EngineNumber, boolean, boolean, boolean) - Method in class org.kigalisim.engine.support.StreamUpdateExecutor

Handles implicit recharge logic for sales streams with equipment units.

handleLeadingSeparator(String) - Method in class org.kigalisim.lang.localization.OnlyCommasParseStrategy

handleLeadingSeparator(String) - Method in class org.kigalisim.lang.localization.OnlyPeriodsParseStrategy

handleLeadingSeparator(String) - Method in class org.kigalisim.lang.localization.SingleDelimiterTemplate

Handle numbers with a leading separator.

handleMultipleSeparators(String, char) - Method in class org.kigalisim.lang.localization.OnlyCommasParseStrategy

handleMultipleSeparators(String, char) - Method in class org.kigalisim.lang.localization.OnlyPeriodsParseStrategy

handleMultipleSeparators(String, char) - Method in class org.kigalisim.lang.localization.SingleDelimiterTemplate

Handle numbers with multiple separators.

handleSalesSet(UseKey, String, EngineNumber, Optional<YearMatcher>) - Method in class org.kigalisim.engine.support.SetExecutor

Handle sales stream setting by distributing to component streams.

handleSet(EngineNumber) - Method in class org.kigalisim.engine.support.EquipmentChangeUtil

Handle setting equipment to a target value.

handleSingleNonAmbiguous(String) - Method in class org.kigalisim.lang.localization.OnlyCommasParseStrategy

handleSingleNonAmbiguous(String) - Method in class org.kigalisim.lang.localization.OnlyPeriodsParseStrategy

handleSingleNonAmbiguous(String) - Method in class org.kigalisim.lang.localization.SingleDelimiterTemplate

Handle numbers where the separator separates digits in a non-3-digit pattern.

handleSingleSeparatorType(String, char, int) - Method in class org.kigalisim.lang.localization.SingleDelimiterTemplate

Handle numbers with only one type of separator.

hasEquipmentUnits() - Method in class org.kigalisim.engine.number.EngineNumber

Check if this number has equipment units.

hasErrors() - Method in class org.kigalisim.lang.parse.ParseResult

Determine if there were errors during parsing.

hasLastSpecifiedValue(String) - Method in class org.kigalisim.engine.state.StreamParameterization

Check if a stream has a last specified value.

hasLastSpecifiedValue(UseKey, String) - Method in class org.kigalisim.engine.state.SimulationState

Check if a stream has a last specified value.

hasStreamBeenEnabled(String) - Method in class org.kigalisim.engine.state.StreamParameterization

Check if a stream has ever been enabled (set to non-zero value).

hasStreamBeenEnabled(UseKey, String) - Method in class org.kigalisim.engine.state.SimulationState

Check if a stream has ever been enabled (set to non-zero value).

hasStreamsEnabled(UseKey) - Method in class org.kigalisim.engine.state.SimulationState

Check if any sales streams have been enabled for the given substance/application.

hasSubstance(UseKey) - Method in class org.kigalisim.engine.state.SimulationState

Check if a substance exists for a key.

hasUnitBasedSalesSpecifications(SimulationState, UseKey) - Static method in class org.kigalisim.engine.support.EngineSupportUtils

Check if sales streams were specified in equipment units for the given scope.

I

ImplicitRechargeUpdate - Class in org.kigalisim.engine.support

Immutable result of implicit recharge calculation.

ImplicitRechargeUpdate(EngineNumber, Optional<SimulationStateUpdate>) - Constructor for class org.kigalisim.engine.support.ImplicitRechargeUpdate

Creates a new ImplicitRechargeUpdate with the specified values.

incrementYear() - Method in interface org.kigalisim.engine.Engine

Increment the engine to simulate the next year.

incrementYear() - Method in class org.kigalisim.engine.SingleThreadEngine

incrementYear() - Method in class org.kigalisim.engine.state.SimulationState

Increment the year, updating populations and resetting internal params.

inferSubtractRecycling() - Method in class org.kigalisim.engine.recalc.StreamUpdateBuilder

Infers the subtractRecycling flag based on stream name and value units.

InitialChargeOperation - Class in org.kigalisim.lang.operation

Operation that sets an initial charge value for a stream in the engine.

InitialChargeOperation(String, Operation) - Constructor for class org.kigalisim.lang.operation.InitialChargeOperation

Create a new InitialChargeOperation that applies to all years.

InitialChargeOperation(String, Operation, ParsedDuring) - Constructor for class org.kigalisim.lang.operation.InitialChargeOperation

Create a new InitialChargeOperation that applies to a specific time period.

interpret(ParseResult) - Static method in class org.kigalisim.KigaliSimFacade

Interpret a parsed QubecTalk script to Java objects which can run the simulation.

interpret(ParseResult) - Method in class org.kigalisim.lang.interpret.QubecTalkInterpreter

Interpret a QubecTalk source into a ParsedProgram.

isDynamicCap() - Method in class org.kigalisim.lang.time.TimePointRealized

Determine if the user requested the dynamic cap value.

isError() - Method in class org.kigalisim.lang.localization.FlexibleNumberParseResult

Returns true if parsing failed.

isFirstRetire() - Method in class org.kigalisim.engine.recalc.RetireBackgroundInfo

Check if this is the first retirement operation.

isKnownStream(UseKey, String) - Method in class org.kigalisim.engine.state.SimulationState

Check if a stream exists for a key.

isLikelyThousandsSeparator(String, int) - Method in class org.kigalisim.lang.localization.SingleDelimiterTemplate

Determine if a single separator with 3 digits after is likely a thousands separator.

isRecyclingCalculatedThisStep() - Method in class org.kigalisim.engine.state.StreamParameterization

Get whether recycling has been calculated this step.

isRecyclingCalculatedThisStep(UseKey) - Method in class org.kigalisim.engine.state.SimulationState

Get whether recycling has been calculated this step.

isSalesDistributionRequired() - Method in class org.kigalisim.engine.state.SimulationStateUpdate

Gets whether this stream requires sales distribution logic.

isSalesIntentFreshlySet() - Method in class org.kigalisim.engine.state.StreamParameterization

Check if sales intent has been freshly set in the current processing cycle.

isSalesIntentFreshlySet(UseKey) - Method in class org.kigalisim.engine.state.SimulationState

Check if sales intent has been freshly set for the given scope.

isSalesSubstream(String) - Static method in class org.kigalisim.engine.support.EngineSupportUtils

Check if a stream name represents a sales substream (domestic or import).

isSuccess() - Method in class org.kigalisim.lang.localization.FlexibleNumberParseResult

Returns true if parsing was successful.

J

JointOperation - Class in org.kigalisim.lang.operation

Conjunction operation which performs one operation followed by another.

JointOperation(Operation, Operation) - Constructor for class org.kigalisim.lang.operation.JointOperation

Create a new joint operation which persoms one followed by another.

K

KigaliSimCommander - Class in org.kigalisim

Entry point for the KigaliSim command line.

KigaliSimCommander() - Constructor for class org.kigalisim.KigaliSimCommander

Constructs a new KigaliSimCommander.

KigaliSimFacade - Class in org.kigalisim

Entry point into the Kigali platform when used as a library.

KigaliSimFacade() - Constructor for class org.kigalisim.KigaliSimFacade

Constructs a new KigaliSimFacade.

KigaliWasmSimFacade - Class in org.kigalisim

Facade which offers access to JS clients.

KigaliWasmSimFacade() - Constructor for class org.kigalisim.KigaliWasmSimFacade

Constructs a new KigaliWasmSimFacade.

L

lessThan() - Method in interface org.kigalisim.lang.machine.PushDownMachine

Perform a less-than comparison on the two numbers on top of the stack.

lessThan() - Method in class org.kigalisim.lang.machine.SingleThreadPushDownMachine

Perform a less-than comparison on the two numbers on top of the stack.

lessThanOrEqual() - Method in interface org.kigalisim.lang.machine.PushDownMachine

Perform a less-than-or-equal comparison on the two numbers on top of the stack.

lessThanOrEqual() - Method in class org.kigalisim.lang.machine.SingleThreadPushDownMachine

Perform a less-than-or-equal comparison on the two numbers on top of the stack.

LimitExecutor - Class in org.kigalisim.engine.support

Executor for cap and floor limit operations on streams.

LimitExecutor(Engine) - Constructor for class org.kigalisim.engine.support.LimitExecutor

Creates a new LimitExecutor for the given engine.

LimitOperation - Class in org.kigalisim.lang.operation

Operation to limit a value to a range.

LimitOperation(Operation, Operation) - Constructor for class org.kigalisim.lang.operation.LimitOperation

Create a new LimitOperation with only an upper bound.

LimitOperation(Operation, Operation, boolean) - Constructor for class org.kigalisim.lang.operation.LimitOperation

Create a new LimitOperation with only a lower bound.

LimitOperation(Operation, Operation, Operation) - Constructor for class org.kigalisim.lang.operation.LimitOperation

Create a new LimitOperation with both lower and upper bounds.

LogicalOperation - Class in org.kigalisim.lang.operation

Calculation that performs a logical operation on two other calculations.

LogicalOperation(Operation, Operation, String) - Constructor for class org.kigalisim.lang.operation.LogicalOperation

Create a new LogicalOperation.

M

main(String[]) - Static method in class org.kigalisim.KigaliSimCommander

Main entry point for the KigaliSim command line interface.

main(String[]) - Static method in class org.kigalisim.KigaliWasmSimFacade

Required entrypoint for wasm.

markStreamAsEnabled(String) - Method in class org.kigalisim.engine.state.StreamParameterization

Mark a stream as having been enabled (set to non-zero value).

markStreamAsEnabled(UseKey, String) - Method in class org.kigalisim.engine.state.SimulationState

Mark a stream as having been enabled (set to non-zero value).

MixedParseStrategy - Class in org.kigalisim.lang.localization

Parse strategy for numbers with both comma and period separators.

MixedParseStrategy() - Constructor for class org.kigalisim.lang.localization.MixedParseStrategy

Constructs a new MixedParseStrategy.

MultiplicationOperation - Class in org.kigalisim.lang.operation

Calculation that multiplies two other calculations together.

MultiplicationOperation(Operation, Operation) - Constructor for class org.kigalisim.lang.operation.MultiplicationOperation

Create a new MultiplicationOperation.

multiply() - Method in interface org.kigalisim.lang.machine.PushDownMachine

Multiply the two numbers on top of the stack.

multiply() - Method in class org.kigalisim.lang.machine.SingleThreadPushDownMachine

Multiply the two numbers on top of the stack.

N

normalize(String) - Static method in class org.kigalisim.util.UnitStringNormalizer

Remove all whitespace from a unit string.

notEquals() - Method in interface org.kigalisim.lang.machine.PushDownMachine

Perform a not-equals comparison on the two numbers on top of the stack.

notEquals() - Method in class org.kigalisim.lang.machine.SingleThreadPushDownMachine

Perform a not-equals comparison on the two numbers on top of the stack.

NumberParseUtil - Class in org.kigalisim.lang.localization

Utility for parsing numbers with flexible thousands and decimal separators.

NumberParseUtil() - Constructor for class org.kigalisim.lang.localization.NumberParseUtil

Constructor that initializes the parsing strategies.

NumberParseUtilStrategy - Interface in org.kigalisim.lang.localization

Strategy for parsing numbers with specific separator patterns.

O

OnlyCommasParseStrategy - Class in org.kigalisim.lang.localization

Parse strategy for numbers with only comma separators.

OnlyCommasParseStrategy() - Constructor for class org.kigalisim.lang.localization.OnlyCommasParseStrategy

Constructs a new OnlyCommasParseStrategy.

OnlyPeriodsParseStrategy - Class in org.kigalisim.lang.localization

Parse strategy for numbers with only period separators.

OnlyPeriodsParseStrategy() - Constructor for class org.kigalisim.lang.localization.OnlyPeriodsParseStrategy

Constructs a new OnlyPeriodsParseStrategy.

Operation - Interface in org.kigalisim.lang.operation

Description of a calculation which can be resolved to an EngineNumber at QubecTalk runtime.

OperationFragment - Class in org.kigalisim.lang.fragment

A fragment containing only a calculation.

OperationFragment(Operation) - Constructor for class org.kigalisim.lang.fragment.OperationFragment

Create a new fragment containing an operation.

or() - Method in interface org.kigalisim.lang.machine.PushDownMachine

Perform a logical OR operation on the two numbers on top of the stack.

or() - Method in class org.kigalisim.lang.machine.SingleThreadPushDownMachine

Perform a logical OR operation on the two numbers on top of the stack.

org.kigalisim - package org.kigalisim

Kigali Sim Java

org.kigalisim.command - package org.kigalisim.command

org.kigalisim.engine - package org.kigalisim.engine

Kigali Sim Engine

org.kigalisim.engine.number - package org.kigalisim.engine.number

org.kigalisim.engine.recalc - package org.kigalisim.engine.recalc

org.kigalisim.engine.serializer - package org.kigalisim.engine.serializer

org.kigalisim.engine.state - package org.kigalisim.engine.state

org.kigalisim.engine.support - package org.kigalisim.engine.support

org.kigalisim.lang - package org.kigalisim.lang

Kigali Sim Lang

org.kigalisim.lang.fragment - package org.kigalisim.lang.fragment

org.kigalisim.lang.interpret - package org.kigalisim.lang.interpret

org.kigalisim.lang.localization - package org.kigalisim.lang.localization

org.kigalisim.lang.machine - package org.kigalisim.lang.machine

org.kigalisim.lang.operation - package org.kigalisim.lang.operation

org.kigalisim.lang.parse - package org.kigalisim.lang.parse

org.kigalisim.lang.program - package org.kigalisim.lang.program

org.kigalisim.lang.time - package org.kigalisim.lang.time

org.kigalisim.lang.validation - package org.kigalisim.lang.validation

org.kigalisim.util - package org.kigalisim.util

Kigali Sim Util

OverridingConverterStateGetter - Class in org.kigalisim.engine.state

State getter that allows overriding values from an inner state getter.

OverridingConverterStateGetter(StateGetter) - Constructor for class org.kigalisim.engine.state.OverridingConverterStateGetter

Create a new overriding converter state getter.

P

parse(String) - Static method in class org.kigalisim.KigaliSimFacade

Parse a QubecTalk script.

parseAndInterpret(String) - Static method in class org.kigalisim.KigaliSimFacade

Parse and interpret a QubecTalk script from a file.

ParsedApplication - Class in org.kigalisim.lang.program

Record of an application parsed from the source of a QubecTalk program.

ParsedApplication(String, Iterable<ParsedSubstance>) - Constructor for class org.kigalisim.lang.program.ParsedApplication

Create a new record of an application.

ParsedDuring - Class in org.kigalisim.lang.time

Description of a "during" time period described in QubecTalk.

ParsedDuring(Optional<TimePointFuture>, Optional<TimePointFuture>) - Constructor for class org.kigalisim.lang.time.ParsedDuring

Create a description of a "during" time period.

ParsedPolicy - Class in org.kigalisim.lang.program

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

ParsedPolicy(String, Iterable<ParsedApplication>) - Constructor for class org.kigalisim.lang.program.ParsedPolicy

Create a new record of a policy.

ParsedProgram - Class in org.kigalisim.lang.program

Result of parsing (interpreting / compiling) a QubecTalk program.

ParsedProgram(Iterable<ParsedPolicy>, Iterable<ParsedScenario>) - Constructor for class org.kigalisim.lang.program.ParsedProgram

Create a new record of a parsed program.

ParsedScenario - Class in org.kigalisim.lang.program

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

ParsedScenario(String, List<String>, int, int, int) - Constructor for class org.kigalisim.lang.program.ParsedScenario

Create a new record of a scenario.

ParsedScenarios - Class in org.kigalisim.lang.program

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

ParsedScenarios(Iterable<ParsedScenario>) - Constructor for class org.kigalisim.lang.program.ParsedScenarios

Create a new record of scenarios.

ParsedSubstance - Class in org.kigalisim.lang.program

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

ParsedSubstance(String, List<Operation>) - Constructor for class org.kigalisim.lang.program.ParsedSubstance

Create a new record of a substance.

ParseError - Class in org.kigalisim.lang.parse

Description of an error encountered in parsing a QubecTalk source file or string.

ParseError(int, String) - Constructor for class org.kigalisim.lang.parse.ParseError

Constructs a new ParseError with the specified line number and message.

parseFlexibleNumber(String) - Method in class org.kigalisim.lang.localization.NumberParseUtil

Parse a number string with flexible thousands and decimal separators.

parseNumber(String, int, int) - Method in class org.kigalisim.lang.localization.MixedParseStrategy

parseNumber(String, int, int) - Method in interface org.kigalisim.lang.localization.NumberParseUtilStrategy

Parse a number string using this strategy's specific rules.

parseNumber(String, int, int) - Method in class org.kigalisim.lang.localization.SingleDelimiterTemplate

ParserErrorListener - Class in org.kigalisim.lang.parse

Listener for ANTLR errors in parsing.

ParserErrorListener(List<ParseError>) - Constructor for class org.kigalisim.lang.parse.ParserErrorListener

Create a new listener for errors encountered in ANTLR parsing.

ParseResult - Class in org.kigalisim.lang.parse

Result of parsing a QubecTalk source code file.

ParseResult(List<ParseError>) - Constructor for class org.kigalisim.lang.parse.ParseResult

Constructs a ParseResult with the specified errors and no program.

ParseResult(QubecTalkParser.ProgramContext) - Constructor for class org.kigalisim.lang.parse.ParseResult

Constructs a ParseResult with the specified program and no errors.

PolicyFragment - Class in org.kigalisim.lang.fragment

A fragment containing a parsed policy.

PolicyFragment(ParsedPolicy) - Constructor for class org.kigalisim.lang.fragment.PolicyFragment

Create a new fragment containing a parsed policy.

PopulationChangeRecalcStrategy - Class in org.kigalisim.engine.recalc

Strategy for recalculating population changes.

PopulationChangeRecalcStrategy(Optional<UseKey>, Optional<Boolean>) - Constructor for class org.kigalisim.engine.recalc.PopulationChangeRecalcStrategy

Create a new PopulationChangeRecalcStrategy.

PostRetireNewLevels - Class in org.kigalisim.engine.recalc

Immutable container for post-retirement stream values.

PostRetireNewLevels(EngineNumber, EngineNumber, EngineNumber) - Constructor for class org.kigalisim.engine.recalc.PostRetireNewLevels

Create a new PostRetireNewLevels.

power() - Method in interface org.kigalisim.lang.machine.PushDownMachine

Raise a number to a power.

power() - Method in class org.kigalisim.lang.machine.SingleThreadPushDownMachine

Raise a number to a power.

PowerOperation - Class in org.kigalisim.lang.operation

Calculation that raises one number to the power of another.

PowerOperation(Operation, Operation) - Constructor for class org.kigalisim.lang.operation.PowerOperation

Create a new PowerOperation.

PreCalculatedOperation - Class in org.kigalisim.lang.operation

Description of a calculation that has already been resolved to an EngineNumber.

PreCalculatedOperation(EngineNumber) - Constructor for class org.kigalisim.lang.operation.PreCalculatedOperation

Create a new PreCalculatedOperation.

PriorEquipmentBases - Class in org.kigalisim.engine.state

State supporting cumulative retirement / recharge base tracking (prior equip).

PriorEquipmentBases() - Constructor for class org.kigalisim.engine.state.PriorEquipmentBases

Create a new PriorEquipmentBases instance with default values.

ProgramFragment - Class in org.kigalisim.lang.fragment

A fragment containing a parsed program.

ProgramFragment(ParsedProgram) - Constructor for class org.kigalisim.lang.fragment.ProgramFragment

Create a new fragment containing a parsed program.

ProgressReportCallback - Interface in org.kigalisim

Callback interface for reporting simulation progress during execution.

propagateChanges(UseKey, String, boolean, boolean) - Method in class org.kigalisim.engine.support.StreamUpdateExecutor

Propagates stream changes to dependent calculations based on stream type.

push(EngineNumber) - Method in interface org.kigalisim.lang.machine.PushDownMachine

Push a number onto the machine's stack.

push(EngineNumber) - Method in class org.kigalisim.lang.machine.SingleThreadPushDownMachine

Push a number onto the machine's stack.

PushDownMachine - Interface in org.kigalisim.lang.machine

A push down automaton which can perform mathematical and logical operations for QubecTalk.

Q

QubecTalkEngineVisitor - Class in org.kigalisim.lang

Visitor which interprets QubecTalk parsed code into Commands through Fragments.

QubecTalkEngineVisitor() - Constructor for class org.kigalisim.lang.QubecTalkEngineVisitor

Constructs a new QubecTalkEngineVisitor.

QubecTalkInterpreter - Class in org.kigalisim.lang.interpret

Strategy to interpret a QubecTalk program into a single ParsedProgram.

QubecTalkInterpreter() - Constructor for class org.kigalisim.lang.interpret.QubecTalkInterpreter

Constructs a new QubecTalkInterpreter.

R

raiseNoAppOrSubstance(String, String) - Static method in class org.kigalisim.engine.support.ExceptionsGenerator

Raise an exception for missing application or substance.

raiseSelfDisplacement(String) - Static method in class org.kigalisim.engine.support.ExceptionsGenerator

Raise an exception for attempted self-displacement.

raiseSelfReplacement(String) - Static method in class org.kigalisim.engine.support.ExceptionsGenerator

Raise an exception for attempted self-replacement.

realize(PushDownMachine) - Method in class org.kigalisim.lang.time.CalculatedTimePointFuture

realize(PushDownMachine) - Method in class org.kigalisim.lang.time.DynamicCapFuture

realize(PushDownMachine) - Method in interface org.kigalisim.lang.time.TimePointFuture

Realize the time point using the given machine.

recalcConsumption() - Method in class org.kigalisim.engine.recalc.RecalcOperationBuilder

Add consumption recalculation to the operation sequence.

recalcEolEmissions() - Method in class org.kigalisim.engine.recalc.RecalcOperationBuilder

Add end-of-life emissions recalculation to the operation sequence.

RecalcKit - Class in org.kigalisim.engine.recalc

Container for dependencies needed by recalculation strategies.

RecalcKit(SimulationState, UnitConverter, StateGetter) - Constructor for class org.kigalisim.engine.recalc.RecalcKit

Create a new RecalcKit.

RecalcKitBuilder - Class in org.kigalisim.engine.recalc

Builder for creating RecalcKit instances.

RecalcKitBuilder() - Constructor for class org.kigalisim.engine.recalc.RecalcKitBuilder

Create a new RecalcKitBuilder.

RecalcOperation - Class in org.kigalisim.engine.recalc

Operation that executes a sequence of recalculation strategies.

RecalcOperation(List<RecalcStrategy>, RecalcKit, boolean) - Constructor for class org.kigalisim.engine.recalc.RecalcOperation

Create a new RecalcOperation with the given strategies and RecalcKit.

RecalcOperationBuilder - Class in org.kigalisim.engine.recalc

Builder for creating RecalcOperation instances with fluent interface.

RecalcOperationBuilder() - Constructor for class org.kigalisim.engine.recalc.RecalcOperationBuilder

Create a new RecalcOperationBuilder.

recalcPopulationChange() - Method in class org.kigalisim.engine.recalc.RecalcOperationBuilder

Add population change recalculation to the operation sequence.

recalcRechargeEmissions() - Method in class org.kigalisim.engine.recalc.RecalcOperationBuilder

Add recharge emissions recalculation to the operation sequence.

recalcRetire() - Method in class org.kigalisim.engine.recalc.RecalcOperationBuilder

Add retirement recalculation to the operation sequence.

recalcSales() - Method in class org.kigalisim.engine.recalc.RecalcOperationBuilder

Add sales recalculation to the operation sequence.

RecalcStrategy - Interface in org.kigalisim.engine.recalc

Strategy interface for recalculation operations.

recharge(EngineNumber, EngineNumber, YearMatcher) - Method in interface org.kigalisim.engine.Engine

Set recharge parameters for the current application and substance.

recharge(EngineNumber, EngineNumber, YearMatcher) - Method in class org.kigalisim.engine.SingleThreadEngine

RECHARGE - Enum constant in enum class org.kigalisim.lang.operation.RecoverOperation.RecoveryStage

Recovery during recharge (servicing).

RechargeEmissionsRecalcStrategy - Class in org.kigalisim.engine.recalc

Strategy for recalculating recharge emissions.

RechargeEmissionsRecalcStrategy(Optional<UseKey>) - Constructor for class org.kigalisim.engine.recalc.RechargeEmissionsRecalcStrategy

Create a new RechargeEmissionsRecalcStrategy.

RechargeInformation - Class in org.kigalisim.engine.state

Immutable structure holding recharge population and intensity information.

RechargeInformation(EngineNumber, EngineNumber) - Constructor for class org.kigalisim.engine.state.RechargeInformation

Create a new RechargeInformation instance.

RechargeOperation - Class in org.kigalisim.lang.operation

Operation that recharges equipment with a specified volume and intensity.

RechargeOperation(Operation, Operation) - Constructor for class org.kigalisim.lang.operation.RechargeOperation

Create a new RechargeOperation that applies to all years.

RechargeOperation(Operation, Operation, ParsedDuring) - Constructor for class org.kigalisim.lang.operation.RechargeOperation

Create a new RechargeOperation that applies to a specific time period.

RechargeVolumeCalculator - Class in org.kigalisim.engine.support

Calculator for recharge volume operations.

RechargeVolumeCalculator() - Constructor for class org.kigalisim.engine.support.RechargeVolumeCalculator

Constructs a new RechargeVolumeCalculator.

RecoverOperation - Class in org.kigalisim.lang.operation

Operation that recovers a percentage or amount of refrigerant.

RecoverOperation(Operation, Operation) - Constructor for class org.kigalisim.lang.operation.RecoverOperation

Create a new RecoverOperation that applies to all years.

RecoverOperation(Operation, Operation, Optional<Operation>) - Constructor for class org.kigalisim.lang.operation.RecoverOperation

Create a new RecoverOperation that applies to all years with induction.

RecoverOperation(Operation, Operation, RecoverOperation.RecoveryStage) - Constructor for class org.kigalisim.lang.operation.RecoverOperation

Create a new RecoverOperation that applies to all years with stage.

RecoverOperation(Operation, Operation, RecoverOperation.RecoveryStage, Optional<Operation>) - Constructor for class org.kigalisim.lang.operation.RecoverOperation

Create a new RecoverOperation that applies to all years with stage and induction.

RecoverOperation(Operation, Operation, ParsedDuring) - Constructor for class org.kigalisim.lang.operation.RecoverOperation

Create a new RecoverOperation that applies to a specific time period.

RecoverOperation(Operation, Operation, ParsedDuring, Optional<Operation>) - Constructor for class org.kigalisim.lang.operation.RecoverOperation

Create a new RecoverOperation that applies to a specific time period with induction.

RecoverOperation(Operation, Operation, ParsedDuring, RecoverOperation.RecoveryStage) - Constructor for class org.kigalisim.lang.operation.RecoverOperation

Create a new RecoverOperation that applies to a specific time period with stage.

RecoverOperation(Operation, Operation, ParsedDuring, RecoverOperation.RecoveryStage, Optional<Operation>) - Constructor for class org.kigalisim.lang.operation.RecoverOperation

Create a new RecoverOperation that applies to a specific time period with stage and induction.

RecoverOperation.RecoveryStage - Enum Class in org.kigalisim.lang.operation

Enum representing the stage of recovery.

recycle(EngineNumber, EngineNumber, YearMatcher, RecoverOperation.RecoveryStage) - Method in interface org.kigalisim.engine.Engine

Set recycling parameters for the current application and substance.

recycle(EngineNumber, EngineNumber, YearMatcher, RecoverOperation.RecoveryStage) - Method in class org.kigalisim.engine.SingleThreadEngine

RECYCLE_RECOVER_STREAM - Static variable in class org.kigalisim.engine.support.EngineSupportUtils

The stream used for recycled material recovery operations.

RemoveUnitsOperation - Class in org.kigalisim.lang.operation

Operation which maintains the same value but forces a change to units.

RemoveUnitsOperation() - Constructor for class org.kigalisim.lang.operation.RemoveUnitsOperation

replace(EngineNumber, String, String, YearMatcher) - Method in interface org.kigalisim.engine.Engine

Replace an amount from one substance with another.

replace(EngineNumber, String, String, YearMatcher) - Method in class org.kigalisim.engine.SingleThreadEngine

ReplaceExecutor - Class in org.kigalisim.engine.support

Handles substance replacement operations.

ReplaceExecutor(Engine) - Constructor for class org.kigalisim.engine.support.ReplaceExecutor

Creates a new ReplaceExecutor for the given engine.

ReplaceOperation - Class in org.kigalisim.lang.operation

Operation that replaces a substance with another substance.

ReplaceOperation(Operation, String, String) - Constructor for class org.kigalisim.lang.operation.ReplaceOperation

Create a new ReplaceOperation that applies to all years.

ReplaceOperation(Operation, String, String, ParsedDuring) - Constructor for class org.kigalisim.lang.operation.ReplaceOperation

Create a new ReplaceOperation that applies to a specific time period.

reportProgress(double) - Method in interface org.kigalisim.ProgressReportCallback

Reports the current progress of the simulation.

resetInductionRate(RecoverOperation.RecoveryStage) - Method in interface org.kigalisim.engine.Engine

Reset the induction rate to default behavior for recycling operations.

resetInductionRate(RecoverOperation.RecoveryStage) - Method in class org.kigalisim.engine.SingleThreadEngine

resetSalesIntentFlag(UseKey) - Method in class org.kigalisim.engine.state.SimulationState

Reset the sales intent flag for the given scope.

resetStateAtTimestep() - Method in class org.kigalisim.engine.state.PriorEquipmentBases

Reset all tracking state at the beginning of a timestep.

resetStateAtTimestep() - Method in class org.kigalisim.engine.state.StreamParameterization

Reset state at the beginning of a timestep.

retire(EngineNumber, YearMatcher) - Method in interface org.kigalisim.engine.Engine

Set retirement rate for the current application and substance.

retire(EngineNumber, YearMatcher) - Method in class org.kigalisim.engine.SingleThreadEngine

RetireBackgroundInfo - Class in org.kigalisim.engine.recalc

Immutable container for retirement background state information.

RetireBackgroundInfo(EngineNumber, EngineNumber, EngineNumber, EngineNumber, boolean) - Constructor for class org.kigalisim.engine.recalc.RetireBackgroundInfo

Create a new RetireBackgroundInfo.

RetireOperation - Class in org.kigalisim.lang.operation

Operation that retires a percentage of equipment each year.

RetireOperation(Operation) - Constructor for class org.kigalisim.lang.operation.RetireOperation

Create a new RetireOperation that applies to all years.

RetireOperation(Operation, ParsedDuring) - Constructor for class org.kigalisim.lang.operation.RetireOperation

Create a new RetireOperation that applies to a specific time period.

RetireRecalcStrategy - Class in org.kigalisim.engine.recalc

Strategy for recalculating retirement.

RetireRecalcStrategy(Optional<UseKey>) - Constructor for class org.kigalisim.engine.recalc.RetireRecalcStrategy

Create a new RetireRecalcStrategy.

RetireWithReplacementOperation - Class in org.kigalisim.lang.operation

Operation that retires equipment and immediately replaces it by increasing sales.

RetireWithReplacementOperation(Operation) - Constructor for class org.kigalisim.lang.operation.RetireWithReplacementOperation

Create a new RetireWithReplacementOperation that applies to all years.

RetireWithReplacementOperation(Operation, ParsedDuring) - Constructor for class org.kigalisim.lang.operation.RetireWithReplacementOperation

Create a new RetireWithReplacementOperation that applies to a specific time period.

run() - Method in class org.kigalisim.command.VersionCommand

Executes the version command by printing the version number.

RunCommand - Class in org.kigalisim.command

Command handler for executing QubecTalk simulations.

RunCommand() - Constructor for class org.kigalisim.command.RunCommand

Constructs a new RunCommand.

runScenario(ParsedProgram, String, ProgressReportCallback) - Static method in class org.kigalisim.KigaliSimFacade

Run a scenario from the provided program and return results.

S

SalesRecalcStrategy - Class in org.kigalisim.engine.recalc

Strategy for recalculating sales.

SalesRecalcStrategy(Optional<UseKey>) - Constructor for class org.kigalisim.engine.recalc.SalesRecalcStrategy

Create a new SalesRecalcStrategy.

SalesStreamDistribution - Class in org.kigalisim.engine.recalc

Represents the percentage distribution between domestic, import, and export streams for sales.

SalesStreamDistribution(BigDecimal, BigDecimal) - Constructor for class org.kigalisim.engine.recalc.SalesStreamDistribution

Create a new sales stream distribution without exports (legacy constructor).

SalesStreamDistribution(BigDecimal, BigDecimal, BigDecimal) - Constructor for class org.kigalisim.engine.recalc.SalesStreamDistribution

Create a new sales stream distribution.

SalesStreamDistributionBuilder - Class in org.kigalisim.engine.recalc

Builder for creating sales stream distribution percentages.

SalesStreamDistributionBuilder() - Constructor for class org.kigalisim.engine.recalc.SalesStreamDistributionBuilder

Create builder without any values initialized.

ScenarioFragment - Class in org.kigalisim.lang.fragment

A fragment containing a parsed scenario.

ScenarioFragment(ParsedScenario) - Constructor for class org.kigalisim.lang.fragment.ScenarioFragment

Create a new fragment containing a parsed scenario.

ScenariosFragment - Class in org.kigalisim.lang.fragment

A fragment containing parsed scenarios.

ScenariosFragment(ParsedScenarios) - Constructor for class org.kigalisim.lang.fragment.ScenariosFragment

Create a new fragment containing parsed scenarios.

Scope - Class in org.kigalisim.engine.state

Object defining a scope within the engine including variables accessible from that scope.

Scope() - Constructor for class org.kigalisim.engine.state.Scope

Default constructor for creating a global scope with no context.

Scope(String, String, String) - Constructor for class org.kigalisim.engine.state.Scope

Convenience constructor for creating a scope without a variable manager.

Scope(String, String, String, VariableManager) - Constructor for class org.kigalisim.engine.state.Scope

Create a new scope.

setAmortizedUnitConsumption(EngineNumber) - Method in class org.kigalisim.engine.state.OverridingConverterStateGetter

Set the amortized unit consumption value.

setAmortizedUnitVolume(EngineNumber) - Method in class org.kigalisim.engine.state.OverridingConverterStateGetter

Set the amortized unit volume value.

setAmount(EngineNumber) - Method in class org.kigalisim.engine.support.ChangeExecutorConfigBuilder

Sets the change amount.

setApplication(String) - Method in interface org.kigalisim.engine.Engine

Set the application for the engine current scope.

setApplication(String) - Method in class org.kigalisim.engine.serializer.EngineResultBuilder

Set the application for which a result is being given.

setApplication(String) - Method in class org.kigalisim.engine.SingleThreadEngine

setAppliedRechargeAmount(EngineNumber) - Method in class org.kigalisim.engine.state.PriorEquipmentBases

Set the applied recharge amount.

setAppliedRechargeAmount(EngineNumber) - Method in class org.kigalisim.engine.state.StreamParameterization

Set the applied recharge amount for cumulative calculations.

setAppliedRechargeAmount(UseKey, EngineNumber) - Method in class org.kigalisim.engine.state.SimulationState

Set the applied recharge amount for cumulative calculations.

setAppliedRetirementAmount(EngineNumber) - Method in class org.kigalisim.engine.state.PriorEquipmentBases

Set the applied retirement amount.

setAppliedRetirementAmount(EngineNumber) - Method in class org.kigalisim.engine.state.StreamParameterization

Set the applied retirement amount for cumulative calculations.

setAppliedRetirementAmount(UseKey, EngineNumber) - Method in class org.kigalisim.engine.state.SimulationState

Set the applied retirement amount for cumulative calculations.

setBankChangeKg(EngineNumber) - Method in class org.kigalisim.engine.serializer.EngineResultBuilder

Set the bank change kg value.

setBankChangeTco2e(EngineNumber) - Method in class org.kigalisim.engine.serializer.EngineResultBuilder

Set the bank change tCO2e value.

setBankKg(EngineNumber) - Method in class org.kigalisim.engine.serializer.EngineResultBuilder

Set the bank kg value.

setBankTco2e(EngineNumber) - Method in class org.kigalisim.engine.serializer.EngineResultBuilder

Set the bank tCO2e value.

setConsumption(EngineNumber) - Method in class org.kigalisim.engine.state.OverridingConverterStateGetter

Set the consumption value.

setConsumptionRaw(EngineNumber) - Method in class org.kigalisim.engine.support.ConsumptionCalculator

Set the raw consumption value to be processed.

setCurrentYear(int) - Method in class org.kigalisim.engine.state.SimulationState

Set the current year for this simulation state.

setDistribution(SalesStreamDistribution) - Method in class org.kigalisim.engine.recalc.StreamUpdateBuilder

Sets the distribution for sales streams.

setDistribution(SalesStreamDistribution) - Method in class org.kigalisim.engine.state.SimulationStateUpdateBuilder

Sets the pre-calculated distribution for sales streams.

setDomesticConsumptionValue(EngineNumber) - Method in class org.kigalisim.engine.serializer.EngineResultBuilder

Set the domestic consumption value.

setDomesticEnabled(boolean) - Method in class org.kigalisim.engine.recalc.SalesStreamDistributionBuilder

Set whether domestic stream is enabled.

setDomesticSales(EngineNumber) - Method in class org.kigalisim.engine.recalc.SalesStreamDistributionBuilder

Set the domestic sales value.

setDomesticValue(EngineNumber) - Method in class org.kigalisim.engine.serializer.EngineResultBuilder

Set the domestic value.

setEnergyConsumption(EngineNumber) - Method in class org.kigalisim.engine.serializer.EngineResultBuilder

Set the energy consumption value.

setEnergyConsumption(EngineNumber) - Method in class org.kigalisim.engine.state.OverridingConverterStateGetter

Set the energy consumption equivalency.

setEnergyIntensity(EngineNumber) - Method in class org.kigalisim.engine.state.OverridingConverterStateGetter

Set the energy intensity value.

setEnergyIntensity(EngineNumber) - Method in class org.kigalisim.engine.state.StreamParameterization

Set the energy intensity.

setEnergyIntensity(UseKey, EngineNumber) - Method in class org.kigalisim.engine.state.SimulationState

Set the energy intensity for a key.

setEolEmissions(EngineNumber) - Method in class org.kigalisim.engine.serializer.EngineResultBuilder

Set the end-of-life emissions value.

SetExecutor - Class in org.kigalisim.engine.support

Handles set operations for sales streams with proper component distribution.

SetExecutor(Engine) - Constructor for class org.kigalisim.engine.support.SetExecutor

Creates a new SetExecutor for the given engine.

setExportConsumptionValue(EngineNumber) - Method in class org.kigalisim.engine.serializer.EngineResultBuilder

Set the export consumption value.

setExportEnabled(boolean) - Method in class org.kigalisim.engine.recalc.SalesStreamDistributionBuilder

Set whether export stream is enabled.

setExportSales(EngineNumber) - Method in class org.kigalisim.engine.recalc.SalesStreamDistributionBuilder

Set the export sales value.

setExportValue(EngineNumber) - Method in class org.kigalisim.engine.serializer.EngineResultBuilder

Set the export value.

setForceUseFullRecharge(boolean) - Method in class org.kigalisim.engine.recalc.StreamUpdateBuilder

Sets whether to force use of full recharge.

setGhgIntensity(EngineNumber) - Method in class org.kigalisim.engine.state.StreamParameterization

Set the greenhouse gas intensity.

setGhgIntensity(UseKey, EngineNumber) - Method in class org.kigalisim.engine.state.SimulationState

Set the greenhouse gas intensity for a key.

setHasReplacementThisStep(boolean) - Method in class org.kigalisim.engine.state.PriorEquipmentBases

Set whether replacement is used in this step's retire commands.

setHasReplacementThisStep(boolean) - Method in class org.kigalisim.engine.state.StreamParameterization

Set the replacement mode for this step's retire commands.

setHasReplacementThisStep(UseKey, boolean) - Method in class org.kigalisim.engine.state.SimulationState

Set the replacement mode for retire commands this step.

setImportConsumptionValue(EngineNumber) - Method in class org.kigalisim.engine.serializer.EngineResultBuilder

Set the import consumption value.

setImportEnabled(boolean) - Method in class org.kigalisim.engine.recalc.SalesStreamDistributionBuilder

Set whether import stream is enabled.

setImportSales(EngineNumber) - Method in class org.kigalisim.engine.recalc.SalesStreamDistributionBuilder

Set the import sales value.

setImportValue(EngineNumber) - Method in class org.kigalisim.engine.serializer.EngineResultBuilder

Set the import value.

setIncludeExports(boolean) - Method in class org.kigalisim.engine.recalc.SalesStreamDistributionBuilder

Set whether exports should be included in the distribution.

setInductionRate(EngineNumber) - Method in class org.kigalisim.engine.state.StreamParameterization

Set the induction rate percentage for recycling.

setInductionRate(EngineNumber, RecoverOperation.RecoveryStage) - Method in interface org.kigalisim.engine.Engine

Set the induction rate for recycling operations.

setInductionRate(EngineNumber, RecoverOperation.RecoveryStage) - Method in class org.kigalisim.engine.SingleThreadEngine

setInductionRate(EngineNumber, RecoverOperation.RecoveryStage) - Method in class org.kigalisim.engine.state.StreamParameterization

Set the induction rate percentage for recycling for a specific stage.

setInductionRate(UseKey, EngineNumber) - Method in class org.kigalisim.engine.state.SimulationState

Set the induction rate percentage for recycling for a key.

setInductionRate(UseKey, EngineNumber, RecoverOperation.RecoveryStage) - Method in class org.kigalisim.engine.state.SimulationState

Set the induction rate percentage for recycling for a key with a specific stage.

setInitialCharge(String, EngineNumber) - Method in class org.kigalisim.engine.state.StreamParameterization

Set the initial charge for a stream.

setInitialCharge(EngineNumber, String, YearMatcher) - Method in interface org.kigalisim.engine.Engine

Set the initial charge for a stream.

setInitialCharge(EngineNumber, String, YearMatcher) - Method in class org.kigalisim.engine.SingleThreadEngine

setInitialCharge(UseKey, String, EngineNumber) - Method in class org.kigalisim.engine.state.SimulationState

Set the initial charge for a key's stream.

setInitialChargeEmissions(EngineNumber) - Method in class org.kigalisim.engine.serializer.EngineResultBuilder

Set the initial charge emissions value.

setInvalidatePriorEquipment(boolean) - Method in class org.kigalisim.engine.state.SimulationStateUpdateBuilder

Sets whether this update should invalidate prior equipment cumulative bases.

setKey(UseKey) - Method in class org.kigalisim.engine.recalc.StreamUpdateBuilder

Sets the use key.

setLastSpecifiedValue(String, EngineNumber) - Method in class org.kigalisim.engine.state.StreamParameterization

Set the last specified value for a stream.

setLastSpecifiedValue(UseKey, String, EngineNumber) - Method in class org.kigalisim.engine.state.SimulationState

Tracks the last specified value for sales-related streams.

setName(String) - Method in class org.kigalisim.engine.recalc.StreamUpdateBuilder

Sets the stream name.

setName(String) - Method in class org.kigalisim.engine.state.SimulationStateUpdateBuilder

Sets the stream name.

SetOperation - Class in org.kigalisim.lang.operation

Operation that sets a value to a stream in the engine.

SetOperation(String, Operation) - Constructor for class org.kigalisim.lang.operation.SetOperation

Create a new SetOperation that applies to all years.

SetOperation(String, Operation, ParsedDuring) - Constructor for class org.kigalisim.lang.operation.SetOperation

Create a new SetOperation that applies to a specific time period.

setPopulation(EngineNumber) - Method in class org.kigalisim.engine.state.OverridingConverterStateGetter

Set the population value.

setPopulationChange(EngineNumber) - Method in class org.kigalisim.engine.state.OverridingConverterStateGetter

Set the population change value.

setPopulationNew(EngineNumber) - Method in class org.kigalisim.engine.serializer.EngineResultBuilder

Set the population new value.

setPopulationValue(EngineNumber) - Method in class org.kigalisim.engine.serializer.EngineResultBuilder

Set the population value.

setPriorGhgConsumption(EngineNumber) - Method in class org.kigalisim.engine.state.OverridingConverterStateGetter

Set the prior GHG consumption value.

setPriorPopulation(EngineNumber) - Method in class org.kigalisim.engine.state.OverridingConverterStateGetter

Set the prior population value.

setPriorVolume(EngineNumber) - Method in class org.kigalisim.engine.state.OverridingConverterStateGetter

Set the prior volume value.

setPriorYearsElapsed(EngineNumber) - Method in class org.kigalisim.engine.state.OverridingConverterStateGetter

Set the prior years elapsed value.

setPropagateChanges(boolean) - Method in class org.kigalisim.engine.recalc.StreamUpdateBuilder

Sets whether changes should propagate.

setRecalcKit(RecalcKit) - Method in class org.kigalisim.engine.recalc.RecalcOperationBuilder

Set the RecalcKit containing dependencies for recalculation operations.

setRechargeBasePopulation(EngineNumber) - Method in class org.kigalisim.engine.state.PriorEquipmentBases

Set the recharge base population.

setRechargeBasePopulation(EngineNumber) - Method in class org.kigalisim.engine.state.StreamParameterization

Set the recharge base population for cumulative calculations.

setRechargeBasePopulation(UseKey, EngineNumber) - Method in class org.kigalisim.engine.state.SimulationState

Set the recharge base population for cumulative calculations.

setRechargeEmissions(EngineNumber) - Method in class org.kigalisim.engine.serializer.EngineResultBuilder

Set the recharge emissions value.

setRechargeIntensity(EngineNumber) - Method in class org.kigalisim.engine.state.StreamParameterization

Set the recharge intensity.

setRechargeIntensity(UseKey, EngineNumber) - Method in class org.kigalisim.engine.state.SimulationState

Set the recharge intensity for a key.

setRechargePopulation(EngineNumber) - Method in class org.kigalisim.engine.state.StreamParameterization

Set the recharge population percentage.

setRechargePopulation(UseKey, EngineNumber) - Method in class org.kigalisim.engine.state.SimulationState

Set the recharge population percentage for a key.

setRecoveryRate(EngineNumber) - Method in class org.kigalisim.engine.state.StreamParameterization

Set the recovery rate percentage.

setRecoveryRate(EngineNumber, RecoverOperation.RecoveryStage) - Method in class org.kigalisim.engine.state.StreamParameterization

Set the recovery rate percentage for a specific stage.

setRecoveryRate(UseKey, EngineNumber) - Method in class org.kigalisim.engine.state.SimulationState

Set the recovery rate percentage for a key.

setRecoveryRate(UseKey, EngineNumber, RecoverOperation.RecoveryStage) - Method in class org.kigalisim.engine.state.SimulationState

Set the recovery rate percentage for a key with a specific stage.

setRecycleConsumptionValue(EngineNumber) - Method in class org.kigalisim.engine.serializer.EngineResultBuilder

Set the recycle consumption value.

setRecycleValue(EngineNumber) - Method in class org.kigalisim.engine.serializer.EngineResultBuilder

Set the recycle value.

setRecyclingCalculatedThisStep(boolean) - Method in class org.kigalisim.engine.state.PriorEquipmentBases

Set whether recycling has been calculated this step.

setRecyclingCalculatedThisStep(boolean) - Method in class org.kigalisim.engine.state.StreamParameterization

Set whether recycling has been calculated this step.

setRecyclingCalculatedThisStep(UseKey, boolean) - Method in class org.kigalisim.engine.state.SimulationState

Set whether recycling has been calculated this step.

setRetireCalculatedThisStep(boolean) - Method in class org.kigalisim.engine.state.PriorEquipmentBases

Set whether retire has been calculated this step.

setRetireCalculatedThisStep(boolean) - Method in class org.kigalisim.engine.state.StreamParameterization

Set whether retire has been calculated this step.

setRetireCalculatedThisStep(UseKey, boolean) - Method in class org.kigalisim.engine.state.SimulationState

Set whether retire has been calculated this step.

setRetirementBasePopulation(EngineNumber) - Method in class org.kigalisim.engine.state.PriorEquipmentBases

Set the retirement base population.

setRetirementBasePopulation(EngineNumber) - Method in class org.kigalisim.engine.state.StreamParameterization

Set the retirement base population for cumulative calculations.

setRetirementBasePopulation(UseKey, EngineNumber) - Method in class org.kigalisim.engine.state.SimulationState

Set the retirement base population for cumulative calculations.

setRetirementRate(EngineNumber) - Method in class org.kigalisim.engine.state.StreamParameterization

Set the retirement rate percentage.

setRetirementRate(UseKey, EngineNumber) - Method in class org.kigalisim.engine.state.SimulationState

Set the retirement rate percentage for a key.

setSalesIntentFreshlySet(boolean) - Method in class org.kigalisim.engine.state.StreamParameterization

Set the flag indicating whether sales intent has been freshly set.

setScenarioName(String) - Method in interface org.kigalisim.engine.Engine

Set the scenario name.

setScenarioName(String) - Method in class org.kigalisim.engine.serializer.EngineResultBuilder

Set the scenario name for which a result is being given.

setScenarioName(String) - Method in class org.kigalisim.engine.SingleThreadEngine

Set the scenario name.

setScopeEffective(UseKey) - Method in class org.kigalisim.engine.recalc.RecalcOperationBuilder

Set the scope for all recalculation operations.

setStanza(String) - Method in interface org.kigalisim.engine.Engine

Set the stanza for the engine current scope.

setStanza(String) - Method in class org.kigalisim.engine.SingleThreadEngine

setStateGetter(StateGetter) - Method in class org.kigalisim.engine.recalc.RecalcKitBuilder

Set the state getter.

setStream(String) - Method in class org.kigalisim.engine.support.ChangeExecutorConfigBuilder

Sets the stream identifier.

setStream(String, EngineNumber, Optional<YearMatcher>) - Method in interface org.kigalisim.engine.Engine

Set a stream for explicit user operations (applies user-level processing like SetExecutor).

setStream(String, EngineNumber, Optional<YearMatcher>) - Method in class org.kigalisim.engine.SingleThreadEngine

setStreamKeeper(SimulationState) - Method in class org.kigalisim.engine.recalc.RecalcKitBuilder

Set the simulation state.

setStreamName(String) - Method in class org.kigalisim.engine.support.ConsumptionCalculator

Set the stream name for the calculation.

setSubstance(String) - Method in interface org.kigalisim.engine.Engine

Set the substance for the engine current scope with default validation behavior.

setSubstance(String) - Method in class org.kigalisim.engine.serializer.EngineResultBuilder

Set the substance for which a result is being given.

setSubstance(String) - Method in class org.kigalisim.engine.SingleThreadEngine

setSubstance(String, boolean) - Method in interface org.kigalisim.engine.Engine

Set the substance for the engine current scope.

setSubstance(String, boolean) - Method in class org.kigalisim.engine.SingleThreadEngine

setSubstanceConsumption(EngineNumber) - Method in class org.kigalisim.engine.state.OverridingConverterStateGetter

Set the substance consumption value.

setSubtractRecycling(boolean) - Method in class org.kigalisim.engine.recalc.StreamUpdateBuilder

Sets whether to subtract recycling.

setSubtractRecycling(boolean) - Method in class org.kigalisim.engine.state.SimulationStateUpdateBuilder

Sets whether to subtract recycling from the value.

setTotal(String, EngineNumber) - Method in class org.kigalisim.engine.state.OverridingConverterStateGetter

Set total values for different stream types.

setTradeSupplement(TradeSupplement) - Method in class org.kigalisim.engine.serializer.EngineResultBuilder

Set the trade supplement data.

setTrialNumber(int) - Method in interface org.kigalisim.engine.Engine

Set the trial number.

setTrialNumber(int) - Method in class org.kigalisim.engine.serializer.EngineResultBuilder

Set the trial number for which a result is being given.

setTrialNumber(int) - Method in class org.kigalisim.engine.SingleThreadEngine

Set the trial number.

setUnitConverter(UnitConverter) - Method in class org.kigalisim.engine.recalc.RecalcKitBuilder

Set the unit converter.

setUnitsToRecord(String) - Method in class org.kigalisim.engine.recalc.StreamUpdateBuilder

Sets the units to record.

setUseExplicitRecharge(Boolean) - Method in class org.kigalisim.engine.recalc.RecalcOperationBuilder

Set whether to use explicit recharge in population calculations.

setUseKey(UseKey) - Method in class org.kigalisim.engine.state.SimulationStateUpdateBuilder

Sets the use key containing application and substance.

setUseKeyEffective(UseKey) - Method in class org.kigalisim.engine.support.ChangeExecutorConfigBuilder

Sets the effective use key.

setValue(EngineNumber) - Method in class org.kigalisim.engine.recalc.StreamUpdateBuilder

Sets the stream value.

setValue(EngineNumber) - Method in class org.kigalisim.engine.state.SimulationStateUpdateBuilder

Sets the pre-computed stream value.

setVariable(String, EngineNumber) - Method in interface org.kigalisim.engine.Engine

Set the value of a variable in the current scope.

setVariable(String, EngineNumber) - Method in class org.kigalisim.engine.SingleThreadEngine

setVariable(String, EngineNumber) - Method in class org.kigalisim.engine.state.Scope

Set the value of a variable already defined.

setVariable(String, EngineNumber) - Method in class org.kigalisim.engine.state.VariableManager

Set the value of a variable already defined.

setVolume(EngineNumber) - Method in class org.kigalisim.engine.state.OverridingConverterStateGetter

Set the volume value.

setYear(int) - Method in class org.kigalisim.engine.serializer.EngineResultBuilder

Set the year for which a result is being given.

setYearMatcher(Optional<YearMatcher>) - Method in class org.kigalisim.engine.recalc.StreamUpdateBuilder

Sets the year matcher.

setYearMatcher(YearMatcher) - Method in class org.kigalisim.engine.support.ChangeExecutorConfigBuilder

Sets the year matcher.

setYearsElapsed(EngineNumber) - Method in class org.kigalisim.engine.state.OverridingConverterStateGetter

Set the years elapsed value.

setYieldRate(EngineNumber) - Method in class org.kigalisim.engine.state.StreamParameterization

Set the yield rate percentage for recycling.

setYieldRate(EngineNumber, RecoverOperation.RecoveryStage) - Method in class org.kigalisim.engine.state.StreamParameterization

Set the yield rate percentage for recycling for a specific stage.

setYieldRate(UseKey, EngineNumber) - Method in class org.kigalisim.engine.state.SimulationState

Set the yield rate percentage for recycling for a key.

setYieldRate(UseKey, EngineNumber, RecoverOperation.RecoveryStage) - Method in class org.kigalisim.engine.state.SimulationState

Set the yield rate percentage for recycling for a key with a specific stage.

SimpleUseKey - Class in org.kigalisim.engine.state

Simple implementation of UseKey that generates keys based on application and substance.

SimpleUseKey(String, String) - Constructor for class org.kigalisim.engine.state.SimpleUseKey

Creates a new SimpleUseKey with the specified application and substance.

SimulationState - Class in org.kigalisim.engine.state

Manager for the state for a single scenario within a single trial.

SimulationState(OverridingConverterStateGetter, UnitConverter) - Constructor for class org.kigalisim.engine.state.SimulationState

Create a new SimulationState instance.

SimulationStateUpdate - Class in org.kigalisim.engine.state

Immutable class representing a simulation state update value ready to be set.

SimulationStateUpdateBuilder - Class in org.kigalisim.engine.state

Builder for creating SimulationStateUpdate instances.

SimulationStateUpdateBuilder() - Constructor for class org.kigalisim.engine.state.SimulationStateUpdateBuilder

Creates a new SimulationStateUpdateBuilder with default values.

SingleDelimiterTemplate - Class in org.kigalisim.lang.localization

Abstract base class for single-separator number parsing strategies.

SingleDelimiterTemplate() - Constructor for class org.kigalisim.lang.localization.SingleDelimiterTemplate

Constructs a new SingleDelimiterTemplate.

SingleThreadEngine - Class in org.kigalisim.engine

Single-threaded implementation of the Engine interface.

SingleThreadEngine(int, int) - Constructor for class org.kigalisim.engine.SingleThreadEngine

Create a new SingleThreadEngine instance.

SingleThreadPushDownMachine - Class in org.kigalisim.lang.machine

A push down automaton which can perform mathematical and logical operations for QubecTalk.

SingleThreadPushDownMachine(Engine) - Constructor for class org.kigalisim.lang.machine.SingleThreadPushDownMachine

Create a new SingleThreadPushDownMachine.

STANZA_CONTEXT - Static variable in class org.kigalisim.engine.state.EngineConstants

Stanza context level for variables accessible within a stanza.

StateGetter - Interface in org.kigalisim.engine.state

Interface for accessing engine state needed for unit conversions.

STREAM_NAMES - Static variable in class org.kigalisim.engine.support.EngineSupportUtils

Set of valid stream names in the simulation engine.

StreamParameterization - Class in org.kigalisim.engine.state

Class for managing stream-specific parameters and settings.

StreamParameterization() - Constructor for class org.kigalisim.engine.state.StreamParameterization

Create a new stream parameterization instance.

StreamUpdate - Class in org.kigalisim.engine.recalc

Immutable class representing stream calculation instructions.

StreamUpdateBuilder - Class in org.kigalisim.engine.recalc

Builder for creating StreamUpdate instances.

StreamUpdateBuilder() - Constructor for class org.kigalisim.engine.recalc.StreamUpdateBuilder

Creates a new StreamUpdateBuilder with default values.

StreamUpdateExecutor - Class in org.kigalisim.engine.support

Handles stream update operations for sales carry-over logic.

StreamUpdateExecutor(Engine) - Constructor for class org.kigalisim.engine.support.StreamUpdateExecutor

Creates a new StreamUpdateExecutor for the given engine.

StreamUpdateShortcuts - Class in org.kigalisim.engine.support

Handles stream update shortcut operations for displacement and replacement.

StreamUpdateShortcuts(Engine) - Constructor for class org.kigalisim.engine.support.StreamUpdateShortcuts

Creates a new StreamUpdateShortcuts for the given engine.

StringFragment - Class in org.kigalisim.lang.fragment

A fragment containing only a string value.

StringFragment(String) - Constructor for class org.kigalisim.lang.fragment.StringFragment

Create a new StringFragment.

SUBSTANCE_CONTEXT - Static variable in class org.kigalisim.engine.state.EngineConstants

Substance context level for variables accessible within a substance.

SubstanceFragment - Class in org.kigalisim.lang.fragment

A fragment containing a parsed substance.

SubstanceFragment(ParsedSubstance) - Constructor for class org.kigalisim.lang.fragment.SubstanceFragment

Create a new fragment containing a parsed substance.

SubstanceInApplicationId - Class in org.kigalisim.engine.state

Class representing a unique identifier for a substance within a specific application.

SubstanceInApplicationId(String, String) - Constructor for class org.kigalisim.engine.state.SubstanceInApplicationId

Create a new substance-in-application identifier.

subtract() - Method in interface org.kigalisim.lang.machine.PushDownMachine

Subtract the two numbers on top of the stack.

subtract() - Method in class org.kigalisim.lang.machine.SingleThreadPushDownMachine

Subtract the two numbers on top of the stack.

SubtractionOperation - Class in org.kigalisim.lang.operation

Calculation that subtracts one calculation from another.

SubtractionOperation(Operation, Operation) - Constructor for class org.kigalisim.lang.operation.SubtractionOperation

Create a new SubtractionOperation.

syntaxError(Recognizer<?, ?>, Object, int, int, String, RecognitionException) - Method in class org.kigalisim.lang.parse.ParserErrorListener

T

thenPropagateToConsumption() - Method in class org.kigalisim.engine.recalc.RecalcOperationBuilder

Propagate changes to consumption calculation.

thenPropagateToEolEmissions() - Method in class org.kigalisim.engine.recalc.RecalcOperationBuilder

Propagate changes to end-of-life emissions calculation.

thenPropagateToPopulationChange() - Method in class org.kigalisim.engine.recalc.RecalcOperationBuilder

Propagate changes to population calculation.

thenPropagateToRechargeEmissions() - Method in class org.kigalisim.engine.recalc.RecalcOperationBuilder

Propagate changes to recharge emissions calculation.

thenPropagateToRetire() - Method in class org.kigalisim.engine.recalc.RecalcOperationBuilder

Propagate changes to retirement calculation.

thenPropagateToSales() - Method in class org.kigalisim.engine.recalc.RecalcOperationBuilder

Propagate changes to sales calculation.

TimePointFuture - Interface in org.kigalisim.lang.time

Time point which can be resolved at QubecTalk runtime.

TimePointRealized - Class in org.kigalisim.lang.time

Description of a time point.

TimePointRealized(String) - Constructor for class org.kigalisim.lang.time.TimePointRealized

Create a new timepoint.

TimePointRealized(EngineNumber) - Constructor for class org.kigalisim.lang.time.TimePointRealized

Create a new timepoint.

toString() - Method in class org.kigalisim.engine.number.EngineNumber

Return a string representation of this number with its value and units.

toString() - Method in class org.kigalisim.util.EmulatedStringJoiner

Returns the string representation of this joiner.

TradeSupplement - Class in org.kigalisim.engine.serializer

Summary of trade (imports and exports) for attribution purposes.

TradeSupplement(EngineNumber, EngineNumber, EngineNumber, EngineNumber, EngineNumber) - Constructor for class org.kigalisim.engine.serializer.TradeSupplement

Create a new summary of trade (imports and exports).

U

unbounded() - Static method in class org.kigalisim.engine.state.YearMatcher

Create a new unbounded year range.

UnitConverter - Class in org.kigalisim.engine.number

Object simplifying conversion between units.

UnitConverter(StateGetter) - Constructor for class org.kigalisim.engine.number.UnitConverter

Create a new unit converter.

UnitFragment - Class in org.kigalisim.lang.fragment

A fragment containing only a unit string.

UnitFragment(String) - Constructor for class org.kigalisim.lang.fragment.UnitFragment

Create a new UnitFragment.

UnitStringNormalizer - Class in org.kigalisim.util

Utility class for normalizing unit strings.

update(SimulationStateUpdate) - Method in class org.kigalisim.engine.state.SimulationState

Set a stream using pre-computed stream data.

UseKey - Interface in org.kigalisim.engine.state

Interface for objects that can generate a string key for finding substance streams based on application and substance usage.

V

validate(String) - Static method in class org.kigalisim.KigaliSimFacade

Validate a QubecTalk script.

ValidateCommand - Class in org.kigalisim.command

Command handler for validating QubecTalk simulation files.

ValidateCommand() - Constructor for class org.kigalisim.command.ValidateCommand

Constructs a new ValidateCommand.

validateThousandsSeparatorPositions(String, char) - Method in class org.kigalisim.lang.localization.SingleDelimiterTemplate

Validate that thousands separators are positioned correctly.

validateUniqueNames(Iterable<T>, Function<T, String>, String, String) - Static method in class org.kigalisim.lang.validation.DuplicateValidator

Validate that all items in a collection have unique names.

validateUniqueSubstanceEquipmentCombinations(Iterable<ParsedSubstance>, String) - Static method in class org.kigalisim.lang.validation.DuplicateValidator

Validate that substance+equipment type combinations are unique within an application.

valueOf(String) - Static method in enum class org.kigalisim.lang.operation.DisplacementType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.kigalisim.lang.operation.RecoverOperation.RecoveryStage

Returns the enum constant of this class with the specified name.

values() - Static method in enum class org.kigalisim.lang.operation.DisplacementType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.kigalisim.lang.operation.RecoverOperation.RecoveryStage

Returns an array containing the constants of this enum class, in the order they are declared.

VariableManager - Class in org.kigalisim.engine.state

Internal object which manages user defined variables at different scopes.

VariableManager(int) - Constructor for class org.kigalisim.engine.state.VariableManager

Convenience constructor for creating a new variable manager at a specific context level.

VariableManager(int, Map<String, EngineNumber>, Map<String, EngineNumber>, Map<String, EngineNumber>, Map<String, EngineNumber>) - Constructor for class org.kigalisim.engine.state.VariableManager

Create a new variable manager.

VersionCommand - Class in org.kigalisim.command

Command to display the version of KigaliSim.

VersionCommand() - Constructor for class org.kigalisim.command.VersionCommand

Constructs a new VersionCommand.

visitAboutStanza(QubecTalkParser.AboutStanzaContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitAdditionExpression(QubecTalkParser.AdditionExpressionContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitApplicationDef(QubecTalkParser.ApplicationDefContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitApplicationMod(QubecTalkParser.ApplicationModContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitAssumeContinuedAllYears(QubecTalkParser.AssumeContinuedAllYearsContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitAssumeContinuedDuration(QubecTalkParser.AssumeContinuedDurationContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitAssumeNoAllYears(QubecTalkParser.AssumeNoAllYearsContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitAssumeNoDuration(QubecTalkParser.AssumeNoDurationContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitAssumeOnlyRechargeAllYears(QubecTalkParser.AssumeOnlyRechargeAllYearsContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitAssumeOnlyRechargeDuration(QubecTalkParser.AssumeOnlyRechargeDurationContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitBaseSimulation(QubecTalkParser.BaseSimulationContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitBaseSimulationTrials(QubecTalkParser.BaseSimulationTrialsContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

Processes a base simulation scenario with multiple trials but no policies.

visitChangeAllYears(QubecTalkParser.ChangeAllYearsContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitChangeDuration(QubecTalkParser.ChangeDurationContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitConditionalExpression(QubecTalkParser.ConditionalExpressionContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitConditionExpression(QubecTalkParser.ConditionExpressionContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitDefaultStanza(QubecTalkParser.DefaultStanzaContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitDefineVarStatement(QubecTalkParser.DefineVarStatementContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitDrawNormalExpression(QubecTalkParser.DrawNormalExpressionContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitDrawUniformExpression(QubecTalkParser.DrawUniformExpressionContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitDuringAll(QubecTalkParser.DuringAllContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitDuringRange(QubecTalkParser.DuringRangeContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitDuringSingleYear(QubecTalkParser.DuringSingleYearContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitDuringStart(QubecTalkParser.DuringStartContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitDuringWithMax(QubecTalkParser.DuringWithMaxContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitDuringWithMin(QubecTalkParser.DuringWithMinContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitEnableAllYears(QubecTalkParser.EnableAllYearsContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitEnableDuration(QubecTalkParser.EnableDurationContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitEqualsAllYears(QubecTalkParser.EqualsAllYearsContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitEqualsDuration(QubecTalkParser.EqualsDurationContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitGetStream(QubecTalkParser.GetStreamContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitGetStreamConversion(QubecTalkParser.GetStreamConversionContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitGetStreamIndirect(QubecTalkParser.GetStreamIndirectContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitGetStreamIndirectConversion(QubecTalkParser.GetStreamIndirectConversionContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitGlobalStatement(QubecTalkParser.GlobalStatementContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitIdentifierAsVar(QubecTalkParser.IdentifierAsVarContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitInitialChargeAllYears(QubecTalkParser.InitialChargeAllYearsContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitInitialChargeDuration(QubecTalkParser.InitialChargeDurationContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitLimitBoundExpression(QubecTalkParser.LimitBoundExpressionContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitLimitCommandAllYears(QubecTalkParser.LimitCommandAllYearsContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitLimitCommandDisplacingAllYears(QubecTalkParser.LimitCommandDisplacingAllYearsContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitLimitCommandDisplacingByUnitsAllYears(QubecTalkParser.LimitCommandDisplacingByUnitsAllYearsContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitLimitCommandDisplacingByUnitsDuration(QubecTalkParser.LimitCommandDisplacingByUnitsDurationContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitLimitCommandDisplacingByVolumeAllYears(QubecTalkParser.LimitCommandDisplacingByVolumeAllYearsContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitLimitCommandDisplacingByVolumeDuration(QubecTalkParser.LimitCommandDisplacingByVolumeDurationContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitLimitCommandDisplacingDuration(QubecTalkParser.LimitCommandDisplacingDurationContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitLimitCommandDuration(QubecTalkParser.LimitCommandDurationContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitLimitMaxExpression(QubecTalkParser.LimitMaxExpressionContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitLimitMinExpression(QubecTalkParser.LimitMinExpressionContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitLogicalExpression(QubecTalkParser.LogicalExpressionContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitMultiplyExpression(QubecTalkParser.MultiplyExpressionContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitNumber(QubecTalkParser.NumberContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitParenExpression(QubecTalkParser.ParenExpressionContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitPolicySim(QubecTalkParser.PolicySimContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

Processes a simulation scenario with specified policies and time bounds.

visitPolicySimTrials(QubecTalkParser.PolicySimTrialsContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

Processes a policy simulation scenario with multiple trials and specified policies.

visitPolicyStanza(QubecTalkParser.PolicyStanzaContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitPowExpression(QubecTalkParser.PowExpressionContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitProgram(QubecTalkParser.ProgramContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitRechargeAllYears(QubecTalkParser.RechargeAllYearsContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitRechargeDuration(QubecTalkParser.RechargeDurationContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitRecoverAllYears(QubecTalkParser.RecoverAllYearsContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitRecoverDefaultInductionAllYears(QubecTalkParser.RecoverDefaultInductionAllYearsContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitRecoverDefaultInductionDuration(QubecTalkParser.RecoverDefaultInductionDurationContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitRecoverDefaultInductionStageAllYears(QubecTalkParser.RecoverDefaultInductionStageAllYearsContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitRecoverDefaultInductionStageDuration(QubecTalkParser.RecoverDefaultInductionStageDurationContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitRecoverDuration(QubecTalkParser.RecoverDurationContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitRecoverInductionAllYears(QubecTalkParser.RecoverInductionAllYearsContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitRecoverInductionDuration(QubecTalkParser.RecoverInductionDurationContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitRecoverInductionStageAllYears(QubecTalkParser.RecoverInductionStageAllYearsContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitRecoverInductionStageDuration(QubecTalkParser.RecoverInductionStageDurationContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitRecoverStageAllYears(QubecTalkParser.RecoverStageAllYearsContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitRecoverStageDuration(QubecTalkParser.RecoverStageDurationContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitReplaceAllYears(QubecTalkParser.ReplaceAllYearsContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitReplaceDuration(QubecTalkParser.ReplaceDurationContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitRetireAllYears(QubecTalkParser.RetireAllYearsContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

Processes retire operation applied to all years, with or without replacement.

visitRetireDuration(QubecTalkParser.RetireDurationContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

Processes retire operation for a specified duration, with or without replacement.

visitSetAllYears(QubecTalkParser.SetAllYearsContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitSetDuration(QubecTalkParser.SetDurationContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitSimpleIdentifier(QubecTalkParser.SimpleIdentifierContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitSimulationsStanza(QubecTalkParser.SimulationsStanzaContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitStream(QubecTalkParser.StreamContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitString(QubecTalkParser.StringContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitSubstanceDef(QubecTalkParser.SubstanceDefContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

Processes a substance definition by extracting its name and operations.

visitSubstanceMod(QubecTalkParser.SubstanceModContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

Processes a substance modification by extracting its name and operations.

visitSubstanceStatement(QubecTalkParser.SubstanceStatementContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitUnitOrRatio(QubecTalkParser.UnitOrRatioContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

visitUnitValue(QubecTalkParser.UnitValueContext) - Method in class org.kigalisim.lang.QubecTalkEngineVisitor

X

xor() - Method in interface org.kigalisim.lang.machine.PushDownMachine

Perform a logical XOR operation on the two numbers on top of the stack.

xor() - Method in class org.kigalisim.lang.machine.SingleThreadPushDownMachine

Perform a logical XOR operation on the two numbers on top of the stack.

Y

YearMatcher - Class in org.kigalisim.engine.state

Class representing a range of years where inclusion can be tested.

YearMatcher(Integer, Integer) - Constructor for class org.kigalisim.engine.state.YearMatcher

Create a new year range from Integer values.

YearMatcher(Optional<Integer>, Optional<Integer>) - Constructor for class org.kigalisim.engine.state.YearMatcher

Create a new year range.

Z

ZERO_VOLUME - Static variable in class org.kigalisim.engine.state.SimulationState

A B C D E F G H I J K L M N O P Q R S T U V X Y Z
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form