Extends
Members
Gets the orbital altitude at apogee in meters.
Gets the wasm position array_index
Gets or sets the amount of time to extrapolate backward
before the property becomes undefined. A value of 0 will extrapolate forever.
- Inherited From:
- Default Value:
0
backwardExtrapolationType : ExtrapolationType
Gets or sets the type of extrapolation to perform when a value
is requested at a time before any available samples.
- Inherited From:
- Default Value:
ExtrapolationType.NONE
readonly 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.
- Inherited From:
Gets the orbital eccentricity.
Gets or sets the amount of time to extrapolate forward before
the property becomes undefined. A value of 0 will extrapolate forever.
- Inherited From:
- Default Value:
0
forwardExtrapolationType : ExtrapolationType
Gets or sets the type of extrapolation to perform when a value
is requested at a time after any available samples.
- Inherited From:
- Default Value:
ExtrapolationType.NONE
readonly interpolationAlgorithm : InterpolationAlgorithm
Gets the interpolation algorithm to use when retrieving a value. Call
setInterpolationOptions to set this.
- Inherited From:
- Default Value:
LinearApproximation
Gets the degree of interpolation to perform when retrieving a value. Call
setInterpolationOptions to set this.
- Inherited From:
- Default Value:
1
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.
- Inherited From:
Gets the current mode.
Gets the available mode enums from the WasmPositionManager.
The number of derivatives contained by this property; i.e. 0 for just position, 1 for velocity, etc.
- Inherited From:
- Default Value:
0
Gets the list of OMMs.
Gets the orbital altitude at perigee in meters.
Gets the orbital period in seconds.
referenceFrame : ReferenceFrame
Gets the reference frame in which the position is defined.
- Inherited From:
- Default Value:
ReferenceFrame.FIXED;
Gets the semi-major axis in meters.
Gets the semi-minor axis in meters.
Methods
Asynchronously sets the orbital state for position propagation.
This method initializes the position propagator with the provided orbital state parameters.
| Name | Type | Description | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
propagationData |
Object |
The object containing the orbital state fields.
|
Returns:
A promise that resolves when the orbital state has been added successfully.
Throws:
-
Error : Throws an error if the required fields are missing or of the wrong type.
Example:
const propagationData = {
position: { x: 7000, y: 8000, z: 9000 }, // Position in m
velocity: { x: 7.12, y: -1.23, z: 4.56 }, // Velocity in m/s
unixEpoch: 1617625600, // Epoch in Unix timestamp format (e.g., 2021-04-05 00:00:00 UTC)
ndot: 0.0001, // Mean motion rate of change
nddot: -0.00005, // Rate of change of the mean motion rate
referenceFrame: 'INERTIAL' // Optional: 'FIXED' (ECEF) or 'INERTIAL' (J2000)
};
await propagatedPositionProperty.addOrbitalState(propagationData);
Adds a new sample.
| Name | Type | Description |
|---|---|---|
time |
JulianDate | The sample time. |
position |
Cartesian3 | The position at the provided time. |
derivatives |
Array.<Cartesian3> | optional The array of derivative values at the provided time. |
- Inherited From:
Adds multiple samples via parallel arrays.
| Name | Type | Description |
|---|---|---|
times |
Array.<JulianDate> | An array of JulianDate instances where each index is a sample time. |
positions |
Array.<Cartesian3> | An array of Cartesian3 position instances, where each value corresponds to the provided time index. |
derivatives |
Array.<Array> | optional An array where each value is another array containing derivatives for the corresponding time index. |
Throws:
-
DeveloperError : All arrays must be the same length.
- Inherited From:
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.
| Name | Type | Description |
|---|---|---|
packedSamples |
Array.<number> | The array of packed samples. |
epoch |
JulianDate | optional If any of the dates in packedSamples are numbers, they are considered an offset from this epoch, in seconds. |
- Inherited From:
Gets the current Orbital Mean-Elements Message (OMM) with updated parameters.
Returns:
The current OMM object with updated orbital parameters:
- ECCENTRICITY: The orbital eccentricity
- SEMI_MAJOR_AXIS: The semi-major axis in kilometers
- SEMI_MINOR_AXIS: The semi-minor axis in kilometers
Compares this property to the provided property and returns
true if they are equal, false otherwise.
| Name | Type | Description |
|---|---|---|
other |
Property | optional The other property. |
Returns:
true if left and right are equal, false otherwise.
- Inherited From:
getValue(time, result) → Cartesian3|undefined
Gets the position at the provided time.
| Name | Type | Default | Description |
|---|---|---|---|
time |
JulianDate |
JulianDate.now()
|
optional The time for which to retrieve the value. If omitted, the current system time is used. |
result |
Cartesian3 | optional The object to store the value into, if omitted, a new instance is created and returned. |
Returns:
The modified result parameter or a new instance if the result parameter was not supplied.
- Inherited From:
getValueInReferenceFrame(time, referenceFrame, result) → Cartesian3|undefined
Gets the position at the provided time and in the provided reference frame.
| Name | Type | Description |
|---|---|---|
time |
JulianDate | The time for which to retrieve the value. |
referenceFrame |
ReferenceFrame | The desired referenceFrame of the result. |
result |
Cartesian3 | optional The object to store the value into, if omitted, a new instance is created and returned. |
Returns:
The modified result parameter or a new instance if the result parameter was not supplied.
- Inherited From:
Lists the OMM epochs as Date objects.
Returns:
An array of Date objects representing the OMM epochs.
Loads an OMM (Orbital Mean Model) into the PropagatedPositionProperty.
| Name | Type | Description |
|---|---|---|
jsonOMM |
object | The OMM object in JSON format. |
Returns:
A promise that resolves when the OMM is loaded.
Gets an OMM by epoch.
| Name | Type | Description |
|---|---|---|
epoch |
string | The epoch key to retrieve the OMM. |
Returns:
The OMM corresponding to the given epoch.
Removes all OMMs from the position
Removes a sample at the given time, if present.
| Name | Type | Description |
|---|---|---|
time |
JulianDate | The sample time. |
Returns:
true if a sample at time was removed, false otherwise.
- Inherited From:
Removes all samples for the given time interval.
| Name | Type | Description |
|---|---|---|
time |
TimeInterval | The time interval for which to remove all samples. |
- Inherited From:
Sets the algorithm and degree to use when interpolating a position.
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
optional
Object with the following properties:
|
- Inherited From: