rocslope2.Model module

class Model(client: Client, project_id: str = '')

Bases: object

Examples: Code Snippet: Model Manipulation

property project_id: str

getAllJointSets() → list[JointSet]

Examples: Code Snippet: Joint Set

addJointSet(jointSetName: str) → JointSet

deleteJointSet(jointSet: JointSet) → None

save() → None

Examples: Code Snippet: Model Manipulation

saveAs(newLocation: str, createDirectory: bool = True) → None

Examples: Code Snippet: Model Manipulation

close(saveProject: bool) → None

Examples: Code Snippet: Model Manipulation

getSlopeGeometry() → SlopeGeometry

Examples: Code Snippet: Slope Geometry

exportImage(savePath: str) → None

Examples: Code Snippet: Model Manipulation

getProjectSettings() → ProjectSettings

Examples: Code Snippet: Project Settings

getSlopeProperties() → SlopeProperties

Examples: Code Snippet: Slope Properties

compute() → None

Examples: Code Snippet: Model Manipulation

getAllJointProperties() → list[JointProperties]

Examples: Code Snippet: Joint Properties

addJointProperty(joint_properties_name: str) → JointProperties

deleteJointProperties(joint_properties: JointProperties) → None

getImportFromDips() → ImportFromDips

Examples: Code Snippet: Import From Dips

getScaleWedgeBlocks() → ScaleWedgeBlocks

Examples: Code Snippet: Scale Blocks

getScalePlanarBlocks() → ScalePlanarBlocks

Examples: Code Snippet: Scale Blocks

getShotcrete() → Shotcrete

Examples: Code Snippet: Shotcrete

getPressureLoading() → PressureLoading

Examples: Code Snippet: Pressure Loading

getAllBoltPatterns() → list[BoltPattern]

Examples: Code Snippet: Bolt Pattern

addBoltPattern(isIntelligentSupportOptimization: bool = False) → BoltPattern

deleteBoltPattern(boltPattern: BoltPattern) → None

getAllBoltProperties() → list[BoltProperties]

Examples: Code Snippet: Bolt Properties

addBoltProperty(boltName: str) → BoltProperties

deleteBoltProperty(boltProperty: BoltProperties) → None

getAllUserDefinedSupports() → list[UserDefinedSupport]

addUserDefinedSupport(supportName: str) → UserDefinedSupport

deleteUserDefinedSupport(support: UserDefinedSupport) → None

getPointOfForceApplication() → PointOfForceApplication

Examples: Code Snippet: Point of Force Application

getSeismicLoading() → SeismicLoading

Examples: Code Snippet: Seismic Loading

getAllPointLoads() → list[PointLoad]

Examples: Code Snippet: Point Load

addPointLoad() → PointLoad

deletePointLoad(pointLoad: PointLoad) → None

getAllSpotBolts() → list[SpotBolt]

Examples: Code Snippet: Spot Bolt

addSpotBolt(appliedFace: SpotBoltInstallationFace) → SpotBolt

deleteSpotBolt(spotBolt: SpotBolt) → None

getAnalysisResults(*analysis_types: AnalysisResultsType) → AnalysisResults

Returns an AnalysisResults dict keyed by AnalysisResultsType.

If analysis_types are passed, only those result tables are fetched. If none are passed, all enabled analysis types are returned. Each table is a ResultsTable (pandas DataFrame) with Excel-equivalent columns.

Examples: Code Snippet: Analysis Results