IFClite TypeScript API
    Preparing search index...

    Interface RelatedEntityGroup

    One relationship kind/direction's contribution to a collectRelatedEntities result — e.g. "the openings reached via IfcRelVoidsElement, host role".

    interface RelatedEntityGroup {
        expressIds: number[];
        relationship: string;
        relationshipIds: number[];
        role: string;
    }
    Index
    expressIds relationship relationshipIds role
    expressIds: number[]

    ExpressIds of the related OBJECTS this group reached (never the IfcRel* relationship entity itself).

    relationship: string

    EXPRESS relationship type name, e.g. IfcRelVoidsElement.

    relationshipIds: number[]

    ExpressIds of the IfcRel* relationship entities that produced this group — these must ALSO be included in the export subset, or the association they represent has nothing naming it.

    role: string

    Which end of the relationship this group walked — e.g. 'opening' / 'host' for IfcRelVoidsElement, matching the doc at each walker's own call site rather than a fixed enum, since the meaningful roles differ per relationship kind.

    Settings
    Member Visibility

    On This Page
    Properties