ResultInfo

class cee.cug.ResultInfo()

Information about a given result

Accessors

cee.cug.ResultInfo.id()
get id(): number

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

Returns: number

cee.cug.ResultInfo.idString()
get 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.

Returns: string

cee.cug.ResultInfo.mapping()
get mapping(): ResultMapping

Result position (mapping) of the result

Returns: ResultMapping

cee.cug.ResultInfo.maximumValue()
get maximumValue(): number

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

Returns: number

cee.cug.ResultInfo.minimumValue()
get minimumValue(): number

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

Returns: number

cee.cug.ResultInfo.name()
get name(): string

The name of the result.

Returns: string

cee.cug.ResultInfo.resultType()
get resultType(): ResultType

The type of result (scalar, vector, displacement)

Returns: ResultType

cee.cug.ResultInfo.unit()
get unit(): string

The unit of the results (if available).

Returns: string