-
Notifications
You must be signed in to change notification settings - Fork 7
/
Exchange.yaml
128 lines (108 loc) · 4.13 KB
/
Exchange.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
class:
name: Exchange
superClass: Entity
example: exchange.json
doc: >
An Exchange is an input or output of a `Flow` in a `Process`. The amount
of an exchange is given in a specific unit of a quantity
(`FlowProperty`) of the flow. The allowed units and flow properties that
can be used for a flow in an exchange are defined by the flow property
information in that flow (see also the `FlowPropertyFactor` type).
properties:
- name: amount
index: 2
type: double
- name: amountFormula
index: 3
type: string
- name: baseUncertainty
index: 4
type: double
optional: true
- name: costFormula
index: 5
type: string
doc: A formula for calculating the costs of this exchange.
- name: costValue
index: 6
type: double
optional: true
doc: The costs of this exchange.
- name: currency
index: 7
type: Ref[Currency]
doc: The currency in which the costs of this exchange are given.
- name: defaultProvider
index: 8
type: Ref[Process]
doc: >
A default provider is a `Process` that is linked as the provider of a
product input or the waste treatment provider of a waste output. It
is just an optional default setting which can be also ignored when
building product systems in openLCA. The user is always free to link
processes in product systems ignoring these defaults (but the flows
and flow directions have to match of course).
- name: description
index: 9
type: string
doc: A general comment about the input or output.
- name: dqEntry
index: 10
type: string
doc: >
A data quality entry like `(1;3;2;5;1)`. The entry is a vector of
data quality values that need to match the data quality scheme for
flow inputs and outputs that is assigned to the `Process`. In such
a scheme the data quality indicators have fixed positions and the
respective values in the `dqEntry` vector map to these positions.
- name: flow
index: 11
type: Ref[Flow]
doc: The reference to the flow of the exchange.
- name: flowProperty
index: 12
type: Ref[FlowProperty]
doc: The quantity in which the amount is given.
- name: internalId
index: 13
type: int
doc: >
The process internal ID of the exchange. This is used to identify
exchanges unambiguously within a process (e.g. when linking
exchanges in a product system where multiple exchanges with the
same flow are allowed). The value should be >= 1.
- name: isAvoidedProduct
index: 14
type: boolean
doc: >
Indicates whether this exchange is an avoided product (or waste
flow). Note that there is a difference in the data model and the
openLCA user interface: in the user interface avoided products (waste
flows) are shown as outputs (inputs) but in the data model avoided
products (waste flows) have `isInput` set to `true` (`false`). The
reason for this is, that it is (maybe) more understandable in the
user interface that the production (treatment) of some other product
(waste) is avoided this way. However, openLCA links product inputs
and waste outputs to providers. Avoided flows are linked in the same
way but with a negative sign so that the respective upstream
(downstream) chain is subtracted effectively from the result. This is
why in the data model we have the `isInput` property set according to
this linking logic.
- name: isInput
index: 15
type: boolean
- name: isQuantitativeReference
index: 16
type: boolean
doc: >
Indicates whether the exchange is the quantitative reference of the
process.
- name: location
index: 17
type: Ref[Location]
- name: uncertainty
index: 18
type: Uncertainty
- name: unit
index: 19
type: Ref[Unit]