Skip to main content

Module authoring

Module authoring 

Source
Expand description

Transactional authoring of systems, ports and their connections.

§Slot layouts come from the readers

Each relationship here has its own idea of which end is which: IfcRelAssignsToGroup names members at slot 4 and the group at 6, IfcRelNests parent at 4 and children at 5, IfcRelConnectsPortToElement port at 4 and element at 5. The reading side already encodes all of that; authoring resolves the same constants so one cannot be corrected without the other.

§Releases and OwnerHistory (#202)

IfcRoot.OwnerHistory is required in IFC2X3 TC1 and OPTIONAL from IFC4 on:

IFC2X3_TC1   OwnerHistory : IfcOwnerHistory;
IFC4         OwnerHistory : OPTIONAL IfcOwnerHistory;
IFC4X3_ADD2  OwnerHistory : OPTIONAL IfcOwnerHistory;

The writers without a model (create_system, connect_ports, …) cannot see the release. They write the IFC4/IFC4X3 layout with OwnerHistory $, so their records are IFC4/IFC4X3 only. Each has a *_with_owner_history variant that takes the model, binds its declared release (release.rs), lays the record out by attribute name from that release’s table, and takes a caller-supplied IfcOwnerHistory, which must exist (in the model or staged on the transaction) and be an IfcOwnerHistory; one is never invented here. This follows ifc-material (#77), ifc-properties (#191) and ifc-classification (#194). In IFC4 and IFC4X3 a variant writes the plain writer’s record with the reference in the optional slot.

Structs§

ClassifiedSystemDraft
Attributes of a classified system beyond GlobalId and Name.
ElementAttributes
Optional descriptive attributes shared by every distribution element.

Enums§

DistributionElementKind
A concrete distribution element class.
SystemAuthoringError
Why a systems record was refused.
SystemKind
Which classified system is being staged.

Functions§

assign_to_group
Stage an IfcRelAssignsToGroup: elements joined into a system.
assign_to_group_with_owner_history
assign_to_group in model’s declared release, with a caller-supplied IfcOwnerHistory.
connect_port_to_element
Stage an IfcRelConnectsPortToElement.
connect_port_to_element_with_owner_history
connect_port_to_element in model’s declared release, with a caller-supplied IfcOwnerHistory.
connect_ports
Stage an IfcRelConnectsPorts: the link the flow graph walks.
connect_ports_with_owner_history
connect_ports in model’s declared release, with a caller-supplied IfcOwnerHistory.
contain_in_spatial_structureDeprecated
Stage an IfcRelContainedInSpatialStructure.
contain_in_spatial_structure_with_owner_historyDeprecated
contain_in_spatial_structure in model’s declared release, with a caller-supplied IfcOwnerHistory.
create_classified_system
Stage a classified system.
create_classified_system_with_owner_history
create_classified_system in model’s declared release, with a caller-supplied IfcOwnerHistory (#202).
create_distribution_element
Stage a distribution element occurrence.
create_distribution_element_with_owner_history
create_distribution_element in model’s declared release, with a caller-supplied IfcOwnerHistory, which IFC2X3 requires (#202).
create_group
Stage an IfcGroup: an arbitrary named collection.
create_group_with_owner_history
create_group in model’s declared release, with a caller-supplied IfcOwnerHistory.
create_port
Stage an IfcDistributionPort.
create_port_with_owner_history
create_port in model’s declared release, with a caller-supplied IfcOwnerHistory.
create_spatial_zone
Stage an IfcSpatialZone: a zone that occupies space.
create_spatial_zone_with_owner_history
create_spatial_zone in model’s declared release, with a caller-supplied IfcOwnerHistory (#202).
create_system
Stage an IfcSystem.
create_system_with_owner_history
create_system in model’s declared release, with a caller-supplied IfcOwnerHistory, which IFC2X3 requires.
create_zone
Stage an IfcZone: spaces grouped for a shared purpose.
create_zone_with_owner_history
create_zone in model’s declared release, with a caller-supplied IfcOwnerHistory, which IFC2X3 requires (#202).
nest_ports
Stage an IfcRelNests: ports nested under the element owning them.
nest_ports_with_owner_history
nest_ports in model’s declared release, with a caller-supplied IfcOwnerHistory.
reference_in_spatial_structure
Stage an IfcRelReferencedInSpatialStructure.
reference_in_spatial_structure_with_owner_history
reference_in_spatial_structure in model’s declared release, with a caller-supplied IfcOwnerHistory.
serve_buildingsDeprecated
Stage an IfcRelServicesBuildings in model’s declared release, with OwnerHistory $: system serves buildings.
serve_buildings_with_owner_historyDeprecated
serve_buildings with a caller-supplied IfcOwnerHistory, which IFC2X3 requires.

Type Aliases§

SystemAuthoringResult
Result of staging a systems record.