CelestialObject Object

Description

The CelestialObject makes it possible to model custom physical objects (ie, a planet, moon, asteroid, or comet). A CelestialObject's movement can be specified using SPICE Files. Any CelestialObject can be used as a force and be applied to any Spacecraft. See Celestial Objects for more information.

Inheritance Hierarchy: 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
AttitudeModel	The object that contains the attitude advancer for the CelestialObject.	Type: Propagator Access: Read-Only
BodyID	Numerical representation of a celestial body. Allows for the tracking of the celestial body in question by using numbers rather than strings. The following body ID's are assigned to the default Solar System objects: Mercury = 1; Venus = 2; Earth = 3; Mars = 4; Jupiter = 5; Saturn = 6; Uranus = 7; Neptune = 8; Pluto = 9; Moon = 10; Sun = 11. Custom CelestialObjects will have body ID's that change with each run of a Mission Plan.	Type: Variable Access: Read-Only
CentralBody	Gets or sets the name of the CelestialObject that defines the origin of this CelestialObject's position and velocity. The central body can be a built-in solar system body (i.e. Earth, Moon, etc.) or a custom CelestialObject created within the Mission Plan.	Type: String Access: Read/Write
CentralBodyObject	The CelestialObject that defines the origin of this CelestialObject's position and velocity. Use the CelestialObject.CentralBody property to change the central body.	Type: CelestialObject Access: Read-Only
DeclaredName	The name of the object as declared.	Type: String Access: Read-Only
Epoch	Current date for the CelestialObject measured in International Atomic Time (TAI) in the Modified Julian Date format. The returned value has units of days, measured from January 5, 1941 at 12:00:00.000 TAI. When retrieving information about the state of a Celestial Object, the CelestialObject GetPositionAtEpoch, GetVelocityAtEpoch, or GetPosVelAtEpoch methods should be used instead of attempting to access this property.	Type: Variable Access: Read/Write Units: day
Flattening	Physical property defined by the difference of the equatorial radius and polar radius divided by the equatorial radius of the CelestialObject body. This value is used in calculating properties such as Spacecraft.Height. When a Spacecraft is propagated using a gravitational potential field file, the Reciprocal Flattening specified in the file is used for propagation of that Spacecraft. This value is also used with the VisibilityCalculator and VisibilitySegment objects if the VisibilitySegment.CelestialObjectTargetModel and/or VisibilitySegment.CelestialObjectOccultationModel properties are set to "ellipsoid". The Flattening, RadiusPolar, and RadiusEquatorial properties of a CelestialObject are all linked. Setting the Flattening value will update the RadiusPolar value automatically, while setting the RadiusPolar value will automatically update the Flattening value.	Type: Variable Access: Read/Write
Globe	Options for controlling celestial object rendering in a ViewWindow.	Type: GlobeOptions Access: Read/Write
J2	The J2 gravitational coefficient of the CelestialObject. This value is used for propagation of a Spacecraft with a point mass gravitational model using a J2Mean propagator. It is also used for the Brouwer-Lyddane and J2 Brouwer-Lyddane Mean element-set conversions.	Type: Variable Access: Read/Write
J3	The J3 gravitational coefficient of the CelestialObject. This property is used to perform Brouwer-Lyddane Mean element set conversions for Earth orbits.	Type: Variable Access: Read/Write
J4	The J4 gravitational coefficient of the CelestialObject. This property is used to perform Brouwer-Lyddane Mean element set conversions for Earth orbits.	Type: Variable Access: Read/Write
J5	The J5 gravitational coefficient of the CelestialObject. This property is used to perform Brouwer-Lyddane Mean element set conversions for Earth orbits.	Type: Variable Access: Read/Write
Mass	The mass of the CelestialObject.	Type: Variable Access: Read/Write Units: kg
Mu	The gravity constant of the CelestialObject. This value is used for propagation of a Spacecraft with a point mass gravitational model. When a Spacecraft is propagated using a gravitational potential field file, the Mu (Gravity Constant) specified in the file is used for propagation of that Spacecraft. Mu = GM (in km^3/s^2), where: G = 6.67259x10^-20 km^3/(kg*sec^2), M = mass (kg). For custom CelestialObjects, the default Mu value is that of Earth from the DE440 file. For built-in CelestialObjects, the default value is retriefed from the DE file specified by the FF_SolarSystem.DefaultDEXXXFile property.	Type: Variable Access: Read/Write Units: km^3/s^2
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
Propagator	The object that contains the orbit advancer for the CelestialObject.	Type: Propagator Access: Read-Only
RadiusEquatorial	The equatorial radius of the celestial body. This value is used in calculating properties such as Spacecraft.Height or evaluating drag perturbations. The RadiusEquatorial, RadiusPolar, and Flattening properties of a CelestialObject are all linked. Setting the RadiusEquatorial value will update the RadiusPolar value automatically.	Type: Variable Access: Read/Write Units: km
RadiusPolar	The polar radius of the celestial body. The RadiusPolar, Flattening, and RadiusEquatorial properties of a CelestialObject are all linked. Setting the RadiusPolar value will update the Flattening value automatically, while setting the Flattening value will automatically update the RadiusPolar value.	Type: Variable Access: Read/Write Units: km
ReferenceFrameIDs	The various Reference Frame IDs for this CelestialObject.	Type: ReferenceFrameIDs Access: Read/Write
TailLength	The number of historical position points to save and draw in visualizations deriving from the View command. If the View command is "Global" a new point will be added each time the Spacecraft is stepped. Otherwise a new point will be added each time the View command is called. If you use the ViewWindow the tail length set there will override this tail length. Use caution in setting tail lengths longer than 10,000 - 30,000 points. Tail lengths exceeding this range can cause memory problems due to the large amount of relative position data that must be maintained. The maximum tail length that can be used safely depends on the amount of memory in the system and the number of objects managed by the Mission View. The tail length can be overridden for an individual view using ViewWindow.SetObjectTailLength() method.	Type: Variable Access: Read/Write

