Skip to main content

IFCExplore

Model-wide discovery methods to explore what exists in a loaded IFC model.

GetTypes

Returns all unique IFC class types used in the model with usage counts. Optionally filter to subtypes of a base class.

Inputs:

ParameterTypeDescription
ifcModelIFCModelThe loaded IFC Model
baseClassstringOptional base class to filter results (e.g., "IfcBuildingElement" returns only walls, doors, windows, etc.). Empty returns all product types.

Output:

TypeDescription
List of DictionaryEach dictionary contains IfcClass, Count, and PredefinedTypes used

GetTypeObjects

Returns all IfcTypeObject instances in the model. Optionally filter by type class.

Inputs:

ParameterTypeDescription
ifcModelIFCModelThe loaded IFC Model
ifcTypeClassstringOptional type class filter (e.g., "IfcWallType", "IfcDoorType"). Empty returns all type objects.

Output:

TypeDescription
List of DictionaryEach dictionary contains GlobalId, Name, IfcClass, and AppliedToCount

GetMaterials

Returns all materials in the model with usage counts.

Inputs:

ParameterTypeDescription
ifcModelIFCModelThe loaded IFC Model

Output:

TypeDescription
List of DictionaryEach dictionary contains Name, Category, UsageCount, and HasProperties

GetMaterialStructures

Returns all material layer sets, profile sets, and constituent sets in the model.

Inputs:

ParameterTypeDescription
ifcModelIFCModelThe loaded IFC Model

Output:

TypeDescription
List of DictionaryFull material structure details

GetPropertySets

Returns all property sets in the model with usage information. Optionally filter by property set name.

Inputs:

ParameterTypeDescription
ifcModelIFCModelThe loaded IFC Model
psetNamestringOptional PSet name filter. Empty returns all.

Output:

TypeDescription
List of DictionaryPSet details

GetQuantitySets

Returns all quantity sets in the model with usage information. Optionally filter by quantity set name.

Inputs:

ParameterTypeDescription
ifcModelIFCModelThe loaded IFC Model
qsetNamestringOptional QSet name filter. Empty returns all.

Output:

TypeDescription
List of DictionaryQSet details

GetPropertyValues

Returns property values distribution or detailed values for a property across the model.

Inputs:

ParameterTypeDescription
ifcModelIFCModelThe loaded IFC Model
propertyNamestringProperty name: "PropertyName" or "PsetName.PropertyName"
verboseboolIf true, returns all values with element GlobalIds. If false, returns value counts.

Output:

TypeDescription
Dictionary or ListValue counts (verbose=false) or list of value details (verbose=true)

GetQuantityValues

Returns quantity values distribution or detailed values for a quantity across the model.

Inputs:

ParameterTypeDescription
ifcModelIFCModelThe loaded IFC Model
quantityNamestringQuantity name: "QuantityName" or "QsetName.QuantityName"
verboseboolIf true, returns all values with element GlobalIds. If false, returns statistics.

Output:

TypeDescription
Dictionary or ListStatistics like Min, Max, Sum, Count, Average (verbose=false) or list of value details (verbose=true)

GetClassifications

Returns all classification systems used in the model.

Inputs:

ParameterTypeDescription
ifcModelIFCModelThe loaded IFC Model

Output:

TypeDescription
List of DictionaryClassification system details

GetDocuments

Returns all documents referenced in the model.

Inputs:

ParameterTypeDescription
ifcModelIFCModelThe loaded IFC Model

Output:

TypeDescription
List of DictionaryDocument details and usage counts

GetGroups

Returns all groups, systems, and zones in the model. Optionally filter by group type.

Inputs:

ParameterTypeDescription
ifcModelIFCModelThe loaded IFC Model
groupTypestringOptional filter: "IfcGroup", "IfcSystem", "IfcZone", or empty for all

Output:

TypeDescription
List of DictionaryGroup details

GetSpatialElements

Returns all spatial elements in the model. Optionally filter by spatial type.

Inputs:

ParameterTypeDescription
ifcModelIFCModelThe loaded IFC Model
spatialTypestringOptional filter: "Site", "Building", "Storey", "Space", or empty for all

Output:

TypeDescription
List of DictionarySpatial element details

GetSpatialStructure

Returns the complete spatial hierarchy tree of the model.

Inputs:

ParameterTypeDescription
ifcModelIFCModelThe loaded IFC Model

Output:

TypeDescription
DictionaryProject tree structure

GetProjectContext

Returns complete project context including units, coordinate system, and project info.

Inputs:

ParameterTypeDescription
ifcModelIFCModelThe loaded IFC Model

Output:

TypeDescription
DictionaryProject context details