Class: EngineResultBuilder

EngineResultBuilder()

Builder to help construct an EngineResult.

Constructor

new EngineResultBuilder()

Create builder without any values initalized.
Source:

Methods

build() → {EngineResult}

Check that the builder is complete and create a new result.
Source:
Returns:
The result built from the values provided to this builder.
Type
EngineResult

getApplication() → {string}

Get the application for which a result is being built.
Source:
Returns:
The application, or null if not yet set.
Type
string

getBankChangeKg() → {EngineNumber}

Get the bank change kg value.
Source:
Returns:
The bank change kg value, or null if not yet set.
Type
EngineNumber

getBankChangeTco2e() → {EngineNumber}

Get the bank change tCO2e value.
Source:
Returns:
The bank change tCO2e value, or null if not yet set.
Type
EngineNumber

getBankKg() → {EngineNumber}

Get the bank kg value.
Source:
Returns:
The bank kg value, or null if not yet set.
Type
EngineNumber

getBankTco2e() → {EngineNumber}

Get the bank tCO2e value.
Source:
Returns:
The bank tCO2e value, or null if not yet set.
Type
EngineNumber

getDomesticConsumptionValue() → {EngineNumber}

Get the domestic consumption value.
Source:
Returns:
The domestic consumption value, or null if not yet set.
Type
EngineNumber

getDomesticValue() → {EngineNumber}

Get the domestic value.
Source:
Returns:
The domestic value, or null if not yet set.
Type
EngineNumber

getEnergyConsumption() → {EngineNumber}

Get the energy consumption value.
Source:
Returns:
The energy consumption value, or null if not yet set.
Type
EngineNumber

getEolEmissions() → {EngineNumber}

Get the end-of-life emissions value.
Source:
Returns:
The end-of-life emissions value, or null if not yet set.
Type
EngineNumber

getExportConsumptionValue() → {EngineNumber}

Get the export consumption value.
Source:
Returns:
The export consumption value, or null if not yet set.
Type
EngineNumber

getExportValue() → {EngineNumber}

Get the export value.
Source:
Returns:
The export value, or null if not yet set.
Type
EngineNumber

getImportConsumptionValue() → {EngineNumber}

Get the import consumption value.
Source:
Returns:
The import consumption value, or null if not yet set.
Type
EngineNumber

getImportValue() → {EngineNumber}

Get the import value.
Source:
Returns:
The import value, or null if not yet set.
Type
EngineNumber

getInitialChargeEmissions() → {EngineNumber}

Get the initial charge emissions value.
Source:
Returns:
The initial charge emissions value, or null if not yet set.
Type
EngineNumber

getPopulationNew() → {EngineNumber}

Get the population new value.
Source:
Returns:
The population new value, or null if not yet set.
Type
EngineNumber

getPopulationValue() → {EngineNumber}

Get the population value.
Source:
Returns:
The population value, or null if not yet set.
Type
EngineNumber

getRechargeEmissions() → {EngineNumber}

Get the recharge emissions value.
Source:
Returns:
The recharge emissions value, or null if not yet set.
Type
EngineNumber

getRecycleConsumptionValue() → {EngineNumber}

Get the recycle consumption value.
Source:
Returns:
The recycle consumption value, or null if not yet set.
Type
EngineNumber

getRecycleValue() → {EngineNumber}

Get the recycle value.
Source:
Returns:
The recycle value, or null if not yet set.
Type
EngineNumber

getScenarioName() → {string}

Get the scenario name for which a result is being built.
Source:
Returns:
The scenario name, or null if not yet set.
Type
string

getSubstance() → {string}

Get the substance for which a result is being built.
Source:
Returns:
The substance, or null if not yet set.
Type
string

getTradeSupplement() → {TradeSupplement}

Get the supplemental trade information.
Source:
Returns:
The trade supplement, or null if not yet set.
Type
TradeSupplement

getTrialNumber() → {number}

Get the trial number for which a result is being built.
Source:
Returns:
The trial number, or null if not yet set.
Type
number

getYear() → {number}

Get the year for which a result is being built.
Source:
Returns:
The year, or null if not yet set.
Type
number

setApplication(application)