Name	Description
ClearSavedStates	Clears previous saved states for this object.
FixedPositionOfObject	Returns an Array containing the position of the target object, expressed in the body-fixed coordinate system of the prefix object.
FixedVectorToObject	Returns an Array containing the components of the vector originating at the location of the prefix object and terminating at the location of the argument object, in the body fixed coordinate frame of the prefix object.
FixedVelocityOfObject	Returns an Array containing the velocity of the target object relative to the prefix object, expressed in the body-fixed coordinate system of the prefix object.
GetAngularVelocityAtEpoch	Returns the angular velocity vector referenced to the ICRF.
GetBodyRotationAngle	Returns the angular difference between the true rotation axis reference frame X axis and the pseudo-body fixed reference frame X axis in the true rotation axis reference frame XY plane. When the CelestialObject is Earth, this value is equivalent to Earth Rotation Angle (ERA).
GetBodyRotationAngleInertial	Returns the angular difference between the ICRF X axis and the body fixed reference frame X axis in the ICRF XY plane.
GetCartesianStateAtEpoch	Returns the X, Y, Z, VX, VY and VZ components of the state of the CelestialObject at the specified epoch, referenced from the CentralBody.
GetFromFile	Load the object state from the specified FreeFlyer object file.
GetFromString	Load the object state from the specified string.
GetKeplerianStateAtEpoch	Returns the A, E, I, RAAN, W, TA components of the state of the CelestialObject at the specified epoch, referenced from the CentralBody.
GetOrientationAtEpoch	Returns the attitude quaternion of the CelestialObject, referenced to the ICRF.
GetPositionAtEpoch	Returns the X, Y, Z components of the state of the CelestialObject in the ICRF, referenced from the CentralBody.
GetPosVelAtEpoch	Returns the X, Y, Z, VX, VY, VZ components of the state of the CelestialObject, referenced from the CentralBody.
GetPrimeMeridianApparentSiderealTime	Returns the angular difference between the true equinox of date and the body fixed reference frame X axis in the true rotation axis reference frame XY plane. When the CelestialObject is Earth, this value is equivalent to Greenwich Apparent Sidereal Time (GAST) and also to the Greenwich Hour Angle (GHA) of the true equinox of date.
GetSpinRateAtEpoch	Returns the instantaneous spin rate about the angular velocity vector. Note that a positive spin rate indicates a counter-clockwise rotation as viewed from the z-axis of the ICRF; a negative spin rate indicates a clockwise rotation as viewed from the z-axis of the ICRF, eg. for Venus.
GetVelocityAtEpoch	Returns the VX, VY, VZ components of the state of the CelestialObject, referenced from the CentralBody.
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.
Range	Returns the distance between the calling CelestialObject and the specified target object.
ReferenceEquals	Returns 1 if the argument refers to the calling object and 0 otherwise.
ResetToDefaultPropagator	Resets the CelestialObject's Propagator to the default. For built-in CelestialObjects, this will restore the DE State Advancer. Custom CelestialObjects will have their propagator restored to a TwoBody propagator.
Restore	Restore an object's state from a previously saved state.
Save	Save the object's state so that it can be restored later.
SetCartesianState	Sets the Cartesian state of the CelestialObject, referenced from the CentralBody. This requires that the CelestialObject uses a TwoBody propagator, and will error if other propagators are used.
SetKeplerianState	Sets the Keplerian state of the CelestialObject, referenced from the CentralBody. This requires that the CelestialObject uses a TwoBody propagator, and will error if other propagators are used.
SetOrientation	Sets the orientation of the CelestialObject's body fixed frame referenced from the ICRF.
SetPropagatorType	Sets the propagator type to use to advance the orbit state in time. The existing Propagator is overridden with a new object of the specified type. Valid Propagator Types are TwoBody and SpiceEphemeris. Note that when setting the Propagator Type to be that of TwoBody, the CelestialObject must be given an initial state and epoch.
SetState	Sets the position / velocity the state of the CelestialObject in the ICRF, referenced from the CentralBody.
VectorToObject	Returns an Array containing the components of the vector originating at the location of the prefix object and terminating at the location of the argument object, in the ICRF.

Name

Description

Attributes

AngularVelocity

The angular velocity vector associated with the quaternion attitude system.

This property has been Deprecated. Please use the CelestialObject.GetAngularVelocityAtEpoch, GetOrientationAtEpoch or SetOrientation method instead.

Type: Array

Access: Read/Write

Units: deg/s

AngularVelocityX

The X-component of the angular velocity vector associated with the quaternion attitude system.

This property has been Deprecated. Please use the CelestialObject.GetAngularVelocityAtEpoch, GetOrientationAtEpoch or SetOrientation method instead.