ifc-cost 0.2.3

Cost semantics as a borrowed view over the IFC model.
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

//! `IfcCostSchedule` — the document containing cost items.

use ifc_model::{Entity, EntityId};

/// A borrowed view of an `IfcCostSchedule` entity.
#[derive(Debug, Clone, Copy)]
pub struct CostSchedule<'m> {
    id: EntityId,
    entity: &'m Entity,
}

/// `IfcCostSchedule` slots.
///
/// Same `IfcControl` prefix as `IfcCostItem`:
///
/// ```text
/// 0 GlobalId   1 OwnerHistory  2 Name      3 Description  4 ObjectType
/// 5 Identification  6 PredefinedType  7 Status  8 SubmittedOn  9 UpdateDate
/// ```
///
/// Slot 8 is `SubmittedOn`, NOT `PredefinedType`: reading the type from 8
/// returns a date string for any file that states one.
mod slot {
    /// `GlobalId` (from `IfcRoot`).
    pub const GLOBAL_ID: usize = 0;
    /// `Name` (from `IfcRoot`).
    pub const NAME: usize = 2;
    /// `Identification` (from `IfcControl`).
    pub const IDENTIFICATION: usize = 5;
    /// `PredefinedType`, e.g. `.BUDGET.`
    pub const PREDEFINED_TYPE: usize = 6;
    /// `Status`.
    pub const STATUS: usize = 7;
    /// `SubmittedOn`.
    pub const SUBMITTED_ON: usize = 8;
    /// `UpdateDate`.
    pub const UPDATE_DATE: usize = 9;
}

impl<'m> CostSchedule<'m> {
    /// Wrap an entity known to be an `IfcCostSchedule`.
    pub fn new(id: EntityId, entity: &'m Entity) -> Self {
        Self { id, entity }
    }

    /// The entity id in the file.
    pub fn id(&self) -> EntityId {
        self.id
    }

    /// The `GlobalId` string.
    pub fn global_id(&self) -> Option<&'m str> {
        self.entity.text(slot::GLOBAL_ID)
    }

    /// The schedule name.
    pub fn name(&self) -> Option<&'m str> {
        self.entity.text(slot::NAME)
    }

    /// The user-facing identification code.
    pub fn identification(&self) -> Option<&'m str> {
        self.entity.text(slot::IDENTIFICATION)
    }

    /// The authored status label, e.g. `Draft`.
    pub fn status(&self) -> Option<&'m str> {
        self.entity.text(slot::STATUS)
    }

    /// `SubmittedOn`, as the authored ISO-8601 string.
    pub fn submitted_on(&self) -> Option<&'m str> {
        self.entity.text(slot::SUBMITTED_ON)
    }

    /// `UpdateDate`, as the authored ISO-8601 string.
    pub fn update_date(&self) -> Option<&'m str> {
        self.entity.text(slot::UPDATE_DATE)
    }

    /// The predefined type token, e.g. `BUDGET`, without its dots.
    pub fn predefined_type(&self) -> Option<&'m str> {
        match self.entity.attribute(slot::PREDEFINED_TYPE)? {
            ifc_model::Value::Enum(e) => Some(e),
            _ => None,
        }
    }
}