-
Notifications
You must be signed in to change notification settings - Fork 7
/
Ref.yaml
48 lines (42 loc) · 1.48 KB
/
Ref.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
class:
name: Ref
superClass: RefEntity
doc: >
A `Ref` is a reference to some entity. When serializing an entity (e.g.
a `Process`) that references another standalone entity (e.g. a `Flow` in
an `Exchange`) we do not want to write the complete referenced entity
into the serialized JSON object but just a reference. However, the
reference contains some meta-data like name, category path etc. that are
useful to display.
properties:
- name: category
index: 5
type: string
doc: >
The category path of the referenced entity, e.g.
`Elementary flows/Emissions to air/unspecified`.
- name: refUnit
index: 6
type: string
doc: >
This field is valid for references to entities which can have a
(reference) unit, like flows, impact categories, or flow properties.
- name: location
index: 7
type: string
doc: >
This field is only valid for references of processes or flows and
contains the location name or code of that respective process or
flow.
- name: flowType
index: 8
type: FlowType
doc: >
In case of a reference to a flow, this field can contain the type of
flow that is referenced.
- name: processType
index: 9
type: ProcessType
doc: >
In case of a reference to a process, this fiel can contain the type
of process that is referenced.