Package org.kigalisim.engine.serializer

Class EngineResult

java.lang.Object
org.kigalisim.engine.serializer.EngineResult
public class EngineResult extends Object
Engine execution result for a specific substance, application, and year.

This class encapsulates all the calculated values for a simulation result including manufacturing, import, consumption, emissions, and equipment data.

  • Constructor Details

    • EngineResult

      public EngineResult(EngineResultBuilder builder)
      Constructor for creating an EngineResult instance from a builder.

      This constructor accepts an EngineResultBuilder instance and extracts all configured field values from it to initialize this result.

      Parameters:
      builder - The EngineResultBuilder instance with all required fields configured

  • Method Details

    • getApplication

      public String getApplication()
      Get the application.
      Returns:
      The application

    • getSubstance

      public String getSubstance()
      Get the substance.
      Returns:
      The substance

    • getYear

      public int getYear()
      Get the year the result is relevant to.
      Returns:
      The year

    • getDomestic

      public EngineNumber getDomestic()
      Get the domestic value.
      Returns:
      The domestic value in volume like kg

    • getImport

      public EngineNumber getImport()
      Get the import value.
      Returns:
      The import value in volume like kg

    • getRecycle

      public EngineNumber getRecycle()
      Get the recycle value.
      Returns:
      The recycle value in volume like kg

    • getConsumption

      public EngineNumber getConsumption()
      Get the total consumption.

      By default, excludes recycling consumption to measure virgin material consumption.

      Returns:
      The virgin material consumption value in tCO2e or similar

    • getConsumption

      public EngineNumber getConsumption(boolean includeRecycling)
      Get the total consumption with optional recycling inclusion.
      Parameters:
      includeRecycling - If true, includes recycling consumption in the total
      Returns:
      The consumption value in tCO2e or similar

    • getDomesticConsumption

      public EngineNumber getDomesticConsumption()
      Get the domestic consumption value.
      Returns:
      The domestic consumption value in tCO2e or equivalent

    • getImportConsumption

      public EngineNumber getImportConsumption()
      Get the import consumption value.
      Returns:
      The import consumption value in tCO2e or equivalent

    • getRecycleConsumption

      public EngineNumber getRecycleConsumption()
      Get the recycle consumption value.
      Returns:
      The recycle consumption value in tCO2e or equivalent

    • getPopulation

      public EngineNumber getPopulation()
      Get the population value.
      Returns:
      The population value

    • getPopulationNew

      public EngineNumber getPopulationNew()
      Get the amount of new equipment added this year.
      Returns:
      The amount of new equipment this year in units

    • getRechargeEmissions

      public EngineNumber getRechargeEmissions()
      Get the greenhouse gas emissions from recharge activities.
      Returns:
      The recharge emissions value with units

    • getEolEmissions

      public EngineNumber getEolEmissions()
      Get the greenhouse gas emissions from end-of-life equipment.
      Returns:
      The end-of-life emissions value with units

    • getInitialChargeEmissions

      public EngineNumber getInitialChargeEmissions()
      Get the greenhouse gas emissions from initial charge activities.

      This is an informational metric representing the GHG potential of substance initially charged into equipment. Actual emissions occur later during recharge (leakage between servicings) or at end-of-life disposal.

      Returns:
      The initial charge emissions value with units

    • getEnergyConsumption

      public EngineNumber getEnergyConsumption()
      Get the energy consumption value.
      Returns:
      The energy consumption value with units

    • getExport

      public EngineNumber getExport()
      Get the export value.
      Returns:
      The export value in volume like kg

    • getExportConsumption

      public EngineNumber getExportConsumption()
      Get the export consumption value.
      Returns:
      The export consumption value in tCO2e or equivalent

    • getTradeSupplement

      public TradeSupplement getTradeSupplement()
      Get the trade supplement data.
      Returns:
      The trade supplement containing attribution data

    • getScenarioName

      public String getScenarioName()
      Get the scenario name.
      Returns:
      The name of the scenario being run

    • getTrialNumber

      public int getTrialNumber()
      Get the trial number.
      Returns:
      The trial number of the current run

    • getBankKg

      public EngineNumber getBankKg()
      Get the bank kg value.
      Returns:
      The total substance volume in equipment bank in kg

    • getBankTco2e

      public EngineNumber getBankTco2e()
      Get the bank tCO2e value.
      Returns:
      The total GHG potential of substance in equipment bank in tCO2e

    • getBankChangeKg

      public EngineNumber getBankChangeKg()
      Get the bank change kg value.
      Returns:
      The change in substance bank from previous year in kg

    • getBankChangeTco2e

      public EngineNumber getBankChangeTco2e()
      Get the bank change tCO2e value.
      Returns:
      The change in GHG potential of substance bank from previous year in tCO2e