ResultInfo

class cee.cug.ResultInfo()

Information about a given result

Accessors

• id
• idString
• mapping
• maximumValue
• minimumValue
• name
• resultType
• unit

---

Accessors

ResultInfo.id()

The id of the result. Will be unique within each result type.

Return type:number

ResultInfo.idString()

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.

Return type:string

ResultInfo.mapping()

Result position (mapping) of the result

Return type:ResultMapping

ResultInfo.maximumValue()

The maximum value (length for vectors or displacement) of the result

Return type:number

ResultInfo.minimumValue()

The minimum value (length for vectors or displacement) of the result

Return type:number

ResultInfo.name()

The name of the result.

Return type:string

ResultInfo.resultType()

The type of result (scalar, vector, displacement)

Return type:ResultType

ResultInfo.unit()

The unit of the results (if available).

Return type:string