rs3.results.CompositeLinerResults module#
- class rs3.results.CompositeLinerResults.LinerNodalResults(grpcNodalResults)#
Bases:
objectNodal result wrapper with per-material data access.
Notes
EntityNames/EntityIDs correspond to owning entities for this node.
- property EntityName#
- property EntityID#
- property LayerIndex#
- property NodeID#
- property XCoordinate#
- property YCoordinate#
- property ZCoordinate#
- property AssignedPropertyName#
- property AttachedLinerLayersAboveIndex#
- property AttachedLinerLayersBelowIndex#
- property AttachedInterfaceLayerAboveIndex#
- property AttachedInterfaceLayerBelowIndex#
- property NodeDetails#
- class rs3.results.CompositeLinerResults.LinerElementResults(grpcElementResults)#
Bases:
objectElement-level results wrapper for a specific stage/SRF context.
Notes
AttachedNodes returns a copy of node IDs; modifying it does not affect internal state.
getResult(dataType) returns the value of that node in the given element when it is in the global coordinate system. It returns the average across the elements about that node when the local axes is defined.
- property ElementID#
- property AttachedNodeIDs#
- property EntityName#
- property EntityId#
- property LayerIndex#
- property AssignedPropertyName#
- property AttachedLinerLayersAboveIndex#
- property AttachedLinerLayersBelowIndex#
- property AttachedInterfaceLayerAboveIndex#
- property AttachedInterfaceLayerBelowIndex#
- property FailureType#
- getResults(dataType: LinerResultTypes) list[float]#
- class rs3.results.CompositeLinerResults.InterfaceNodalResults(grpcNodalResults)#
Bases:
objectNodal result wrapper with per-material data access.
Notes
EntityNames/EntityIDs correspond to owning entities for this node.
- property EntityName#
- property EntityID#
- property LayerIndex#
- property AssignedPropertyName#
- property AttachedLinerLayersAboveIndex#
- property AttachedLinerLayersBelowIndex#
- property NodeID#
- property XCoordinate#
- property YCoordinate#
- property ZCoordinate#
- class rs3.results.CompositeLinerResults.InterfaceElementResults(grpcElementResults)#
Bases:
objectElement-level results wrapper for a specific stage/SRF context.
Notes
AttachedNodes returns a copy of node IDs; modifying it does not affect internal state.
- property ElementID#
- property AttachedNodeIDs#
- property EntityName#
- property EntityID#
- property LayerIndex#
- property AssignedPropertyName#
- property AttachedLinerLayersAboveIndex#
- property AttachedLinerLayersBelowIndex#
- property FailureType#
- getResults(dataType: InterfaceResultTypes) list[float]#
- class rs3.results.CompositeLinerResults.CompositeLinerResults(client: Client, projectId: str, stageNumber: list[int], srfResultIndex: int)#
Bases:
_ProxyObjectEntry point to query composite liner nodal/element results for a given stage and SRF.
- Parameters:
stageNumber (int) – 1-based stage index.
srfResultIndex (int) – 0-based SRF value index. 0 is to query SRF-None values.
Notes
entityName is trimmed; empty strings are ignored.
region=None leaves the proto field unset (service returns all).
Exceptions from the underlying service are propagated as-is by the client.
Examples
See Composite Liner Result Script Example.
- getLinerNodeResults(entityName: str | None = None, region: Cube | Cylinder | Sphere | None = None, includeIntersecting: bool = True) list[LinerNodalResults]#
- getLinerElementResults(entityName: str | None = None, region: Cube | Cylinder | Sphere | None = None, includeIntersecting: bool = True) list[LinerElementResults]#
- getInterfaceNodeResults(entityNames: list[str] | None = None, region: Cube | Cylinder | Sphere | None = None, includeIntersecting: bool = True) list[InterfaceNodalResults]#
- getInterfaceElementResults(entityNames: list[str] | None = None, region: Cube | Cylinder | Sphere | None = None, includeIntersecting: bool = True) list[InterfaceElementResults]#
- setCoordinateSystem(coordinateSystemName: str) None#
- getCoordinateSystem() str#