Skip to main content

ifc_properties/
lib.rs

1//! `ifc-properties` -- Property sets, quantities and units -- the non-geometric payload most
2//!
3//! consumers actually want.
4//!
5//! `references/ifc-spec/` ships the official property set definitions as XML:
6//! 317 for IFC2x3 and 420 for IFC4. That is a machine-readable catalogue, so
7//! standard Psets are data here rather than hand-written tables.
8//!
9//! # Module map
10//!
11//! | Module | Role |
12//! |---|---|
13//! | `pset` | `IfcPropertySet` and single/enumerated/list/table properties |
14//! | `quantity` | `IfcElementQuantity`: length, area, volume, weight, count |
15//! | `template` | `IfcPropertySetTemplate`, property templates, and sets checked against them |
16//! | `unit` | Unit assignment, prefixes and conversion-based units |
17//! | `convert` | Conversion between units, named conversion units, length formatting |
18//! | `value` | `IfcValue` measure types and their interpretation |
19//! | `query` | Per-object resolution of property and quantity sets with type inheritance; lookup by name |
20//! | `nesting` | Bounded, cycle-aware traversal of complex properties and quantities |
21//! | `error` | Why a property lookup failed |
22//!
23//! # Status
24//!
25//! Implemented: `value`, `pset`, `quantity` (including transactional quantity
26//! edits), `unit`, `template`, `query` and the release-bound `exact` lookups.
27//! The shipped Pset/Qto catalogue is `ifc-template-catalog`. Open work is
28//! tracked in GitHub issues.
29//!
30//! # What this crate will not do
31//!
32//! It never computes a shape measurement. An `IfcQuantityArea` is what the
33//! authoring tool asserted, and it may disagree with the geometry. Callers
34//! that want a check compute the value with a geometry service and pass it to
35//! [`compare`], which reports agreement rather than inventing it.
36//!
37//! # Releases
38//!
39//! The release features (`ifc2x3`, `ifc4`, `ifc4x1`, `ifc4x2`, `ifc4x3`, all
40//! on by default) choose which schema tables are linked (#306). Release-bound
41//! reads refuse a release the build leaves out with `UnsupportedSchema`.
42//! Permissive reads take the IFC4 ADD2 TC1 table as their baseline, or the
43//! newest release the build bundles when IFC4 is left out, so a build
44//! naming no release at all is refused at compile time.
45
46#[cfg(not(any(
47    feature = "ifc2x3",
48    feature = "ifc4",
49    feature = "ifc4x1",
50    feature = "ifc4x2",
51    feature = "ifc4x3"
52)))]
53compile_error!(
54    "ifc-properties reads through a release's schema table: enable at least \
55     one of the features `ifc2x3`, `ifc4`, `ifc4x1`, `ifc4x2` or `ifc4x3` \
56     (through `openbim-ifc`: `schema` or one of those release features)"
57);
58
59mod baseline;
60mod convert;
61mod error;
62mod exact;
63mod nesting;
64mod pset;
65mod quantity;
66mod query;
67mod template;
68mod unit;
69mod value;
70
71pub use convert::{
72    convert_value, format_length, named_units, unit_conversion, ConversionUnit, LengthFormat,
73    NamedUnit, UnitConversion, UnitConversionError,
74};
75pub use error::{PropertyAnomaly, PropertyError, PropertyResult, TemplateError};
76pub use exact::{
77    convert_between, exact_project_unit, measure_unit_type, resolve_unit, si_conversion,
78    si_to_project, MeasureUnitType,
79};
80pub use exact::{
81    exact_material_properties_where, exact_material_property, exact_material_property_sets_where,
82    exact_predefined_sets, exact_properties, exact_properties_where, exact_property,
83    exact_property_sets_where, exact_schema, exact_unit, ExactBoundedValue, ExactComplexMember,
84    ExactComplexValue, ExactEntityRef, ExactEnumeratedValue, ExactEnumeration, ExactLogical,
85    ExactPredefinedSet, ExactProperty, ExactPropertyEntry, ExactPropertyError,
86    ExactPropertySetEntry, ExactReferenceValue, ExactResolution, ExactSource, ExactTableRow,
87    ExactTableValue, ExactTypedValue, ExactUnit, ExactUnitError, ExactValue, PropertyIndex,
88};
89/// The IFC release an exact resolution binds to (re-exported from `ifc-schema`).
90pub use ifc_schema::SchemaVersion;
91pub use pset::{
92    add_complex_property, add_complex_property_template,
93    add_complex_property_template_with_owner_history, add_door_lining_properties,
94    add_door_lining_properties_with_owner_history, add_door_panel_properties,
95    add_door_panel_properties_with_owner_history, add_element_quantity,
96    add_element_quantity_with_owner_history, add_permeable_covering_properties,
97    add_permeable_covering_properties_with_owner_history, add_physical_complex_quantity,
98    add_profile_properties, add_property_bounded_value, add_property_dependency_relationship,
99    add_property_enumerated_value, add_property_enumeration, add_property_list_value,
100    add_property_reference_value, add_property_set, add_property_set_template,
101    add_property_set_template_with_owner_history, add_property_set_with_owner_history,
102    add_property_single_value, add_property_table_value, add_reinforcement_bar_properties,
103    add_reinforcement_definition_properties,
104    add_reinforcement_definition_properties_with_owner_history, add_section_properties,
105    add_section_reinforcement_properties, add_window_lining_properties,
106    add_window_lining_properties_with_owner_history, add_window_panel_properties,
107    add_window_panel_properties_with_owner_history, attach_property_set,
108    attach_property_set_with_owner_history, attach_template, attach_template_with_owner_history,
109    attach_type, attach_type_with_owner_history, bounded_slot, complex_quantity_slot, complex_slot,
110    defines_by_template_slot, defines_by_type_slot, defines_slot, element_quantity_slot,
111    enumerated_slot, list_slot, property, property_checked, property_set, property_set_checked,
112    property_sets_by_object, pset_slot, pset_template_slot, reference_slot, single_value_slot,
113    table_slot, AttachedSets, Attachment, DoorLiningDraft, Property, PropertySet, PropertyValue,
114    ReinforcementBarDraft, SectionReinforcementDraft, TableValueDraft, WindowLiningDraft,
115};
116pub use quantity::{
117    add_quantity_to_set, compare, create_quantity, create_quantity_with, set_description, set_name,
118    set_quantity_value, Comparison, ComputedQuantity, QuantityExtras, Tolerance,
119};
120pub use quantity::{
121    quantity_set, quantity_sets, quantity_sets_by_object, stated_unit, AttachedQuantitySets,
122    Quantity, QuantityKind, QuantitySet, UnresolvedValue,
123};
124pub use query::{
125    properties_of, property_value, quantities_of, quantity_value, resolved_properties,
126    resolved_quantities, ResolvedProperties, ResolvedQuantities, ResolvedQuantitySet, ResolvedSet,
127    Source,
128};
129pub use template::{
130    property_set_template, property_set_template_checked, property_set_templates,
131    property_template, property_template_checked, template_deviations, template_of_set,
132    MeasureRole, PropertySetTemplate, PropertyTemplate, PropertyTemplateKind, TemplateFinding,
133    TemplateReport, UndecidedReason,
134};
135#[allow(deprecated)]
136pub use unit::add_monetary_unit;
137pub use unit::{
138    add_context_dependent_unit, add_conversion_based_unit, add_conversion_based_unit_with_offset,
139    add_derived_unit, add_derived_unit_element, add_dimensional_exponents, add_measure_with_unit,
140    add_si_unit, assign_units, create_monetary_unit, prefix_exponent, project_unit_for,
141    project_units, unit, unit_type, ConversionBasedUnitDraft, MonetaryUnitDraft, SiUnitDraft,
142    UnitKind,
143};
144pub use value::{MeasureValue, Scalar};