Interface InspectDataModelParams

Parameters for inspectDataModel.

interface InspectDataModelParams {
    checkIfcElementContainment?: boolean;
    checkIfcSpatialHierarchy?: boolean;
    checkRelationshipCycles?: boolean;
    checkRelationshipTypeBinding?: boolean;
    checkSchemaTagging?: boolean;
    cycleRelationshipTypes?: readonly string[];
    dataModel: DataModel;
    ifcAggregationType?: string;
    ifcElementSuperTypes?: readonly string[];
    ifcSpatialParents?: { [childType: string]: readonly string[] };
    ifcSpatialStructureSuperTypes?: readonly string[];
    onProgress?: (progress: inspect.dataModel.InspectProgress) => void;
    registry?: inspect.dataModel.InspectionRegistry;
    schema?: DataFormatSchema;
    signal?: AbortSignal;
}

Properties

checkIfcElementContainment? checkIfcSpatialHierarchy? checkRelationshipCycles? checkRelationshipTypeBinding? checkSchemaTagging? cycleRelationshipTypes? dataModel ifcAggregationType? ifcElementSuperTypes? ifcSpatialParents? ifcSpatialStructureSuperTypes? onProgress? registry? schema? signal?

Properties

OptionalcheckIfcElementContainment

checkIfcElementContainment?: boolean

Enable ifcElementContainment: flag IFC elements that are aggregated under a spatial structure instead of contained via IfcRelContainedInSpatialStructure. Needs schema.

OptionalcheckIfcSpatialHierarchy

checkIfcSpatialHierarchy?: boolean

Enable ifcSpatialHierarchy: walk the IFC Project → Site → Building → Storey → Space chain.

OptionalcheckRelationshipCycles

checkRelationshipCycles?: boolean

Enable relationshipCycles: directed-graph cycle scan over container-style relationships.

OptionalcheckRelationshipTypeBinding

checkRelationshipTypeBinding?: boolean

Enable relationshipTypeBinding: validates each relationship's endpoint types against the schema's allowed-types lists, honouring super-type inheritance.

OptionalcheckSchemaTagging

checkSchemaTagging?: boolean

Enable schemaTagging: compares per-entity schema fields against DataFormatSchema.id.

OptionalcycleRelationshipTypes

cycleRelationshipTypes?: readonly string[]

Relationship type ids treated as containment for the cycle scan. Defaults to IfcRelAggregates, IfcRelNests, IfcRelContainedInSpatialStructure.

dataModel

dataModel: DataModel

OptionalifcAggregationType

ifcAggregationType?: string

Aggregation relationship type used by ifcSpatialHierarchy and ifcElementContainment. Defaults to "IfcRelAggregates".

OptionalifcElementSuperTypes

ifcElementSuperTypes?: readonly string[]

Super-type ids that classify a DataObject as an IFC building / furnishing element. Defaults to ["IfcElement"]; set to ["IfcBuildingElement"] to be stricter.

OptionalifcSpatialParents

ifcSpatialParents?: { [childType: string]: readonly string[] }

Override the canonical IFC4 allowed-parents map used by ifcSpatialHierarchy. Keyed by child type.

OptionalifcSpatialStructureSuperTypes

ifcSpatialStructureSuperTypes?: readonly string[]

Super-type ids that classify a DataObject as an IFC spatial structure element. Defaults to ["IfcSpatialStructureElement"].

OptionalonProgress

onProgress?: (progress: inspect.dataModel.InspectProgress) => void

Honoured by inspectDataModelAsync only.

Optionalregistry

registry?: inspect.dataModel.InspectionRegistry

Defaults to DEFAULT_INSPECTION_REGISTRY.

Optionalschema

schema?: DataFormatSchema

When supplied, schema-aware inspections (type registration, type binding, schema tagging) light up; when omitted, only the structural always-on inspections fire.

Optionalsignal

signal?: AbortSignal

Honoured by inspectDataModelAsync only.

Settings

Member Visibility

On This Page

Properties