ifcopenshell.api.alignment.get_stationing_nest

Module Contents

ifcopenshell.api.alignment.get_stationing_nest.get_stationing_nest(file: ifcopenshell.file, alignment: ifcopenshell.entity_instance) → ifcopenshell.entity_instance

Searches for the IfcRelNests that defines the alignment’s stationing scheme.

The returned nest is nested to the IfcAlignment and its RelatedObjects contains only the IfcReferent(s) (PredefinedType=”STATION”) that establish the alignment’s starting station and any station equations along it, as created by add_stationing_referent. It does not contain any other kind of referent (e.g. key-point referents from update_key_point_referents live in their own, separate IfcRelNests).

Parameters:
  • file

  • alignment – The IfcAlignment which hosts the stationing IfcReferent(s)

Returns:

Returns the IfcRelNests or None