InterpretData#

class InterpretData(model_id: str, client: Client)#

Bases: object

Examples: Code Snippet: Interpret Data

Interpret Data menu: analysis methods, surface filter, all surfaces, raw export, SF along slope, support force.

listStages() → list[Stage]#

getActiveStage() → int#

setActiveStage(stage: int) → None#

listAnalysisMethods() → list[AnalysisMethod]#

getActiveAnalysisMethod() → AnalysisMethod#

setActiveAnalysisMethod(methodIndex: int) → None#

getSurfaceFilter() → SurfaceFilter#

setSurfaceFilter(surfaceFilter: SurfaceFilter) → None#

getAllSurfaces(stage: int | None = None) → list[SlipSurfaceRecord]#

Returns slip surfaces for the active analysis method that pass the current surface filter.

Fetches one surface per RPC (same pattern as support diagrams) to avoid oversized responses.

copyRawExportToClipboard(options: RawExportOptions | None = None, stage: int = 0) → None#: Build raw export text in Interpret and copy it to the system clipboard. Avoids returning large payloads over gRPC.

exportRawExportToFile(filePath: str, options: RawExportOptions | None = None, stage: int = 0) → None#: Build raw export text in Interpret and write it to filePath. Avoids returning large payloads over gRPC.

getAllSurfacesVisible() → bool#

setAllSurfacesVisible(visible: bool) → None#

getSfAlongSlope(stage: int = 0, includeLeftSlopeIntercept: bool = True, includeRightSlopeIntercept: bool = True, filterType: FilterDataType = FilterDataType.MINIMUM_IN_EACH_BIN, numberOfBins: int = 20) → SfAlongSlopeResult#: Return Graph SF Along Slope points for the active analysis method (one series).

getSupportForceData(stage: int = 0) → SupportForceData#: Return Support Force Diagram rows for all supports. Internally lists supports and fetches one support per RPC, then combines the results.

getSfWithTime(methodFlags: list[int] | None = None) → SfWithTimeResult#: Return Graph SF with Time series for the requested analysis methods (or all when methodFlags is None).

getLambdaFsData(stage: int = 0) → LambdaFsData#: Return Graph Lambda vs FS points for all surfaces. Internally lists surfaces and fetches one surface per RPC, then combines force and moment series.

getScenarioGraphData(stage: int = 0, scenarioNames: list[str] | None = None, dataType: ScenarioGraphDataType = ScenarioGraphDataType.NAME, material: str | int | None = None, probabilityOfFailure: bool = False) → ScenarioGraphResult#

Return Graph Scenarios series for the requested scenarios and data type.

scenarioNames: bare scenario names or “Model - Scenario” labels (None/empty = all). material: material name (str) or 0-based index (int); required for spatial correlation types.

getSupportPressureData(stage: int = 0) → SupportPressureData#: Return Support Pressure Diagram rows for all supports. Internally lists supports and fetches one support per RPC, then combines the results.

getSupportTensionData(stage: int = 0) → SupportTensionData#: Return Support Tension Diagram data for all bolts. Internally lists bolts and fetches one bolt per RPC, then combines the results.