rs2.interpreter.InterpreterModel module

class rs2.interpreter.InterpreterModel.Model(client, ID)

Bases: BaseModel

Model Script Examples

saveCopyAs(fileName: str)

Saves the model using the given file name.

Examples

model.saveCopyAs('C:/simple_3_stage.fez')

SetActiveStage(stageNumber: int)

Material Query Script Examples

Change model’s active stage by its stage number

SetResultType(resultType: ExportResultType) → list[dict]

Mesh Script Examples

Sets the export result type for your model.

Raises:

ValueError – resultType must be an enum of type ExportResultType. Any other value will raise an error

SetUserDefinedResultType(resultName: str) → list[dict]

Sets the export result type to the user defined result type name.

GetMeshResults() → MeshResults

Mesh Script Examples

Returns the mesh results at all nodes for your model.

GetHistoryQueryResults(hq_name: str, horizontal_axis: HorizontalAxisTypes, vertical_axis: VerticalAxisTypes, stages: list[int]) → dict[int, list[HistoryQueryResult]]

History Query Script Examples

Returns a map of HistoryQueryResult for all input stages and history queries in your model.

Raises:

ValueError – horizontal_axis and vertical_axis must be an enum of type HistoryQueryGraphEnums. Any other value will raise an error.

GetAllTimeQueryPointResults(stages: list[int], vertical_axis: VerticalAxisTypes) → dict[int, list[TimeQueryPointResults]]

Time Query Script Examples

Returns a map of TimeQueryPointResults for all input stages and time query points in your model.

Please note points that are over an excavation at specific stages will not have data returned at those locations.

Raises:

ValueError – vertical_axis must be an enum of type TimeQueryGraphEnums. Any other value will raise an error.

GetAllTimeQueryLinesResults(stages: list[int], vertical_axis: VerticalAxisTypes, apply_post_process_scaling: bool) → dict[int, list[TimeQueryLineResults]]

Time Query Script Examples

Returns a map of TimeQueryLineResults for all input stages and time query lines in your model.

Please note points that are over an excavation at specific stages will not have data returned at those locations.

Raises:

ValueError – vertical_axis must be an enum of type TimeQueryGraphEnums. Any other value will raise an error.

AddMaterialQuery(points: list[list[float]]) → str

Material Query Script Examples

Adds a material query point/line to your model using the specified coordinates in order.

Returns a unique identifier for the newly added material query point/line.

RemoveMaterialQuery(IDs_toRemove: list[str]) → str

Material Query Script Examples

Removes material query points or lines for provided list of IDs.

GetMaterialQueryResults() → list[MaterialQueryResults]

Material Query Script Examples

Returns the results for all the material queries defined in your model for active model stage and result type.

To get results for a different stage, please call SetActiveStage(int stageNumber) before calling this function.

To get results for a different result type, please call either before calling this function:

• SetResultType(InterpreterGraphEnums resultType)

• SetUserDefinedResultType(“Your defined resultType name”)

GetBoltResults(stages: list[int]) → dict[int, list[BoltResult]]

Bolt Result Script Examples

Returns a map of BoltResult for all input stages and support bolt defined in your model.

GetJointResults(stages: list[int]) → dict[int, list[JointResult]]

Joint Result Script Examples

Returns a map of JointResult for all input stages and support joint defined in your model.

GetLinerResults(stages: list[int]) → dict[int, list[LinerResult]]

Liner Result Script Examples

Returns a map of LinerResult for all input stages and support liner defined in your model.

GetPileResults(stages: list[int]) → dict[int, list[PileResult]]

Pile Result Script Examples

Returns a map of PileResult for all input stages and support pile defined in your model.

GetCompositeResults(stages: list[int]) → dict[int, list[CompositeResult]]

Composite Result Script Examples

Returns a map of CompositeResult for all input stages and support composite defined in your model.

GetStructuralResults(stages: list[int]) → dict[int, list[StructuralResult]]

Structural Interface Script Examples

Returns a map of StructuralResult for all input stages and support structural defined in your model.

getCriticalSRF()

Get Critical SRF