Package org.kigalisim.engine.serializer

Class TradeSupplement

java.lang.Object

org.kigalisim.engine.serializer.TradeSupplement

public class TradeSupplement
extends Object

Summary of trade (imports and exports) for attribution purposes.

This class contains information about imported and exported substances including their volume, consumption impact, and associated equipment population.

Constructor Summary

Constructors

Constructor	Description
TradeSupplement(EngineNumber importInitialChargeValue, EngineNumber importInitialChargeConsumption, EngineNumber importPopulation, EngineNumber exportInitialChargeValue, EngineNumber exportInitialChargeConsumption)	Create a new summary of trade (imports and exports).

Method Summary

Modifier and Type	Method	Description
EngineNumber	getExportInitialChargeConsumption()	Get the consumption associated with initial charge of exported equipment.
EngineNumber	getExportInitialChargeValue()	Get the volume of substance exported via initial charge on exported equipment.
EngineNumber	getImportInitialChargeConsumption()	Get the consumption associated with initial charge of imported equipment.
EngineNumber	getImportInitialChargeValue()	Get the volume of substance imported via initial charge on imported equipment.
EngineNumber	getImportPopulation()	Get the number of new units imported.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TradeSupplement

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

Create a new summary of trade (imports and exports).

Parameters:

importInitialChargeValue - The volume of substance imported via initial charge on imported equipment (like kg)

importInitialChargeConsumption - The consumption associated with initial charge of imported equipment (like tCO2e)

importPopulation - The number of new units imported

exportInitialChargeValue - The volume of substance exported via initial charge on exported equipment (like kg)

exportInitialChargeConsumption - The consumption associated with initial charge of exported equipment (like tCO2e)

Method Details

getImportInitialChargeValue

public EngineNumber getImportInitialChargeValue()

Get the volume of substance imported via initial charge on imported equipment.

Returns:

The initial charge value in volume units like kg

getImportInitialChargeConsumption

public EngineNumber getImportInitialChargeConsumption()

Get the consumption associated with initial charge of imported equipment.

Returns:

The initial charge consumption value in units like tCO2e

getImportPopulation

public EngineNumber getImportPopulation()

Get the number of new units imported.

Returns:

The import population value in units

getExportInitialChargeValue

public EngineNumber getExportInitialChargeValue()

Get the volume of substance exported via initial charge on exported equipment.

Returns:

The initial charge value in volume units like kg

getExportInitialChargeConsumption

public EngineNumber getExportInitialChargeConsumption()

Get the consumption associated with initial charge of exported equipment.

Returns:

The initial charge consumption value in units like tCO2e