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

//! `ifc-cost` — cost semantics as a **view** over the model.
//!
//! # This crate owns no data
//!
//! It borrows a `&Model` and interprets entities that happen to be cost
//! entities. That is the whole design: the model stores structure, this crate
//! supplies meaning, and the two are separable.
//!
//! The consequences are the point:
//!
//! - **Optional.** An application that never touches cost compiles none of
//!   this. It is a cargo feature of the `ifc` facade crate.
//! - **Non-destructive.** Because the model holds the same entities with or
//!   without this crate, a file with cost data round-trips identically in
//!   either build. Verified in `ifc/tests/costing_roundtrip.rs`, which runs
//!   with no domain crate compiled at all.
//! - **Replaceable.** A different interpretation of the same entities is
//!   another crate, not a fork of the model.
//!
//! # Modules
//!
//! | Module | Role |
//! | --- | --- |
//! | [`view`] | [`CostView`]: the entry point, borrows a `&Model` |
//! | [`item`] | `IfcCostItem`: the individual line |
//! | [`schedule`] | `IfcCostSchedule`: the containing document |
//! | [`value`] | `IfcCostValue` and applied monetary values |
//! | [`quantity`] | Quantities a cost is computed against |
//! | [`relation`] | Nesting and control assignment |
//! | [`mutation`] | Transaction-staged bounded IFC4 authoring; release-bound quantities |
//! | [`currency`] | Monetary unit agreement |
//! | [`rollup`] | Summing a cost tree |
//! | [`error`] | Why a cost lookup failed |
//!
//! ```
//! use ifc_cost::CostView;
//! use ifc_model::{Entity, EntityId, Model, Value};
//!
//! let mut model = Model::new();
//! model.insert(
//!     EntityId(1),
//!     Entity::new("IFCCOSTITEM", vec![
//!         Value::Text("guid".into()), Value::Null, Value::Text("Excavation".into()),
//!     ]),
//! );
//!
//! let view = CostView::new(&model);
//! assert_eq!(view.items().next().unwrap().name(), Some("Excavation"));
//! ```

pub mod currency;
pub mod error;
pub mod item;
pub mod mutation;
pub mod quantity;
pub mod relation;
pub mod rollup;
pub mod schedule;
pub mod value;
pub mod view;

pub use currency::{monetary_units, project_currency, CurrencyError};
pub use error::CostError;
/// The IFC release a release-bound authoring error names (re-exported from
/// `ifc-schema`).
pub use ifc_schema::SchemaVersion;
pub use item::CostItem;
pub use mutation::{
    assign_schedule_items, assign_schedule_items_with_owner_history, create_cost_item,
    create_cost_item_with_owner_history, create_cost_schedule,
    create_cost_schedule_with_owner_history, create_cost_value, create_currency_relationship,
    create_monetary_unit, nest_cost_items, nest_cost_items_with_owner_history, CostAuthoringError,
    CostAuthoringResult, CostItemDraft, CostItemType, CostScheduleDraft, CostScheduleType,
    CostValueDraft, CostValueKind, NestingDraft, ScheduleAssignmentDraft,
};
pub use quantity::CostQuantity;
pub use relation::{
    children_of, controlled_by, controls_of, descendants_of, nesting_anomalies, parent_of,
    parents_of, CostAnomaly, CostRelationError, MAX_NESTING_DEPTH,
};
pub use rollup::{consistency, direct_total, grand_total, rolled_up_total, roots, Consistency};
pub use schedule::CostSchedule;
pub use value::{ArithmeticOperator, CostValue, UnitBasis};
pub use view::CostView;