rs3.Restraints module#

class rs3.Restraints.RestraintsBase(client: Client, _projectId: str)#

Bases: object

setAutoRestraints(autoRestraintTypeValue: int) → None#
deleteAllRestraints() → None#
getIsRestraintsSet() → bool#
setResetAllDisplacements(resetDisplacementsAfterStages: bool, stageNames: list[str]) → None#
getIsResetAllDisplacementsAfterStages() → bool#
getResetAllDisplacementsStages() → list[str]#
rs3.Restraints.RestraintsBase2RestraintsRestraintsBase(a: RestraintsBase) → rs3.generatedFiles.RestraintsService_pb2.RestraintsBase#
rs3.Restraints.RestraintsRestraintsBase2RestraintsBase(client: Client, a: rs3.generatedFiles.RestraintsService_pb2.RestraintsBase) → RestraintsBase#
class rs3.Restraints.Restraints(client: Client, projectId: str)#

Bases: RestraintsBase

Examples

See Restraints Script Examples.

setAutoRestraints(autoRestraintType: AutoRestraintsType)#

Automatically restrain the external surfaces in the chosen type.

setResetAllDisplacements(resetDisplacementsAfterStages: bool, stageNames: list[str] = None)#

Reset all calculated displacements to zero after any stage.

Parameters:

  • resetDisplacementsAfterStages (-) – allow to reset displacement after stages.

  • stageNames (-) – the name of stages that will be reset.

Example

>>> model.Restraints.setResetAllDisplacements(True, ["Stage 1", "Stage 5", "Stage 2"])
>>> model.Restraints.setResetAllDisplacements(False)
getResetAllDisplacements() → tuple[bool, list[str]]#