rs3.results.PileForepoleResults module#

class rs3.results.PileForepoleResults.PileNodeResults(grpcNodeResults)#

Bases: object

property NodeID#
property XCoordinate#
property YCoordinate#
property ZCoordinate#
property EntityName#
property EntityID#
property PileID#
class rs3.results.PileForepoleResults.PileForepoleElementResults(grpcElementResults)#

Bases: object

property EntityName#
property EntityID#
property AttachedNodeIDs#
property PileID#
property BeamID#
property InterfaceID#
getNodeResult(dataType: BeamsDataType | PileInterfaceDataType) → List[float]#
getResultsInNodeDataTuple(dataType: BeamsDataType | PileInterfaceDataType) → List[Tuple[int, float]]#
property YieldedElement#
property InterfaceYieldedElement#
class rs3.results.PileForepoleResults.PileForepoleResults(client: Client, projectId: str, stageNumber: int, srfResultIndex: int)#

Bases: _ResultsQueryBase

Entry point to query pile forepole 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 Pile Result Script Example.

getPileForepoleNodeResults(entityName: str | None = None, region: Cube | Cylinder | Sphere | None = None, includeIntersecting: bool = True) → list[PileNodeResults]#

Query pile forepole node results at a specific stage and SRF value. :param entityName: Optional[str]: If provided, only nodes belonging to the specified entity are queried. :param region: Optional[Union[Cube, Cylinder, Sphere]]: Sample region filter. When None, the field is not set in the request (proto3 unset), and the service returns all nodes. :param includeIntersecting: bool: If True, nodes that intersect the sample region are included. When False, only nodes fully contained are included. Ignored when region is None.

Raises:

Exception if –

  • stageNumber is less than 1 - stageNumber is greater than the number of stages in the project - _srfResultIndex is less than 0 - _srfResultIndex is greater than the number of SRF values in the project

Returns:

A list of pile forepole node results wrappers for the requested stage and SRF value.

Return type:

list[PileNodeResults]

getPileForepoleElementResults(entityName: str | None = None, region: Cube | Cylinder | Sphere | None = None, includeIntersecting: bool = True) → list[PileForepoleElementResults]#

Query pile forepole element results at a specific stage and SRF value. :param entityName: Optional[str]: If provided, only elements belonging to the specified entity are queried. :param region: Optional[Union[Cube, Cylinder, Sphere]]: Sample region filter. When None, the field is not set in the request (proto3 unset), and the service returns all elements. :param includeIntersecting: bool: If True, elements that intersect the sample region are included. When False, only elements fully contained are included. Ignored when region is None.

Raises:

Exception if –

  • stageNumber is less than 1 - stageNumber is greater than the number of stages in the project - _srfResultIndex is less than 0 - _srfResultIndex is greater than the number of SRF values in the project

Returns:

A list of pile forepole element results wrappers for the requested stage and SRF value.

Return type:

list[PileForepoleElementResults]