Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • SampledProperty
    • SampledProperty

Index

Constructors

constructor

  • new SampledProperty(type: number | Packable, derivativeTypes?: Packable[]): SampledProperty
  • Parameters

    • type: number | Packable
    • Optional derivativeTypes: Packable[]

    Returns SampledProperty

Properties

backwardExtrapolationDuration

backwardExtrapolationDuration: number

Gets or sets the amount of time to extrapolate backward before the property becomes undefined. A value of 0 will extrapolate forever.

backwardExtrapolationType

backwardExtrapolationType: ExtrapolationType

Gets or sets the type of extrapolation to perform when a value is requested at a time before any available samples.

Readonly definitionChanged

definitionChanged: Event

Gets the event that is raised whenever the definition of this property changes. The definition is considered to have changed if a call to getValue would return a different result for the same time.

derivativeTypes

derivativeTypes: Packable[]

Gets the derivative types used by this property.

forwardExtrapolationDuration

forwardExtrapolationDuration: number

Gets or sets the amount of time to extrapolate forward before the property becomes undefined. A value of 0 will extrapolate forever.

forwardExtrapolationType

forwardExtrapolationType: ExtrapolationType

Gets or sets the type of extrapolation to perform when a value is requested at a time after any available samples.

interpolationAlgorithm

interpolationAlgorithm: InterpolationAlgorithm

Gets the interpolation algorithm to use when retrieving a value.

interpolationDegree

interpolationDegree: number

Gets the degree of interpolation to perform when retrieving a value.

Readonly isConstant

isConstant: boolean

Gets a value indicating if this property is constant. A property is considered constant if getValue always returns the same result for the current definition.

type

type: any

Gets the type of property.

Methods

addSample

  • addSample(time: JulianDate, value: Packable, derivatives?: Packable[]): void
  • Adds a new sample.

    Parameters

    • time: JulianDate

      The sample time.

    • value: Packable

      The value at the provided time.

    • Optional derivatives: Packable[]

    Returns void

addSamples

  • addSamples(times: JulianDate[], values: Packable[], derivativeValues?: any[][]): void
  • Adds an array of samples.

    Parameters

    • times: JulianDate[]

      An array of JulianDate instances where each index is a sample time.

    • values: Packable[]

      The array of values, where each value corresponds to the provided times index.

    • Optional derivativeValues: any[][]

    Returns void

addSamplesPackedArray

  • addSamplesPackedArray(packedSamples: number[], epoch?: JulianDate): void
  • Adds samples as a single packed array where each new sample is represented as a date, followed by the packed representation of the corresponding value and derivatives.

    Parameters

    • packedSamples: number[]

      The array of packed samples.

    • Optional epoch: JulianDate

    Returns void

equals

  • equals(other?: Property): boolean
  • Compares this property to the provided property and returns true if they are equal, false otherwise.

    Parameters

    • Optional other: Property

    Returns boolean

    true if left and right are equal, false otherwise.

getValue

  • getValue(time: JulianDate, result?: any): any
  • Gets the value of the property at the provided time.

    Parameters

    • time: JulianDate

      The time for which to retrieve the value.

    • Optional result: any

    Returns any

    The modified result parameter or a new instance if the result parameter was not supplied.

removeSample

  • removeSample(time: JulianDate): boolean
  • Removes a sample at the given time, if present.

    Parameters

    • time: JulianDate

      The sample time.

    Returns boolean

    true if a sample at time was removed, false otherwise.

removeSamples

  • removeSamples(time: TimeInterval): void
  • Removes all samples for the given time interval.

    Parameters

    • time: TimeInterval

      The time interval for which to remove all samples.

    Returns void

setInterpolationOptions

  • setInterpolationOptions(options?: { interpolationAlgorithm?: InterpolationAlgorithm; interpolationDegree?: number }): void
  • Sets the algorithm and degree to use when interpolating a value.

    Parameters

    • Optional options: { interpolationAlgorithm?: InterpolationAlgorithm; interpolationDegree?: number }
      • Optional interpolationAlgorithm?: InterpolationAlgorithm
      • Optional interpolationDegree?: number

    Returns void