RefEntity
A RefEntity
is an entity that can be identified by a reference ID (or UUID). In most cases this is a stand-alone entity (RootEntity
) but there are also entities (e.g. Unit
, NwSet
) that need a unique ID, e.g. for reference data lists or mapping files.
Properties
@type
Inherited from Entity.@type
- Type:
string
(external doc) - Proto-Index: 1
@id
The reference ID (or UUID) of this entity.
- Type:
string
(external doc) - Proto-Index: 2
name
The name of the entity.
- Type:
string
(external doc) - Proto-Index: 3
description
The description of the entity.
- Type:
string
(external doc) - Proto-Index: 4
Python class stub
The snippet below shows the names of the properties of the corresponding Python class of the olca-schema package. Note that this is not the full class definition but just shows the names of the class and its properties.
@dataclass
class RefEntity:
id: str
description: str
name: str