Description
The RelativeMotionUtilities object type has a number of static properties and methods on it that enable a user to work with relative Spacecraft states in common rendezvous or proximity operations analyses. This object is not creatable in script.
Users cannot create instances of this type of object. However, users can access instances of this object type that have been created indirectly, for example as children of other objects. Users can also access any static properties and methods on this object type.
Inheritance Hierarchy: Object->RelativeMotionUtilities
Available In Editions:
Engineer
Mission
Timing Precision Mode
This page describes functionality in nanosecond timing precision mode.
Click here to see the documentation for this object in millisecond timing precision mode.
Name
|
Description
|
Attributes
|
DeclaredName
|
The name of the object as declared.
|
Type: String
Access: Read-Only
|
DisplayName
|
The name displayed for this object in output windows such as views, plots, and reports.
|
Type: String
Access: Read/Write
|
ObjectId
|
The unique identifier for the object.
|
Type: Variable
Access: Read-Only
|
ObjectType
|
The type of the object.
|
Type: String
Access: Read-Only
|
|
Name
|
Description
|
ClearSavedStates
|
Clears previous saved states for this object.
|
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.
|
|
Name
|
Description
|
ComputeDeltaVHCW
|
Predicts the required delta V vector, in the ICRF and units of km/s, required for a secondary Spacecraft to achieve the desired future relative position using the HCW equations of motion.
|
ComputeStateHCW
|
Predicts the future position and velocity of a secondary Spacecraft by evaluating the HCW equations of motion.
|
ConvertRelativePosition
|
Converts the specified relative position from the inputSystem to the outputSystem in reference to the refSC.
|
ConvertRelativeState
|
Converts the specified relative state from the inputSystem to the outputSystem in reference to the refSC.
|
ConvertRelativeVelocity
|
Converts the specified relative velocity from the inputSystem to the outputSystem in reference to the refSC.
|
|
See also
Working with Relative States Guide
| 