rs3.results.Results module

class rs3.results.Results.NodeInformation(grpcNodeInfo)

Bases: object

property nodeID

property location: tuple[float, float, float]

class rs3.results.Results.ElementInformation(grpcElementInfo)

Bases: object

property elementID

property nodeIDs

class rs3.results.Results.PileForepoleElementInformation(grpcPileForepoleElementInfo)

Bases: object

property beamElementID

property interfaceElementID

property nodeIDs

class rs3.results.Results.SRFValue(grpcSRFValue)

Bases: object

property SRF

property MaxTotalDisplacement

property Converged

class rs3.results.Results.Results(client: Client, projectID: str)

Bases: _ProxyObject

Entry point for querying analysis results (nodes, elements, SRF) by stage and SRF value.

Examples

See Beam Result Script Example, Bolt Result Script Example, Solid Result Script Example, Pile Result Script Example, Composite Liner Result Script Example, Joint Result Script Example.

getResultsAvailability(stageNumber: int, srfResultIndex: int = 0)

Read cached results for a specific stage and SRF value. :param stageNumber: int: The analysis stage index (1-based) at which to perform the query. :param srfResultIndex: int: The SRF result index. Defaults to 0 to query SRF-None.

Raises:

Exception if –

• stageNumber is less than 1 - stageNumber is greater than the number of stages in the project - srfResultIndex is less than 1 - srfResultIndex is greater than the number of SRF results in the project

Returns:

True if results are available, False otherwise.

Return type:

bool

queryNodeInfoFromVolume(stageNumber: int) → list[NodeInformation]

Query node information on meshed external solid volumes at a specific stage.

Parameters:

stageNumber (int) – The analysis stage index (1-based) at which to perform the query.

Raises:

Exception if –

• stageNumber is less than 1 - stageNumber is greater than the number of stages in the project

Returns:

A list of node information wrappers for the requested stage.

Return type:

list[NodeInformation]

queryNodeInfoFromBolts(stageNumber: int) → list[NodeInformation]

Query node information on bolts at a specific stage.

Parameters:

stageNumber (int) – The analysis stage index (1-based) at which to perform the query.

Raises:

Exception if –

• stageNumber is less than 1 - stageNumber is greater than the number of stages in the project

Returns:

A list of node information wrappers for the requested stage.

Return type:

list[NodeInformation]

queryNodeInfoFromBeams(stageNumber: int) → list[NodeInformation]

Query node information on beams at a specific stage.

Parameters:

stageNumber (int) – The analysis stage index (1-based) at which to perform the query.

Raises:

Exception if –

• stageNumber is less than 1 - stageNumber is greater than the number of stages in the project

Returns:

A list of node information wrappers for the requested stage.

Return type:

list[NodeInformation]

queryNodeInfoFromPilesForepoles(stageNumber: int) → list[NodeInformation]

Query node information on piles and forepoles at a specific stage.

Parameters:

stageNumber (int) – The analysis stage index (1-based) at which to perform the query.

Raises:

Exception if –

• stageNumber is less than 1 - stageNumber is greater than the number of stages in the project

Returns:

A list of node information wrappers for the requested stage.

Return type:

list[NodeInformation]

queryNodeInfoFromLiners(stageNumber: int) → list[NodeInformation]

Query node information on liners at a specific stage.

Parameters:

stageNumber (int) – The analysis stage index (1-based) at which to perform the query.

Raises:

Exception if –

• stageNumber is less than 1 - stageNumber is greater than the number of stages in the project

Returns:

A list of node information wrappers for the requested stage.

Return type:

list[NodeInformation]

queryNodeInfoFromJoints(stageNumber: int) → list[NodeInformation]

Query node information on joints at a specific stage.

Parameters:

stageNumber (int) – The analysis stage index (1-based) at which to perform the query.

Raises:

Exception if –

• stageNumber is less than 1 - stageNumber is greater than the number of stages in the project

Returns:

A list of node information wrappers for the requested stage.

Return type:

list[NodeInformation]

queryNodeInfoFromCompositeLinerInterfaces(stageNumber: int) → list[NodeInformation]

Query node information on composite liner interfaces at a specific stage.

Parameters:

stageNumber (int) – The analysis stage index (1-based) at which to perform the query.

Raises:

Exception if –

• stageNumber is less than 1 - stageNumber is greater than the number of stages in the project

Returns:

A list of node information wrappers for the requested stage.

Return type:

list[NodeInformation]

queryElementInfoFromVolume(stageNumber: int) → list[ElementInformation]

Query element information on meshed external solid volumes at a specific stage.

Parameters:

stageNumber (int) – The analysis stage index (1-based) at which to perform the query.

Raises:

• Exception if –

• stageNumber is less than 1 –

• stageNumber is greater than the number of stages in the project –

Returns:

A list of element information wrappers for the requested stage.

Return type:

list[ElementInformation]

queryElementInfoFromBolts(stageNumber: int) → list[ElementInformation]

Query element information on bolts at a specific stage.

Parameters:

stageNumber (int) – The analysis stage index (1-based) at which to perform the query.

Raises:

Exception if –

• stageNumber is less than 1 - stageNumber is greater than the number of stages in the project

Returns:

A list of element information wrappers for the requested stage.

Return type:

list[ElementInformation]

queryElementInfoFromBeamsForepolesPiles(stageNumber: int) → list[ElementInformation]

Query element information on beams, forepoles, and piles at a specific stage.

Parameters:

stageNumber (int) – The analysis stage index (1-based) at which to perform the query.

Raises:

Exception if –

• stageNumber is less than 1 - stageNumber is greater than the number of stages in the project

Returns:

A list of element information wrappers for the requested stage.

Return type:

list[ElementInformation]

queryElementInfoFromLiners(stageNumber: int) → list[ElementInformation]

