rs3.properties.pile.EndCondition module#
- class rs3.properties.pile.EndCondition.EndConditionBase(client: Client, id: str)#
Bases:
_ProxyObject,IPropertyGroupAccessors- getMagnitude() float#
- setMagnitude(value: float)#
- getX() float#
- setX(value: float)#
- getY() float#
- setY(value: float)#
- getZ() float#
- setZ(value: float)#
- getProperties()#
Retrieve properties as a dictionary.
- setProperties(Magnitude: float = None, X: float = None, Y: float = None, Z: float = None)#
Set properties using keyword arguments.
- class rs3.properties.pile.EndCondition.EndConditionStageFactorBase(id: str, stageFactorID: str, client: Client)#
Bases:
IStageFactorBase- getEndConditionFactor() float#
- class rs3.properties.pile.EndCondition.EndConditionDefinedStageFactorBase(id: str, stageFactorID: str, client: Client)#
Bases:
EndConditionStageFactorBase- setEndConditionFactor(value: float)#
- class rs3.properties.pile.EndCondition.EndConditionStageFactor(id: str, stageFactorId: str, client: Client)#
Bases:
EndConditionStageFactorBaseExamples
See Pile Script Examples.
- class rs3.properties.pile.EndCondition.EndConditionDefinedStageFactor(id: str, stageFactorId: str, client: Client)#
Bases:
EndConditionStageFactor,EndConditionDefinedStageFactorBaseExamples
See Pile Script Examples.
- class rs3.properties.pile.EndCondition.EndCondition(client: Client, id: str)#
Bases:
EndConditionBaseExamples
See Pile Script Examples.
- getEndConditionType() EndConditionType#
When force/displacement function is not enabled, this function returns EndConditionType.NONE. Otherwise, this function returns the defined force/displacement type.
- setEndConditionType(endConditionType: EndConditionType)#
When EndConditionType is not set to be NONE, force displacement function is automatically on when force type is set. If the EndConditionType is set to be NONE, force displacement function is automatically off.
- getApplicationPoint() EndConditionPlacementPoint#
- setApplicationPoint(applicationPoint: EndConditionPlacementPoint)#