PIRocksFFIReferenceIFCMemoryModel class
final
- Inheritance
-
- Implemented types
-
Properties
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
id
→ String
-
no setterinherited
-
isNull
→ bool
-
Indicates whether the object represents a null value.
no setterinherited
-
isReference
→ bool
-
Returns true if this is a reference model (read-only)
no setterinherited
-
objectFactory
→ IObjectFactory
-
Gets the instance factory associated with this model
no setterinherited
-
projectPtr
→ Pointer<Void>
-
no setterinherited
-
ptr
→ Pointer<Void>
-
no setterinherited
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
-
schema
→ PISchema
-
no setterinherited
-
schemaEnum
→ SupportedSchema
-
Gets the schema enumeration value for this model.
no setterinherited
Methods
-
addChild(IInstance parent, IInstance child, {String relType = ''})
→ bool
-
Adds a child to a parent in the spatial hierarchy.
inherited
-
addMaterial(IInstance instance, IInstance material)
→ bool
-
Adds an IfcRelAssociatesMaterial association to an instance.
inherited
-
addPSet(IInstance instance, IInstance pset)
→ bool
-
Adds an IfcRelDefinesByProperties association to an instance.
inherited
-
addRepItemToShape(IInstance shape, IInstance repItem, IInstance styleItem)
→ PIInstance
-
Adds an IfcRepresentationItem to a shape with an optional IfcStyledItem.
inherited
-
addShape(IInstance instance, IInstance shape)
→ PIInstance
-
Adds a shape representation to an instance.
inherited
-
addShapeAsMappedItemToShape(IInstance shape, IInstance otherShape, IInstance style)
→ PIInstance
-
Adds a shape
otherShape as an IfcMappedItem to another shape instance.
inherited
-
addToLayer(IInstance instance, IInstance layer)
→ bool
-
Adds an IfcShapeRepresentation instance to a layer (IfcPresentationLayerAssignment
or IfcPresentationLayerWithStyle).
inherited
-
addTypeProduct(IInstance instance, IInstance typeProd)
→ bool
-
Associates an instance to an IfcRelDefinesByType relationship.
inherited
-
canDelete(IInstance inst)
→ bool
-
Checks if an instance can be safely deleted from the model.
inherited
-
clear()
→ bool
-
Clears all instances from the model. This completely empties the model database.
inherited
-
clearAttributeAggregateByPath(InstancePath path)
→ bool
-
Clears all elements from a 1D, 2D, or 3D aggregate using a path specification.
inherited
-
clearLayers(IInstance instance)
→ bool
-
Clears all layer assignments from an instance.
inherited
-
clearMaterials(IInstance instance)
→ bool
-
Clears all material assignments from an instance.
inherited
-
clearPSets(IInstance instance)
→ bool
-
Removes all property sets from an instance.
inherited
-
clearRelations(IInstance instance)
→ bool
-
Clears relations such as IfcRelDefinesByProperties, IfcRelDefinesByType, and
IfcRelAssociatesMaterial from an instance.
inherited
-
clearShapes(IInstance instance)
→ bool
-
Removes all shape representations from the specified instance.
inherited
-
convertShapeToMappedRepresentation(IInstance shape, IInstance prod, [double scale = 1.0])
→ PIInstance
-
Converts a shape to a mapped representation for sharing with another product.
inherited
-
copyChildrenOfTypesWithComposedDependency(IModel fromModel, IInstance fromInstance, IInstance toInstance, List<int> typeIds)
→ List<IInstance>
-
Copies children of specific types from
fromInstance to toInstance, potentially across models.
inherited
-
copyChildrenWithComposedDependency(IModel fromModel, IInstance fromInstance, IInstance toInstance, List<IInstance> children)
→ List<IInstance>
-
Copies spatial
children from fromInstance to toInstance, potentially across models.
inherited
-
copyInstance(IModel fromModel, IInstance instance)
→ PIInstance
-
Copies an instance from another model into this model.
inherited
-
copyInstanceWithComposedDependency(IModel fromModel, IInstance instance)
→ List<IInstance>
-
Copies an instance along with its composed dependency hierarchy from another model.
inherited
-
createEnum({int? typeId, String? typeName, int? value, String? stringValue})
→ PIEnum
-
Creates an EXPRESS enumeration instance.
inherited
-
createInstance({String? typeName, int? typeId, bool? setId})
→ PIInstance
-
Creates an ENTITY instance of the specified type.
inherited
-
createInstanceFromDictionary(Dictionary dictionary)
→ PIInstance
-
inherited
-
createNullInstance()
→ PIInstance
-
Creates a null instance representing an unset or missing value.
inherited
-
createReferenceInstance(InstanceHandle instHandle)
→ PIInstance
-
Creates an instance reference from an instance handle.
inherited
-
createSelect({int? typeId, String? typeName, int? selectedType})
→ PISelect
-
Creates an EXPRESS SELECT instance.
inherited
-
createTemplateController()
→ PIBlocklyTemplateController
-
Creates a template controller.
inherited
-
deleteChild(IInstance parent, IInstance child)
→ bool
-
Removes a child instance from its parent in the spatial hierarchy.
inherited
-
deleteInstance(InstanceHandle inst)
→ bool
-
Removes an instance from the model and database.
inherited
-
deleteTypeProduct(IInstance instance)
→ bool
-
Removes the type product association from an instance.
inherited
-
exportModel(String filePath, ExportFormat type)
→ bool
-
Exports the model to the specified file path in the given format.
inherited
-
getAddedInstances()
→ List<InstanceHandle>
-
Gets all instances that have been added to the reference model.
inherited
-
getAllChildrenTypes(InstanceHandle instance)
→ List<int>
-
Gets all spatial child types present under the specified instance.
inherited
-
getAttributeByPath(InstancePath path)
→ (FundamentalType, dynamic)
-
Gets an attribute value using a path specification.
inherited
-
getAttributeByPathAsDynamic(InstancePath path)
→ dynamic
-
Gets an attribute value using a path specification as a dynamic value.
inherited
-
getAttributeContainer(InstancePath path)
→ AttributeContainer
-
Gets the attribute container (IInstance or ISelect) at the specified path.
inherited
-
getAttributeValueFundamentalType(InstancePath path)
→ FundamentalType
-
Gets the fundamental type of the attribute value at the specified path.
inherited
-
getComplexInstanceTypeName(List<String> types)
→ String
-
inherited
-
getDeletedInstances()
→ List<InstanceHandle>
-
Gets all instances that have been marked for deletion from the reference model.
inherited
-
Gets the header instance containing model metadata.
inherited
-
Gets the string representation of the header instance in the specified format.
inherited
-
getId()
→ String
-
Gets the unique identifier of this model.
inherited
-
getIfcProject()
→ PIInstance
-
Retrieves the IfcProject instance from the model.
inherited
-
getInfo()
→ ModelInfo
-
Gets generic information about the model as a
ModelInfo object.
inherited
-
getInstance(InstanceHandle instance)
→ PIInstance
-
Gets an instance from the database by its persistent handle.
inherited
-
getInstanceRelation(InstanceHandle instance, int relTypeId, {bool bIncludeSub = false})
→ List<InstanceHandle>
-
Gets instances related to the specified instance by relation type.
inherited
-
getInstances()
→ List<InstanceHandle>
-
Gets all instance handles in the model.
inherited
-
getInstancesByFilter(List<int> ids, List<IdRange> range, int type)
→ List<IInstance>
-
Gets instances filtered by ID lists and/or ID ranges for a specific type.
inherited
-
getInstancesByTag(String tag)
→ List<PIInstance>
-
Gets all instances with the given tag.
inherited
-
getInstancesByType(int typeId, {bool includeSubType = false})
→ List<InstanceHandle>
-
Gets all instances of a given type.
inherited
-
getInstancesPaginated(InstanceHandle startingHandle, {int pageSize = 500})
→ List<InstanceHandle>
-
Gets instances paginated for efficient handling of large models.
inherited
-
getInstanceTypes({bool sorted = false})
→ List<String>
-
Gets a list of all instance types that appear at least once in the model.
inherited
-
getLayers(InstanceHandle instance)
→ List<InstanceHandle>
-
Gets all layers associated with an instance.
inherited
-
getLocation()
→ String
-
Gets the database location/path of this model.
inherited
-
getMappedShapeInShape(IInstance shape)
→ List<PIInstance>
-
inherited
-
getMatchingContext(IInstance geoRepContext)
→ PIInstance
-
Finds the IfcGeometricRepresentationContext in this model that most closely
matches the provided
geoRepContext.
inherited
-
getMaterials(InstanceHandle instance)
→ List<InstanceHandle>
-
Gets all IfcRelAssociatesMaterial relationships associated with an instance.
inherited
-
getModelLengthUnit()
→ IInstance
-
Gets the length unit instance defined in this model's IfcUnitAssignment.
inherited
-
getName()
→ String
-
Gets the human-readable name of this model.
inherited
-
getPlacementChildren(InstanceHandle parent)
→ List<PIInstance>
-
Retrieves children in the placement hierarchy for the given parent placement.
inherited
-
getProjectDeclaredReferences()
→ List<InstanceHandle>
-
Gets all instances of reference type declared in the project.
inherited
-
getProjectId()
→ String
-
Gets the project ID that this model belongs to.
inherited
-
getPSets(InstanceHandle inst)
→ List<PIInstance>
-
Gets all property sets (IfcRelDefinesByProperties relationships) associated
with an instance.
inherited
-
getReferenceInstances()
→ List<InstanceHandle>
-
Gets all instances from the original reference model that have not been updated.
inherited
-
getReferencingInstances(IInstance inst)
→ List<InstanceHandle>
-
Gets all instances that reference the specified instance.
inherited
-
getSchema()
→ ISchema
-
Gets the schema definition used by this model.
inherited
-
getShapes(InstanceHandle inst)
→ List<PIInstance>
-
Gets all shape representations associated with the instance.
inherited
-
getSpatialChildren(InstanceHandle parent)
→ List<PIInstance>
-
Gets all spatial children of the specified parent instance.
inherited
-
getTemplateController(InstanceHandle handle)
→ PIBlocklyTemplateController
-
Gets a Blockly template controller for the specified instance.
Currently not in use.
inherited
-
getTemplateControllerByType({int? typeId, String? typeName})
→ List<PIBlocklyTemplateController>
-
Gets Blockly template controllers by type.
Currently not in use.
inherited
-
getTypeCount(int type, {bool includeSubType = false})
→ int
-
Gets the approximate count of instances of the given type.
inherited
-
getTypeNameFromTypeId(int typeId)
→ String
-
inherited
-
getTypeProduct(InstanceHandle instance)
→ PIInstance
-
Gets the IfcRelDefinesByType relationship associated with an instance.
inherited
-
getUpdatedInstances()
→ List<InstanceHandle>
-
Gets all instances from the reference model that have been updated.
inherited
-
hasInverseOfType(InstanceHandle inst, String type)
→ bool
-
inherited
-
hasSameLengthUnit(IModel model)
→ bool
-
Checks if another model uses the same length unit as this model.
inherited
-
incrementTypeCount(int type)
→ int
-
Increments the type count for a specific type.
inherited
-
initialize(dynamic parameter)
→ void
-
models are always initialized
inherited
-
instanceFromBinary(Uint8List bin)
→ PIInstance
-
Instantiates an instance from binary data.
inherited
-
instanceFromJson(Map<String, dynamic> json)
→ PIInstance
-
Creates an instance declaratively from JSON data.
inherited
-
isAdded(int id)
→ bool
-
Checks if an instance ID represents an added instance.
inherited
-
isDeleted(int id)
→ bool
-
Checks if an instance ID has been marked for deletion.
inherited
-
isReferenceInstance(int id)
→ bool
-
Checks if an instance ID belongs to the original reference content.
inherited
-
isReferenceType(int typeId)
→ bool
-
Checks if a type is a reference type (should not be composed in instance attributes).
inherited
-
isUpdated(int id)
→ bool
-
Checks if an instance ID has been updated from its original state.
inherited
-
listInstancesOfType(String type, [bool includeSubType = false])
→ List<InstanceHandle>
-
inherited
-
nextInstanceId([bool incrementId = false])
→ int
-
Gets the next available instance identifier.
inherited
-
noSuchMethod(Invocation invocation)
→ dynamic
-
Invoked when a nonexistent method or property is accessed.
inherited
-
nullifyAttributeByPath(InstancePath path)
→ bool
-
Sets the attribute at the specified path to a null value.
inherited
-
removeAttributeFromAggregateByPath(InstancePath path)
→ bool
-
Removes a single element from an aggregate using a path specification.
inherited
-
removeLayer(IInstance instance, IInstance layer)
→ bool
-
Removes an instance from a layer.
inherited
-
removeMaterial(IInstance instance, IInstance material)
→ bool
-
Removes an IfcRelAssociatesMaterial relationship from an instance.
inherited
-
removePSet(IInstance instance, IInstance pset)
→ bool
-
Removes a specific property set from an instance.
inherited
-
removeShape(IInstance instance, InstanceHandle shape)
→ bool
-
Removes a specific shape representation from the instance.
inherited
-
resolveIndex(IInstance inst)
→ bool
-
Makes the instance's ID consistent with other instance IDs in the model.
inherited
-
resolveIndices(List<IInstance> instances)
→ bool
-
Makes instance IDs in the list consistent with other instance IDs in the model.
inherited
-
resolveIndicesWithIds(List<IInstance> instances, Map<int, int> ids)
→ bool
-
Resolves instance IDs while mapping them using the provided ID map.
inherited
-
Saves the header instance to the database.
inherited
-
saveInstance(IInstance inst, {String? tag})
→ bool
-
Saves an instance to the database.
inherited
-
saveInstances(List<IInstance> instances)
→ bool
-
Saves multiple instances to the database in a batch operation.
inherited
-
saveMetaData()
→ bool
-
Saves metadata to the database.
inherited
-
saveTemplateController(IBlocklyTemplateController controller)
→ bool
-
Saves a Blockly template controller.
Currently not in use.
inherited
-
setAttributeByPath(InstancePath path, dynamic value)
→ bool
-
Sets an attribute value using a path specification.
inherited
-
setAttributeByPathWithJson(InstancePath path, Map<String, dynamic> json)
→ bool
-
Sets an attribute value using both path specification and JSON data.
inherited
-
setNextInstanceId(int nextId)
→ bool
-
Sets the next instance identifier to use.
inherited
-
tagInstance(IInstance inst, String tag)
→ bool
-
Tags an instance with the specified tag string.
inherited
-
toString()
→ String
-
A string representation of this object.
inherited
-
undoDelete(int id)
→ bool
-
Restores a previously deleted instance from the reference content.
inherited
-
undoUpdate(InstanceHandle handle)
→ bool
-
Reverts updates made to a specific instance, restoring its original state.
inherited
-
uninitialize()
→ void
-
models have the same life cycle as project
inherited
-
update(String name, String desc)
→ bool
-
inherited
-
writeReferenceDataSectionToStream(IFileStream stream, bool bSkipUpdated, ExportFormat format)
→ bool
-
Writes the reference content to a file stream, optionally skipping updated instances.
inherited
-
writeUpdatedDataSectionToStream(IFileStream stream, ExportFormat format)
→ bool
-
Writes only the updated portions of the reference model to a file stream.
inherited