rs3.properties.pile.MultiLinear module#

class rs3.properties.pile.MultiLinear.MultiLinearStageFactor(id: str, stageFactorID: str, client: Client)#

Bases: PileCommonStageFactor

Examples

See Pile Script Examples.

getMultiLinearFactor() → float#
class rs3.properties.pile.MultiLinear.MultiLinearDefinedStageFactor(id: str, stageFactorID: str, client: Client)#

Bases: PileCommonDefinedStageFactor, MultiLinearStageFactor

Examples

See Pile Script Examples.

setMultiLinearFactor(value: float)#
class rs3.properties.pile.MultiLinear.MultiLinear(client: Client, id: str)#

Bases: PileCommon

Examples

See Pile Script Examples.

getMultiLinearGrid() → list[tuple[float, float]]#

Get a list of multi-linear skin resistance (distance to top, max traction) data points.

Returns:

list[tuple[float, float]] A list of (distance_to_top, max_traction) data points.

  • distance_to_topfloat

    Distance measured from the top of the pile.

  • max_tractionfloat

    Maximum skin resistance (traction) at the corresponding distance.

setMultiLinearGrid(value: list[tuple[float, float]])#

Set a list of multi-linear skin resistance (distance to top, max traction) data points.

Parameters:

value –

list[tuple[float, float]] A list of (distance_to_top, max_traction) data points.

  • distance_to_topfloat

    Distance measured from the top of the pile.

  • max_tractionfloat

    Maximum skin resistance (traction) at that distance.

Example

>>> list = [(1.1, 2.2), (3.3, 4.4), (5.5, 6.6)]
>>> MultiLinearPile.setMultiLinearGrid(list)