ResultInfo

class cee.ug.ResultInfo()

Information about a result, including its id and name.

Properties

cee.ug.ResultInfo.baseResultId

readonly

baseResultId: number

If the result is derived from a base result (e.g. tensor), baseResultId describes the id of the origin result.

cee.ug.ResultInfo.baseResultType

readonly

baseResultType: ResultType

If the result is derived from a base result (e.g. tensor), baseResultType describes the type of the origin result.

cee.ug.ResultInfo.deriveOperation

readonly

deriveOperation: DeriveOperation

If the result is derived from a base result (e.g. tensor), deriveOperation describes how the result was derived from the base result.

cee.ug.ResultInfo.id

readonly

id: number

The id of the result.

cee.ug.ResultInfo.idString

readonly

idString: string

The persistent string id of the result.

This is a persistent ID of the result that will not change between versions of EnvisionWeb, and can thus be used to store setting regarding results. The id of the result might change in future versions of EnvisionWeb, and is only guaranteed to be constant in a given version.

Use the ModelDirectory.getResultInfoByIdString method to find result infos based on the idString.

cee.ug.ResultInfo.mapping

readonly

mapping: ResultMapping

Result position (mapping) of the result

cee.ug.ResultInfo.name

readonly

name: string

The name of the result.

cee.ug.ResultInfo.resultCalculatorId

readonly

resultCalculatorId: string

If non empty, the ID of the result calculator producing this result

cee.ug.ResultInfo.resultType

readonly

resultType: ResultType

The result type (scalar, vector, displacement)

cee.ug.ResultInfo.unit

readonly

unit: string

The unit of the results (if available).