Description
The CelestialSystem makes it possible to set up a collection of Celestial Objects. This provides access to positions and velocities of spacecraft and Celestial Objects relative to the entire system as well as visualization options for the custom system. CelestialSystems can be added to RotatingLibrationPoint objects as primary or secondary systems. See the Rotating Libration Point guide for more information.
Inheritance Hierarchy: Object->CelestialSystem
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
|
Bodies
|
The CelestialObjects currently in the CelestialSystem.
|
Type: Array of CelestialObject
Access: Read-Only
|
DeclaredName
|
The name of the object as declared.
|
Type: String
Access: Read-Only
|
MassRatio
|
The mass ratio of the celestial system. Depending on the value of the RecomputeBarycenter property, the mass ratio will be calculated two different ways:
If RecomputeBarycenter == 1, then the mass ratio is calculated as the ratio of the combined mass of all secondary bodies to the total mass of all bodies in the system.
If RecomputeBarycenter == 0, then the mass ratio is calculated as the ratio of the combined mass of all secondary bodies to the mass of the primary body. FreeFlyer will automatically treat the largest body in the system as the primary body.
|
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
|
RecomputeBarycenter
|
Flag indicating whether the barycenter will be computed using only the primary body in the CelestialSystem, or using all the CelestialObjects in the CelestialSystem. Note that the built-in planets (other than the Earth) represent the positions of their system barycenters. You can create a custom CelestialObject to represent the body center of any planet.
RecomputeBarycenter == 1 means that all the bodies in the system will be used to compute the barycenter of the CelestialSystem.
RecomputeBarycenter == 0 means that the primary body will be used as the system barycenter. FreeFlyer will automatically treat the largest body in the system as the primary body.
|
Type: Variable
Access: Read/Write
|
ReferenceBody
|
The reference body is used as the origin when computing the position and velocity of the CelestialSystem's barycenter using the GetPositionAtEpoch, GetVelocityAtEpoch, and GetPosVelAtEpoch methods. Use the SetReferenceBody method to assign the ReferenceBody.
|
Type: CelestialObject
Access: Read-Only
|
SystemMass
|
The total mass of the celestial system.
|
Type: Variable
Access: Read-Only
Units: kg
|
SystemMu
|
The total Mu of the celestial system.
|
Type: Variable
Access: Read-Only
Units: km^3/s^2
|
|
Name
|
Description
|
AddBody
|
Adds a CelestialObject to the CelestialSystem.
|
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.
|
GetPositionAtEpoch
|
Returns the X, Y, Z components of the state of the CelestialSystem's barycenter in the ICRF, using the ReferenceBody as the origin.
|
GetPositionOfObject
|
Returns an Array containing the position of the argument object in the ICRF, referenced from the barycenter of the CelestialSystem.
|
GetPosVelAtEpoch
|
Returns the X, Y, Z, VX, VY, VZ components of the state of the CelestialSystem's barycenter, using the ReferenceBody as the origin.
|
GetPosVelOfObject
|
Returns an Array containing the position and velocity of the argument object in the ICRF, referenced from the barycenter of the CelestialSystem.
|
GetVelocityAtEpoch
|
Returns the VX, VY, VZ components of the state of the CelestialSystem's barycenter, using the ReferenceBody as the origin.
|
GetVelocityOfObject
|
Returns an Array containing the velocity of the argument object in the ICRF, referenced from the barycenter of the CelestialSystem.
|
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.
|
RemoveBody
|
Removes a CelestialObject from the CelestialSystem.
|
Restore
|
Restore an object's state from a previously saved state.
|
Save
|
Save the object's state so that it can be restored later.
|
SetReferenceBody
|
Sets the CelestialObject to use as the origin when computing the position and velocity of the CelestialSystem's barycenter using the GetPositionAtEpoch, GetVelocityAtEpoch, and GetPosVelAtEpoch methods.
|
|
See also
Rotating-Pulsating Systems Guide
|
