Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ResultInfo

Information about a given result

Hierarchy

  • ResultInfo

Index

Accessors

Readonly id

id: number

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

Readonly idString

idString: string

The persistent string id of the result.

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

Readonly mapping

mapping: ResultMapping

Result position (mapping) of the result

Readonly maximumValue

maximumValue: number

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

Readonly minimumValue

minimumValue: number

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

Readonly name

name: string

The name of the result.

Readonly resultType

resultType: ResultType

The type of result (scalar, vector, displacement)

Readonly unit

unit: string

The unit of the results (if available).

Generated using TypeDoc