Description
The GroundWaypoints propagator is a GroundVehicle propagator. This motion model updates the GroundVehicle's position to follow a series of waypoints when the GroundVehicle is stepped. Waypoints are specified using epoch, latitude, and longitude. The waypoints can be interpolated using three different modes: step function, rhumb line, or geodesic path. See the GroundVehicles section of the Coverage and Contact Analysis Guide for more information.
Inheritance Hierarchy: ObjectàPropagatoràGroundWaypoints
Available In Editions:
Engineer
Mission
Timing Precision Mode
This page describes functionality in millisecond timing precision mode.
Name
|
Description
|
CurrentIndex
|
The current waypoint index - this is updated automatically via stepping. Note that this is only guaranteed to be the closest point less than or equal to the current epoch when stepping forward or greater than or equal to the current epoch when stepping backward, as the stepping may be between points. Manually setting this with an attached Vehicle will force the Vehicle's state to match the selected waypoint's.
|
DeclaredName
|
The name of the object as declared.
|
InterpolationMethod
|
The interpolation method to be employed while stepping between waypoints.
|
Name
|
The name displayed for this object in output windows such as views, plots, and reports.
|
NumberOfWaypoints
|
Returns the total number of waypoints in the Waypoints.
|
ObjectId
|
The unique identifier for the object.
|
ObjectType
|
The type of the object.
|
StepSize
|
The number of seconds the propagated object is advanced when the Step command is executed.
|
WaypointEpoch
|
An array of waypoint epochs.
|
WaypointLatitude
|
An array of waypoint latitudes.
|
WaypointLongitude
|
An array of waypoint latitudes.
|
|
Name
|
Description
|
AddWaypoint
|
Adds a copy of the provided waypoint to the Waypoints array chronologically based on epoch. Epochs may not appear twice in the same Waypoints arary.
|
AddWaypoints
|
Uses the provided arrays to add waypoints to the Waypoints array chronologically based on epoch. Requires that all three arrays have the same length.
|
ClearSavedStates
|
Clears previous saved states for this object.
|
ClearWaypoints
|
Removes all existing elements from the Waypoints array.
|
GetFromFile
|
Load the object state from the specified FreeFlyer object file.
|
GetFromString
|
Load the object state from the specified string.
|
PutToFile
|
Convert the object state to FreeFlyer object xml and write to a file.
|
PutToString
|
Convert the object state to FreeFlyer object xml and return as a string.
|
ReferenceEquals
|
Returns 1 if the argument refers to the calling object and 0 otherwise.
|
Restore
|
Restore an object's state from a previously saved state.
|
Save
|
Save the object's state so that it can be restored later.
|
|
|