Query element information on liners at a specific stage.

Parameters:

stageNumber (int) – The analysis stage index (1-based) at which to perform the query.

Raises:

Exception if –

• stageNumber is less than 1 - stageNumber is greater than the number of stages in the project

Returns:

A list of element information wrappers for the requested stage.

Return type:

list[ElementInformation]

queryElementInfoFromJoints(stageNumber: int) → list[ElementInformation]

Query element information on joints at a specific stage.

Parameters:

stageNumber (int) – The analysis stage index (1-based) at which to perform the query.

Raises:

Exception if –

• stageNumber is less than 1 - stageNumber is greater than the number of stages in the project

Returns:

A list of element information wrappers for the requested stage.

Return type:

list[ElementInformation]

queryElementInfoFromCompositeLinerInterfaces(stageNumber: int) → list[ElementInformation]

Query element information on composite liner interfaces at a specific stage.

Parameters:

stageNumber (int) – The analysis stage index (1-based) at which to perform the query.

Raises:

Exception if –

• stageNumber is less than 1 - stageNumber is greater than the number of stages in the project

Returns:

A list of element information wrappers for the requested stage.

Return type:

list[ElementInformation]

queryElementInfoFromBeams(stageNumber: int) → list[ElementInformation]

Query element information on beams at a specific stage.

Parameters:

stageNumber (int) – The analysis stage index (1-based) at which to perform the query.

Raises:

Exception if –

• stageNumber is less than 1 - stageNumber is greater than the number of stages in the project

Returns:

A list of element information wrappers for the requested stage.

Return type:

list[ElementInformation]

queryElementInfoFromPilesForepoles(stageNumber: int) → list[PileForepoleElementInformation]

Query element information on piles and forepoles at a specific stage.

Parameters:

stageNumber (int) – The analysis stage index (1-based) at which to perform the query.

Raises:

Exception if –

• stageNumber is less than 1 - stageNumber is greater than the number of stages in the project

Returns:

A list of pile forepole element information wrappers for the requested stage.

Return type:

list[PileForepoleElementInformation]

querySRFValues() → list[SRFValue]

Query SRF values at a specific stage.

getMeshResults(srfResultIndex: int = 0, stageNumber: list[int] = [1], requiredDataTypes: set[SolidsDataType] | None = None) → list[SolidResults]

Get the mesh results for specific stages and SRF value. :param srfResultIndex: int: The SRF result index. Defaults to 0 to query SRF-None. :param stageNumber: list[int]: The stage number list. Defaults to [1]. :param requiredDataTypes: Optional[set[SolidsDataType]]: Optional set of SolidsDataType enum values to check availability for.

If None or empty, all data types are queried.

Raises:

Exception if –

• a selected stageNumber is less than 1 - a selected stageNumber is greater than the number of stages in the project - srfResultIndex is less than 0 - srfResultIndex is greater or equal to the number of SRF results in the project - Results are not available for the specified stage, SRF value, and data types

Returns:

SolidResults objects for the requested stages.

Return type:

list[SolidResults]

getBeamResults(srfResultIndex: int = 0, stageNumber: list[int] = [1]) → list[BeamResults]

Get the beam results for specific stages and SRF value. :param srfResultIndex: int: The SRF result index. Defaults to 0 to query SRF-None. :param stageNumber: list[int]: The stage number list. Defaults to [1].

Raises:

Exception if –

• a selected stageNumber is less than 1 - a selected stageNumber is greater than the number of stages in the project - srfResultIndex is less than 0 - srfResultIndex is greater or equal to the number of SRF results in the project

Returns:

BeamResults objects for the requested stages.

Return type:

list[BeamResults]

getPileForepoleResults(srfResultIndex: int = 0, stageNumber: list[int] = [1]) → list[PileForepoleResults]

Get the pile forepole results for specific stages and SRF value. :param srfResultIndex: int: The SRF result index. Defaults to 0 to query SRF-None. :param stageNumber: list[int]: The stage number list. Defaults to [1].

Raises:

Exception if –

• a selected stageNumber is less than 1 - a selected stageNumber is greater than the number of stages in the project - srfResultIndex is less than 0 - srfResultIndex is greater or equal to the number of SRF results in the project

Returns:

PileForepoleResults objects for the requested stages.

Return type:

list[PileForepoleResults]

getJointResults(stageNumber: list[int] = [1], srfResultIndex: int = 0) → list[JointResults]

Get the joint results for a specific stage and SRF value. :param srfResultIndex: int: The SRF result index. Defaults to 0 to query SRF-None. :param stageNumber: int: The stage number. Defaults to 1.

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 or equal to the number of SRF results in the project

Returns:

A JointResults object.

Return type:

JointResults

getCompositeLinerResults(stageNumber: list[int] = [1], srfResultIndex: int = 0) → list[CompositeLinerResults]

Get the mesh results for a specific stage and SRF value. :param srfResultIndex: int: The SRF result index. Defaults to 0 to query SRF-None. :param stageNumber: int: The stage number. Defaults to 1.

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 or equal to the number of SRF results in the project

Returns:

A CompositeLinerResults object.

Return type:

CompositeLinerResults

getBoltResults(srfResultIndex: int = 0, stageNumber: list[int] = [1]) → list[BoltResults]

Get the bolt results for specific stages and SRF value. :param srfResultIndex: int: The SRF result index. Defaults to 0 to query SRF-None. :param stageNumber: list[int]: The stage number list. Defaults to [1].

Raises:

Exception if –

• a selected stageNumber is less than 1 - a selected stageNumber is greater than the number of stages in the project - srfResultIndex is less than 0 - srfResultIndex is greater or equal to the number of SRF results in the project

Returns:

BoltResults objects for the requested stages.

Return type:

list[BoltResults]