Class: TradeSupplement

TradeSupplement(importInitialChargeValue, importInitialChargeConsumption, importPopulation, exportInitialChargeValue, exportInitialChargeConsumption)

Description of trade activity within a result. As a supplement to an {EngineResult}, offers additional description of trade activity on new equipment (and their initial charge) to support different kinds of trade attributions. This is not reported to the user but is required for some internal calculations prior to aggregation operations. This provides supplemental information for a single application and substance in a single year.

Constructor

new TradeSupplement(importInitialChargeValue, importInitialChargeConsumption, importPopulation, exportInitialChargeValue, exportInitialChargeConsumption)

Create a new summary of trade activities.
Parameters:
Name Type Description
importInitialChargeValue EngineValue The volume of substance imported via initial charge on imported equipment (like kg).
importInitialChargeConsumption EngineValue The consumption associated with initial charge of imported equipment (like tCO2e).
importPopulation EngineValue The number of new units imported.
exportInitialChargeValue EngineValue The volume of substance exported via initial charge on exported equipment (like kg).
exportInitialChargeConsumption EngineValue The consumption associated with initial charge of exported equipment (like tCO2e).
Source:

Methods

getExportInitialChargeConsumption() → {EngineValue}

Get the consumption associated with initial charge of exported equipment.
Source:
Returns:
The export initial charge consumption value in units like tCO2e.
Type
EngineValue

getExportInitialChargeValue() → {EngineValue}

Get the volume of substance exported via initial charge on exported equipment.
Source:
Returns:
The export initial charge value in volume units like kg.
Type
EngineValue

getImportInitialChargeConsumption() → {EngineValue}

Get the consumption associated with initial charge of imported equipment.
Source:
Returns:
The import initial charge consumption value in units like tCO2e.
Type
EngineValue

getImportInitialChargeValue() → {EngineValue}

Get the volume of substance imported via initial charge on imported equipment.
Source:
Returns:
The import initial charge value in volume units like kg.
Type
EngineValue

getImportPopulation() → {EngineValue}

Get the number of new units imported.
Source:
Returns:
The import population value in units.
Type
EngineValue