Class: EngineResult

EngineResult(builder)

Result of an engine execution for a substance for an application and year. Part of a simulation result representing the values evaluated for a single substance and application within a single year.

Constructor

new EngineResult(builder)

Constructor for creating an EngineResult instance.
Parameters:
Name Type Description
builder EngineResultBuilder A builder containing all values required to construct the result.
Source:

Methods

getApplication() → {string}

Get the application.
Source:
Returns:
The application.
Type
string

getBankChangeKg() → {EngineNumber}

Get the change in substance bank in kg.
Source:
Returns:
The bank change value in kg.
Type
EngineNumber

getBankChangeTco2e() → {EngineNumber}

Get the change in substance bank in tCO2e.
Source:
Returns:
The bank change value in tCO2e.
Type
EngineNumber

getBankKg() → {EngineNumber}

Get the substance bank in kg.
Source:
Returns:
The bank value in kg.
Type
EngineNumber

getBankTco2e() → {EngineNumber}

Get the substance bank in tCO2e.
Source:
Returns:
The bank value in tCO2e.
Type
EngineNumber

getConsumptionNoRecycle() → {EngineNumber}

Get the total consumption without recycling.
Source:
Returns:
The consumption value in tCO2e or similar.
Type
EngineNumber

getDomestic() → {EngineNumber}

Get the domestic value.
Source:
Returns:
The domestic value in volume like kg.
Type
EngineNumber

getDomesticConsumption() → {EngineNumber}

Get the domestic consumption value.
Source:
Returns:
The domestic consumption value in tCO2e or similar.
Type
EngineNumber

getEnergyConsumption() → {EngineNumber}

Get the energy consumption value.
Source:
Returns:
The energy consumption value with units.
Type
EngineNumber

getEolEmissions() → {EngineNumber}

Get the greenhouse gas emissions from end-of-life equipment.
Source:
Returns:
The end-of-life emissions value with units.
Type
EngineNumber

getExport() → {EngineNumber}

Get the export value.
Source:
Returns:
The export value in volume like kg.
Type
EngineNumber

getExportConsumption() → {EngineNumber}

Get the export consumption value.
Source:
Returns:
The export consumption value.
Type
EngineNumber

getGhgConsumption() → {EngineNumber}

Get the total consumption.
Source:
Returns:
The consumption value in tCO2e or similar.
Type
EngineNumber

getImport() → {EngineNumber}

Get the import value.
Source:
Returns:
The import value in volume like kg.
Type
EngineNumber

getImportConsumption() → {EngineNumber}

Get the import consumption value.
Source:
Returns:
The import consumption value.
Type
EngineNumber

getInitialChargeEmissions() → {EngineNumber}

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.
Source:
Returns:
The initial charge emissions value with units.
Type
EngineNumber

getPopulation() → {EngineNumber}

Get the population value.
Source:
Returns:
The population value.
Type
EngineNumber

getPopulationNew() → {EngineNumber}

Get the amount of new equipment added this year.
Source:
Returns:
The amount of new equipment this year in units.
Type
EngineNumber

getRechargeEmissions() → {EngineNumber}

Get the greenhouse gas emissions from recharge activities.
Source:
Returns:
The recharge emissions value with units.
Type
EngineNumber

getRecycle() → {EngineNumber}

Get the recycle value.
Source:
Returns:
The recycle value in volume like kg.
Type
EngineNumber

getRecycleConsumption() → {EngineNumber}

Get the recycle consumption value.
Source:
Returns:
The recycle consumption value.
Type
EngineNumber

getScenarioName() → {string}

Get the scenario name.
Source:
Returns:
The name of the scenario being run.
Type
string

getSubstance() → {string}

Get the substance.
Source:
Returns:
The substance.
Type
string

getTradeSupplement() → {TradeSupplement}

Get the trade supplement information.
Source:
Returns:
The additional trade information needed for attribution.
Type
TradeSupplement

getTrialNumber() → {number}

Get the trial number.
Source:
Returns:
The trial number of the current run.
Type
number

getYear() → {number}

Get the year the result is relevant to.
Source:
Returns:
The year.
Type
number