ResultInfo

class cee.ug.ResultInfo(): Information about a result, including its id and name.

Properties

baseResultId
baseResultType
deriveOperation
id
idString
mapping
name
resultCalculatorId
resultType
unit

Properties

ResultInfo.baseResultId

Type:: number

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

ResultInfo.baseResultType

Type:: ResultType

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

ResultInfo.deriveOperation

Type:: DeriveOperation

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

ResultInfo.id

Type:: number

The id of the result.

ResultInfo.idString

Type:: 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.

ResultInfo.mapping

Type:: ResultMapping

Result position (mapping) of the result

ResultInfo.name

Type:: string

The name of the result.

ResultInfo.resultCalculatorId

Type:: string

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

ResultInfo.resultType

Type:: ResultType

The result type (scalar, vector, displacement)

ResultInfo.unit

Type:: string

The unit of the results (if available).