Set the application for which a result is being given.
Parameters:
Name Type Description
application string The application to be associated with this engine result.
Source:

setBankChangeKg(bankChangeKg)

Set the bank change kg value.
Parameters:
Name Type Description
bankChangeKg EngineNumber The bank change value in kg.
Source:

setBankChangeTco2e(bankChangeTco2e)

Set the bank change tCO2e value.
Parameters:
Name Type Description
bankChangeTco2e EngineNumber The bank change value in tCO2e.
Source:

setBankKg(bankKg)

Set the bank kg value.
Parameters:
Name Type Description
bankKg EngineNumber The bank value in kg.
Source:

setBankTco2e(bankTco2e)

Set the bank tCO2e value.
Parameters:
Name Type Description
bankTco2e EngineNumber The bank value in tCO2e.
Source:

setDomesticConsumptionValue(domesticConsumptionValue)

Set the domestic consumption value.
Parameters:
Name Type Description
domesticConsumptionValue EngineNumber The domestic consumption value in tCO2e or equivalent.
Source:

setDomesticValue(domesticValue)

Set the domestic value.
Parameters:
Name Type Description
domesticValue EngineNumber The value associated with domestic production in volume like kg.
Source:

setEnergyConsumption(energyConsumption)

Set the energy consumption value.
Parameters:
Name Type Description
energyConsumption EngineNumber The energy consumption value with units.
Source:

setEolEmissions(eolEmissions)

Set the end-of-life emissions value.
Parameters:
Name Type Description
eolEmissions EngineNumber The greenhouse gas emissions from end-of-life equipment.
Source:

setExportConsumptionValue(exportConsumptionValue)

Set the export consumption value.
Parameters:
Name Type Description
exportConsumptionValue EngineNumber The export consumption value in tCO2e or equivalent.
Source:

setExportValue(exportValue)

Set the export value.
Parameters:
Name Type Description
exportValue EngineNumber The value related to exports like in volume like kg.
Source:

setImportConsumptionValue(importConsumptionValue)

Set the import consumption value.
Parameters:
Name Type Description
importConsumptionValue EngineNumber The import consumption value in tCO2e or equivalent.
Source:

setImportValue(importValue)

Set the import value.
Parameters:
Name Type Description
importValue EngineNumber The value related to imports like in volume like kg.
Source:

setInitialChargeEmissions(initialChargeEmissions)

Set the initial charge emissions value.
Parameters:
Name Type Description
initialChargeEmissions EngineNumber The greenhouse gas emissions from initial charge activities.
Source:

setPopulationNew(populationNew)

Set the population new value.
Parameters:
Name Type Description
populationNew EngineNumber The amount of new equipment added this year.
Source:

setPopulationValue(populationValue)

Set the population value.
Parameters:
Name Type Description
populationValue EngineNumber The population value in terms of equipment.
Source:

setRechargeEmissions(rechargeEmissions)

Set the recharge emissions value.
Parameters:
Name Type Description
rechargeEmissions EngineNumber The greenhouse gas emissions from recharge activities.
Source:

setRecycleConsumptionValue(recycleConsumptionValue)

Set the recycle consumption value.
Parameters:
Name Type Description
recycleConsumptionValue EngineNumber The recycle consumption value in tCO2e or equivalent.
Source:

setRecycleValue(recycleValue)

Set the recycle value.
Parameters:
Name Type Description
recycleValue EngineNumber The value denoting recycled materials in volume like kg.
Source:

setScenarioName(scenarioName)

Set the scenario name for which a result is being given.
Parameters:
Name Type Description
scenarioName string The name of the scenario being run.
Source:

setSubstance(substance)

Set the substance for which a result is being given.
Parameters:
Name Type Description
substance string The substance to be associated with this engine result.
Source:

setTradeSupplement(tradeSupplement)

Specify the supplemental trade information needed for attribution.
Parameters:
Name Type Description
tradeSupplement TradeSupplement Supplemental trade information.
Source:

setTrialNumber(trialNumber)

Set the trial number for which a result is being given.
Parameters:
Name Type Description
trialNumber number The trial number of the current run.
Source:

setYear(year)

Set the year for which a result is being given.
Parameters:
Name Type Description
year number The year to be associated with this engine result.
Source: