Helices#

class Helices(model_id: str, pile_type_id: str, client: Client)#

Bases: object

Examples: Code Snippet: Manipulation of Pile Types (Helical)

setHelicesBySpacing(depthOfFirstHelixFromPileHead: float, first_helix: tuple[float, float], subsequent_helices: list[tuple[float, float, float]])#

Sets helices properties based on provided specifications.

Parameters:
  • depthOfFirstHelixFromPileHead (float) – Depth of the first helix below the pile head.

  • first_helix (tuple) – A tuple for the first helix, where: - First element (float): Diameter of the first helix. - Second element (float): Pitch of the first helix.

  • subsequent_helices (list of tuples) – A list of tuples for the remaining helices, where: - First element (float): Diameter of the helix. - Second element (float): Pitch of the helix. - Third element (float): Spacing between helices.

getHelicesBySpacing() tuple[float, list[tuple[float, float, float]]]#

returns the depth of the first helix below the pile head. followed and a list of tuples, each tuple containing a helix’s diameter, pitch and spacing

setHelicesByDepth(helices: list[tuple[float, float, float]])#

helices: list of tuples, each tuple containing a helix’s diameter, pitch and depth from pile head

getHelicesByDepth() list[tuple[float, float, float]]#

returns a list of tuples, each tuple containing a helix’s diameter, pitch and depth from pile head

getHeightReductionFactor() float#
setHeightReductionFactor(heightReductionFactor: float)#