rs3.Model module

class rs3.Model.ModelBase(client: Client, _projectId: str)

Bases: object

save() → None

saveAs(newLocation: str) → None

close(saveProject: bool) → None

saveComputeFile() → None

setActiveStageByName(stageName: str) → None

getActiveStageName() → str

setActiveStage(stageNum: int) → None

getActiveStage() → int

getBoltPropertyByName(boltName: str) → str

getBeamPropertyByName(beamName: str) → str

getLinerPropertyByName(linerName: str) → str

getJointPropertyByName(jointName: str) → str

getLiningCompositionPropertyByName(compositeLinerName: str) → str

getPilePropertyByName(pileName: str) → str

getMaterialPropertyByName(materialName: str) → str

getWaterByLocationPropertyByName(waterSurfaceName: str) → str

getWaterGridPropertyByName(waterGridName: str) → str

getExternalVolumeByName(externalVolumeName: str) → str

getGroupByName(groupName: str) → str

getDiscreteFunctionByName(discreteFunctionName: str) → str

getShearNormalFunctionByName(shearNormalFunctionName: str) → str

getGeneralizedAnisotropicFunctionByName(generalizedAnisotropicFunctionName: str) → str

getCustomHydraulicModelPropertyByName(hydraulicModelName: str) → str

getAllBoltProperties() → list[str]

getAllBeamProperties() → list[str]

getAllLinerProperties() → list[str]

getAllJointProperties() → list[str]

getAllLiningCompositionProperties() → list[str]

getAllPileProperties() → list[str]

getAllMaterialProperties() → list[str]

getAllWaterByLocationProperties() → list[str]

getAllWaterGridProperties() → list[str]

getAllCustomHydraulicModelProperties() → list[str]

getAllExternalVolumes() → list[str]

getAllGroups() → list[str]

getAllBoltPropertiesInUse() → list[str]

getAllBeamPropertiesInUse() → list[str]

getAllLinerPropertiesInUse() → list[str]

getAllJointPropertiesInUse() → list[str]

getAllLiningCompositionPropertiesInUse() → list[str]

getAllPilePropertiesInUse() → list[str]

getAllMaterialPropertiesInUse() → list[str]

getBoltPropertiesInUseByStage(_stageNum: int) → list[str]

getBeamPropertiesInUseByStage(_stageNum: int) → list[str]

getLinerPropertiesInUseByStage(_stageNum: int) → list[str]

getJointPropertiesInUseByStage(_stageNum: int) → list[str]

getLiningCompositionPropertiesInUseByStage(_stageNum: int) → list[str]

getPilePropertiesInUseByStage(_stageNum: int) → list[str]

getMaterialPropertiesInUseByStage(_stageNum: int) → list[str]

createNewBoltProperty(boltName: str) → None

deleteBoltProperty(boltName: str) → None

createNewBeamProperty(beamName: str) → None

deleteBeamProperty(beamName: str) → None

createNewJointProperty(jointName: str) → None

deleteJointProperty(jointName: str) → None

createNewLinerProperty(linerName: str) → None

deleteLinerProperty(linerName: str) → None

createNewLiningCompositionProperty(compositeLinerName: str) → None

deleteLiningCompositionProperty(compositeLinerName: str) → None

createNewPileProperty(pileName: str) → None

deletePileProperty(pileName: str) → None

createNewMaterialProperty(materialName: str) → None

deleteMaterialProperty(materialName: str) → None

createNewWaterByLocationProperty(waterSurfaceName: str) → None

deleteWaterByLocationProperty(waterSurfaceName: str) → None

createNewWaterGridProperty(waterGridName: str) → None

deleteWaterGridProperty(waterGridName: str) → None

createNewGroupProperty(groupName: str) → None

deleteGroupProperty(groupName: str) → None

getDiscreteFunctions() → list[str]

getShearNormalFunctions() → list[str]

getGeneralizedAnisotropicFunctions() → list[str]

createNewDiscreteFunction(discreteFunctionName: str) → None

deleteDiscreteFunction(discreteFunctionName: str) → None

createNewShearNormalFunction(shearNormalFunctionName: str) → None

deleteShearNormalFunction(shearNormalFunctionName: str) → None

createNewGeneralizedAnisotropicFunction(generalizedAnisotropicFunctionName: str) → None

deleteGeneralizedAnisotropicFunction(generalizedAnisotropicFunctionName: str) → None

createNewCustomHydraulicModel(customHydraulicModelFunctionName: str) → None

