ifc-properties 0.5.3

Property sets, quantities, and unit resolution. No geometry.
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

//! The release an exact resolution binds to, and model-level validation.

use ifc_model::{Entity, EntityId, Model};
use ifc_schema::{for_version, Attribute, Schema, SchemaVersion};

use super::refs::require_exact_slots;
use super::ExactPropertyError;
use std::sync::Arc;

/// The release a resolution runs against: its version and bundled table.
#[derive(Clone, Copy)]
pub(super) struct Release {
    pub(super) version: SchemaVersion,
    pub(super) schema: &'static Schema,
}

impl Release {
    /// Fail closed on an entity the declared release does not define, then
    /// on a record whose slot count is not the release's arity.
    pub(super) fn require_exact_slots(
        self,
        entity_id: EntityId,
        entity: &Entity,
    ) -> Result<(), ExactPropertyError> {
        if self.schema.entity(entity.type_name.as_ref()).is_none() {
            return Err(self.not_in_schema(entity_id, entity.type_name.clone()));
        }
        require_exact_slots(self.schema, entity_id, entity)
    }

    pub(super) fn not_in_schema(self, entity: EntityId, name: Arc<str>) -> ExactPropertyError {
        ExactPropertyError::NotInSchema {
            entity,
            name,
            schema: self.version,
        }
    }

    /// The position and declaration of `entity`'s attribute `name` in this
    /// release, or `None` when the release does not declare it.
    pub(super) fn attribute(self, entity: &str, name: &str) -> Option<(usize, &'static Attribute)> {
        self.schema
            .attributes(entity)
            .into_iter()
            .enumerate()
            .find(|(_, attribute)| attribute.name.eq_ignore_ascii_case(name))
    }

    /// Whether `candidate` is a legal member of attribute `slot` of `entity`,
    /// as this release declares it.
    pub(super) fn slot_accepts(self, entity: &str, slot: usize, candidate: &str) -> bool {
        self.schema
            .attributes(entity)
            .get(slot)
            .is_some_and(|attribute| self.schema.accepts_type(&attribute.type_name, candidate))
    }
}

pub(super) fn validate_model(model: &Model) -> Result<Release, ExactPropertyError> {
    if !model.diagnostics().is_empty() {
        return Err(ExactPropertyError::IncompleteModel {
            diagnostics: model.diagnostics().len(),
        });
    }
    match model.header().schema.as_slice() {
        [] => Err(ExactPropertyError::MissingSchema),
        // Each release listed here is verified for exact resolution: IFC2X3
        // TC1 (#48), IFC4 ADD2 TC1, and IFC4X3 ADD2 (#76). Any other token,
        // including a release the schema crate bundles later, is refused
        // until it is verified, never approximated.
        [token] => match SchemaVersion::from_header_token(token) {
            Some(
                version @ (SchemaVersion::Ifc2x3 | SchemaVersion::Ifc4 | SchemaVersion::Ifc4x3),
            ) => Ok(Release {
                version,
                schema: for_version(version).expect("verified releases are bundled"),
            }),
            _ => Err(ExactPropertyError::UnsupportedSchema {
                schema: token.clone(),
            }),
        },
        schemas => Err(ExactPropertyError::MultipleSchemas {
            schemas: schemas.len(),
        }),
    }
}