Description
This object type contains unique identifiers for CelestialObject-specific frames for use with the PositionConvert, VelocityConvert, and PositionVelocityConvert functions, as well as methods like Spacecraft.SetKeplerianState() and CelestialObject.GetCartesianStateAtEpoch().
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->ReferenceFrameIDs
Parent Object: CelestialObject
Available In Editions:
Engineer
Mission
Timing Precision Mode
This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.
Click here to see the documentation for this object in nanosecond timing precision mode.
Name
|
Description
|
Attributes
|
BodyFixed
|
The unique identifier for the CelestialObject's Body Fixed frame. This is for use with the PositionConvert, VelocityConvert, and PositionVelocityConvert functions, as well as the Get/Set Cartesian/Keplerian State methods on Spacecraft and CelestialObjects.
|
Type: Variable
Access: Read-Only
|
DeclaredName
|
The name of the object as declared.
|
Type: String
Access: Read-Only
|
InertialEquatorialAtEpoch
|
The unique identifier for the CelestialObject's Inertial Equatorial at Epoch frame. This is for use with the PositionConvert, VelocityConvert, and PositionVelocityConvert functions, as well as the Get/Set Cartesian/Keplerian State methods on Spacecraft and CelestialObjects.
|
Type: Variable
Access: Read-Only
|
InertialEquatorialJ2000
|
The unique identifier for the CelestialObject's Inertial Equatorial J2000 frame. This is for use with the PositionConvert, VelocityConvert, and PositionVelocityConvert functions, as well as the Get/Set Cartesian/Keplerian State methods on Spacecraft and CelestialObjects.
|
Type: Variable
Access: Read-Only
|
Name
|
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.
|
|
|