deleteCustomHydraulicModel(hydraulicModelName: str) → None

rs3.Model.ModelBase2ModelModelBase(a: ModelBase) → rs3.generatedFiles.ModelService_pb2.ModelBase

rs3.Model.ModelModelBase2ModelBase(client: Client, a: rs3.generatedFiles.ModelService_pb2.ModelBase) → ModelBase

class rs3.Model.Model(client: Client, projectId: str)

Bases: ModelBase

Examples

See Model Script Examples.

property results

setActiveStageByName(stageName: str) → None

Set the active stage in the RS3 model by its name.

Parameters:

stageName (str) – The exact name of the stage to activate.

getActiveStageName() → str

Retrieve the name of the currently active stage in the RS3 model.

Returns:

The name of the active stage.

Return type:

str

setActiveStage(stageNum: int) → None

Set the active stage in the RS3 model by its index.

Parameters:

stageNum (int) – The index of the absolute stage or relative stage (if reference stage is set) to activate. Counting starts at 1. (i.e., the first stage is 1, the second is 2, etc.).

getActiveStage() → int

Retrieve the index of the currently active stage in the RS3 model.

Returns:

The index of absolute stage or relative stage (if reference stage is set) is active. Counting starts at 1. (i.e., the first stage is 1, the second is 2, etc.).

Return type:

int

getBoltPropertyByName(boltName) → BoltProperty

getBeamPropertyByName(beamName) → BeamProperty

getLinerPropertyByName(linerName) → LinerProperty

getJointPropertyByName(linerName) → JointProperty

getPilePropertyByName(pileName) → PileProperty

getLiningCompositionPropertyByName(liningCompositionName) → LiningCompositionProperty

getCustomHydraulicModelPropertyByName(customHydraulicModelName) → CustomHydraulicModel

getMaterialPropertyByName(materialName) → MaterialProperty

getWaterByLocationPropertyByName(waterSurfaceName) → WaterByLocationProperty

getWaterGridPropertyByName(waterGridName) → WaterGridProperty

getExternalVolumeByName(externalVolumeName) → ExternalVolume

getGroupByName(groupName) → Group

getDiscreteFunctionByName(discreteFunctionName) → DiscreteFunction

getShearNormalFunctionByName(shearNormalFunctionName) → ShearNormalFunction

getGeneralizedAnisotropicFunctionByName(generalizedAnisotropicFunctionName) → GeneralizedAnisotropicFunction

getAllBoltProperties() → list[BoltProperty]

getAllBeamProperties() → list[BeamProperty]

getAllLinerProperties() → list[LinerProperty]

getAllJointProperties() → list[JointProperty]

getAllLiningCompositionProperties() → list[LiningCompositionProperty]

getAllPileProperties() → list[PileProperty]

getAllMaterialProperties() → list[MaterialProperty]

getAllWaterByLocationProperties() → list[WaterByLocationProperty]

getAllWaterGridProperties() → list[WaterGridProperty]

getAllCustomHydraulicModelProperties() → list[CustomHydraulicModel]

getAllExternalVolumes() → list[ExternalVolume]

getAllGroups() → list[Group]

getAllBoltPropertiesInUse() → list[BoltProperty]

getAllBeamPropertiesInUse() → list[BeamProperty]

getAllLinerPropertiesInUse() → list[LinerProperty]

getAllJointPropertiesInUse() → list[JointProperty]

getAllPilePropertiesInUse() → list[PileProperty]

getAllLiningCompositionPropertiesInUse() → list[LiningCompositionProperty]

getAllMaterialPropertiesInUse() → list[MaterialProperty]

getBoltPropertiesInUseByStage(stageNum: int) → list[BoltProperty]

getBeamPropertiesInUseByStage(stageNum: int) → list[BeamProperty]

getLinerPropertiesInUseByStage(stageNum: int) → list[LinerProperty]

getJointPropertiesInUseByStage(stageNum: int) → list[JointProperty]

getPilePropertiesInUseByStage(stageNum: int) → list[PileProperty]

getLiningCompositionPropertiesInUseByStage(stageNum: int) → list[LiningCompositionProperty]

getMaterialPropertiesInUseByStage(stageNum: int) → list[MaterialProperty]

getDiscreteFunctions() → list[DiscreteFunction]

getShearNormalFunctions() → list[ShearNormalFunction]

getGeneralizedAnisotropicFunctions() → list[GeneralizedAnisotropicFunction]