rs3.results.JointResults module#

class rs3.results.JointResults.JointNodalResults(grpcNodalResults)#

Bases: object

Nodal result wrapper with per-material data access.

Notes

  • EntityNames/EntityIDs correspond to owning entities for this node.

property EntityName#
property EntityID#
property NodeID#
property XCoordinate#
property YCoordinate#
property ZCoordinate#
class rs3.results.JointResults.JointElementResults(grpcElementResults)#

Bases: object

Element-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 FailureType#
getResults(dataType: InterfaceResultTypes) → list[float]#
class rs3.results.JointResults.JointResults(client: Client, projectId: str, stageNumber: list[int], srfResultIndex: int)#

Bases: _ProxyObject

Entry point to query joint 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 Joint Result Script Example.

getJointNodeResults(entityNames: list[str] | None = None, region: Cube | Cylinder | Sphere | None = None, includeIntersecting: bool = True) → list[JointNodalResults]#
getJointElementResults(entityName: str | None = None, region: Cube | Cylinder | Sphere | None = None, includeIntersecting: bool = True) → list[JointElementResults]#