ifc-systems 0.2.0

Distribution systems, ports, and connectivity between elements.
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

//! `ifc-systems` -- Distribution systems: ports, connectivity and system grouping.
//!
//!
//! 23 entities in IFC4. Turns a bag of pipes and ducts into a connected network
//! that can be traced -- the basis of any MEP analysis.
//!
//! # Module map
//!
//! | Module | Role |
//! |---|---|
//! | `system` | `IfcSystem`, `IfcDistributionSystem` and grouping |
//! | `port` | `IfcDistributionPort` and port assignment to elements |
//! | `connectivity` | `IfcRelConnectsPorts` and network traversal |
//! | `flow` | Flow direction and segment/fitting/terminal roles |
//! | `error` | Why a system query failed |
//!
//! # Status
//!
//! Partial. Implemented: SYS-ROOT (systems, subtype-aware discovery and
//! membership), SYS-PORT (ports and both element-attachment forms) and
//! SYS-CONN (the undirected connection graph with cycle-safe traversal).
//! `flow`, `zone` and `assignment` are reserved with intent, not implemented
//! -- see `../PLAN.md` for the stages that fill them.

pub mod authoring;
mod connectivity;
mod error;
mod flow;
mod port;
mod system;

pub use authoring::{
    assign_to_group, connect_port_to_element, connect_ports, contain_in_spatial_structure,
    create_classified_system, create_group, create_port, create_system, nest_ports,
    reference_in_spatial_structure, ClassifiedSystemDraft, SystemAuthoringError,
    SystemAuthoringResult, SystemKind,
};
pub use connectivity::{
    Connection, ConnectionGraph, Direction, FlowNetwork, FlowQuery, NetworkGraph,
};
pub use error::SystemAnomaly;
pub use flow::{role_inconsistencies, ElementRole, FlowDirection, RoleInconsistency};
pub use port::{ports, Attachment, Port};
pub use system::{systems, System};
pub use zone::{spatial_placements, zones, SpatialPlacement, Zone};

mod assignment;
pub(crate) mod zone;