Class RelativeValue

Hierarchy

  • RelativePosition<number, Unit>
    • RelativeValue

Constructors

constructor

Properties

referenceObjectType referenceObjectUID referenceValue timestamp

Accessors

accuracy probability

Methods

clone equals setAccuracy

Constructors

constructor

  • Parameters

    • Optional referenceObject: any
    • Optional value: number
    • Optional unit: Unit

    Returns RelativeValue

Properties

referenceObjectType

referenceObjectType: string

referenceObjectUID

referenceObjectUID: string

Reference object UID that this location is relative to

referenceValue

referenceValue: number

timestamp

timestamp: number

Position recording timestamp

Accessors

accuracy

  • get accuracy(): Accuracy<U, any>

  • Position accuracy

    Returns

    Position accuracy

    Returns Accuracy<U, any>

  • set accuracy(value: Accuracy<U, any>): void

  • Parameters

    • value: Accuracy<U, any>

    Returns void

probability

  • get probability(): number

  • Get the position probability

    Returns

    Probability between 0 and 1

    Returns number

  • set probability(value: number): void

  • Parameters

    • value: number

    Returns void

Methods

clone

  • Clone the position

    Returns

    Cloned relative position

    Returns RelativeValue

equals

  • Parameters

    Returns boolean

setAccuracy

  • Set the accuracy of the absolute position

    Returns

    instance

    Parameters

    • accuracy: number | Accuracy<Unit, any>

      Accuracy object or number

    • Optional unit: Unit

      Optional unit

    Returns RelativeValue

Settings

Member Visibility

Theme