ifc-template-catalog 0.4.0

Versioned IFC PSD/QTO catalog definitions and correction overlays
Documentation 
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

//! Property-template value forms.

use super::LocalizedText;

/// IFC value type and optional publication unit category.
#[derive(Debug, Clone, PartialEq, Eq, bincode::Encode, bincode::Decode)]
pub struct PropertyDataType {
    /// IFC value type; `None` preserves malformed official entries with an empty `DataType`.
    pub type_name: Option<String>,
    /// Publication unit category (e.g. `LENGTHUNIT`), absent when unspecified.
    pub unit_type: Option<String>,
}

impl PropertyDataType {
    /// Build a data type with a known `type_name` and no declared unit category.
    pub fn new(type_name: impl Into<String>) -> Self {
        Self {
            type_name: Some(type_name.into()),
            unit_type: None,
        }
    }
}

/// One documented value from a PSD `ConstantList`.
#[derive(Debug, Clone, PartialEq, Eq, bincode::Encode, bincode::Decode)]
pub struct EnumerationConstant {
    /// Constant's `Name` as declared by the `ConstantList` entry.
    pub name: String,
    /// Constant's `Definition` prose, absent when the publication omitted it.
    pub definition: Option<String>,
    /// Localized alternates for `name` in other publication languages.
    pub name_aliases: Vec<LocalizedText>,
    /// Localized alternates for `definition` in other publication languages.
    pub definition_aliases: Vec<LocalizedText>,
}

/// External property template.
#[derive(Debug, Clone, PartialEq, Eq, bincode::Encode, bincode::Decode)]
pub struct PropertyTemplate {
    /// `Name` as declared by the publication.
    pub name: String,
    /// Publication `GlobalId`, absent when the source did not assign one.
    pub guid: Option<String>,
    /// `Definition` prose, absent when the publication omitted it.
    pub definition: Option<String>,
    /// Localized alternates for `name` in other publication languages.
    pub name_aliases: Vec<LocalizedText>,
    /// Localized alternates for `definition` in other publication languages.
    pub definition_aliases: Vec<LocalizedText>,
    /// Value form, corresponding to an `IfcSimplePropertyTemplateTypeEnum` case.
    pub kind: PropertyKind,
}

/// PSD property value form, mirroring `IfcSimplePropertyTemplateTypeEnum`
/// plus the `IfcComplexPropertyTemplate` case.
#[derive(Debug, Clone, PartialEq, Eq, bincode::Encode, bincode::Decode)]
#[non_exhaustive]
pub enum PropertyKind {
    /// `P_SINGLEVALUE`: one scalar value of `data_type`.
    SingleValue {
        /// Value type and unit category for the scalar.
        data_type: PropertyDataType,
    },
    /// `P_BOUNDEDVALUE`: an upper/lower/set-point triple of `data_type`.
    BoundedValue {
        /// Value type and unit category shared by the bound values.
        data_type: PropertyDataType,
    },
    /// `P_ENUMERATEDVALUE`: a selection from a fixed list of lexical values
    /// or documented constants.
    EnumeratedValue {
        /// Name of the referenced `IfcPropertyEnumeration`, absent when inline.
        enumeration_name: Option<String>,
        /// Value type and unit category of the enumeration members, absent
        /// when the publication left it implicit.
        data_type: Option<PropertyDataType>,
        /// Lexical values from `EnumList`, in publication order.
        values: Vec<String>,
        /// Documented constants from `ConstantList`, kept distinct from lexical values.
        constants: Vec<EnumerationConstant>,
    },
    /// `P_LISTVALUE`: an ordered list of values of `data_type`.
    ListValue {
        /// Value type and unit category shared by every list element.
        data_type: PropertyDataType,
    },
    /// `P_REFERENCEVALUE`: a reference to another entity of `reference_type`.
    ReferenceValue {
        /// IFC entity type the reference must resolve to.
        reference_type: String,
    },
    /// `P_TABLEVALUE`: a lookup table pairing `defining_type` keys with
    /// `defined_type` values, optionally constrained by `expression`.
    TableValue {
        /// Value type of the table's defining (key) column.
        defining_type: PropertyDataType,
        /// Value type of the table's defined (value) column.
        defined_type: PropertyDataType,
        /// Optional formula constraining defined values from defining values.
        expression: Option<String>,
    },
    /// An `IfcComplexPropertyTemplate`: a named grouping of nested property templates.
    Complex {
        /// `UsageName` distinguishing this grouping's role.
        usage_name: String,
        /// Nested property templates that make up this grouping.
        properties: Vec<PropertyTemplate>,
    },
}