PIRocksFFISTPModel class
Interface for managing general non-IFC EXPRESS models following ISO 10303 (STEP) standards.
This interface extends IModel to provide specialized functionality for
working with various STEP application protocols (APs) beyond IFC, including:
- AP203: Configuration controlled 3D design of mechanical parts and assemblies
- AP210: Electronic assembly interconnect and packaging design
- AP214: Core data for automotive mechanical design processes
- AP238: Model based integrated manufacturing (STEP-NC)
- AP242: Managed model based 3D engineering
- CIS/2: CIMSteel logical product model for structural steel
The concrete implementation of ISTPModel.
- Inheritance
-
- Object
- PIRocksFFIModel
- PIRocksFFISTPModel
- Implementers
Constructors
-
PIRocksFFISTPModel.new(PISchema _schema, Pointer<
Void> _nativeProject, Pointer<Void> _nativeModel, String _id) - constructor
- PIRocksFFISTPModel.nullModel()
-
constructor
factory
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
-
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
-
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
-
createComplexInstance(
{List< int> ? typeIds, List<String> ? typeNames}) → PIInstance - Creates a complex EXPRESS ENTITY instance.
-
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
-
deleteInstance(
InstanceHandle inst) → bool -
Removes an instance from the model and database.
inherited
-
exportModel(
String filePath, ExportFormat type) → bool -
Exports the model to the specified file path in the given format.
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
-
getHeader(
) → PIInstance -
Gets the header instance containing model metadata.
inherited
-
getHeaderClearTextRepresentation(
ExportFormat type) → String -
Gets the string representation of the header instance in the specified format.
inherited
-
getId(
) → String -
Gets the unique identifier of this model.
inherited
-
getInfo(
) → ModelInfo -
Gets generic information about the model as a
ModelInfoobject.inherited -
getInstance(
InstanceHandle instance) → PIInstance -
Gets an instance from the database by its persistent handle.
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
-
getLocation(
) → String -
Gets the database location/path of this model.
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
-
getProjectId(
) → String -
Gets the project ID that this model belongs to.
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
-
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
-
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
-
isReferenceType(
int typeId) → bool -
Checks if a type is a reference type (should not be composed in instance attributes).
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
-
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
-
saveHeader(
) → void -
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
-
uninitialize(
) → void -
models have the same life cycle as project
inherited
-
update(
String name, String desc) → bool -
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited