Package org.kigalisim.engine.state

Interface StateGetter

All Known Implementing Classes:
ConverterStateGetter, OverridingConverterStateGetter
public interface StateGetter
Interface for accessing engine state needed for unit conversions.

This interface provides access to various engine state values that are required for unit conversion operations, such as substance consumption, volume, population, and time-based metrics.

License:
BSD-3-Clause

  • Method Details

    • getSubstanceConsumption

      EngineNumber getSubstanceConsumption()
      Get the substance consumption rate.
      Returns:
      The substance consumption rate with units like "tCO2e / kg"

    • getEnergyIntensity

      EngineNumber getEnergyIntensity()
      Get the energy intensity.
      Returns:
      The energy intensity with units like "kwh / kg"

    • getAmortizedUnitVolume

      EngineNumber getAmortizedUnitVolume()
      Get the amortized unit volume.
      Returns:
      The amortized unit volume with units like "kg / unit"

    • getPopulation

      EngineNumber getPopulation()
      Get the current population.
      Returns:
      The population with units like "units"

    • getYearsElapsed

      EngineNumber getYearsElapsed()
      Get the years elapsed.
      Returns:
      The years elapsed with units like "years"

    • getGhgConsumption

      EngineNumber getGhgConsumption()
      Get the total GHG consumption.
      Returns:
      The GHG consumption with units like "tCO2e"

    • getEnergyConsumption

      EngineNumber getEnergyConsumption()
      Get the total energy consumption.
      Returns:
      The energy consumption with units like "kwh"

    • getVolume

      EngineNumber getVolume()
      Get the current volume.
      Returns:
      The volume with units like "kg" or "mt"

    • getAmortizedUnitConsumption

      EngineNumber getAmortizedUnitConsumption()
      Get the amortized unit consumption.
      Returns:
      The amortized unit consumption with units like "tCO2e / unit"

    • getPopulationChange

      EngineNumber getPopulationChange(UnitConverter unitConverter)
      Get the population change.
      Parameters:
      unitConverter - Converter for ensuring consistent units
      Returns:
      The population change with units like "units"

    • getPriorVolume

      EngineNumber getPriorVolume()
      Get the prior year volume.
      Returns:
      The prior year volume with units like "kg" or "mt", or current year if no prior

    • getPriorGhgConsumption

      EngineNumber getPriorGhgConsumption()
      Get the prior year GHG consumption.
      Returns:
      The prior year GHG consumption with units like "tCO2e", or current year if no prior

    • getPriorPopulation

      EngineNumber getPriorPopulation()
      Get the prior year population.
      Returns:
      The prior year population with units like "units", or current year if no prior

    • getPriorYearsElapsed

      EngineNumber getPriorYearsElapsed()
      Get the prior years elapsed (max of getYearsElapsed - 1 and 0).
      Returns:
      The prior years elapsed with units like "year"