ifcopenshell.api.alignment.add_positioning_referent

Module Contents

ifcopenshell.api.alignment.add_positioning_referent.add_positioning_referent(file: ifcopenshell.file, name: str, alignment: ifcopenshell.entity_instance, distance_along: float, station: float, positioned_product: ifcopenshell.entity_instance) → ifcopenshell.entity_instance

Semantically defines the position of a product along an alignment by adding an IfcReferent to the alignment that defines the stationing system.

Parameters:

  • alignment – the alignment to receive the referent

  • distance_along – distance along the alignment basis curve

  • station – station value

  • name – name to assign to IfcReferent.Name, typically a stringized version of the station value

  • positioned_product – the product whose position is informed by the referent

Returns:

referent

Example:

alignment = model.by_type("IfcAlignment")[0]
pier = model.by_type("IfcBridgePart")[0]
ifcopenshell.api.alignment.add_positioning_referent(model,name="Pier 1 Sta 1+00",alignment=alignment,distance_along=0.0,station=100.0,positioned_product=pier)