SolarSystem Object

The SolarSystem object allows access to FreeFlyer options relating to planetary constants and default files. The FF_SolarSystem object is a global instance of this base type.

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.

Available In Editions:

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.

Name	Description	Attributes
ApplyUT1Correction	Flag controlling UT1-UTC time correction. Value should be set to 0 or 1. Value of 1 will apply the correction from the timing corrections file (UT1UTC.dat) when computing UTC. Value of 0 corresponds to no corrections applied resulting in UT1=UTC.	Type: Variable Access: Read/Write
CIRFEvaluationMode	Determines whether the CIRF transformation will be computed exactly at each epoch, or interpolated. The interpolated mode should give the best balance of performance and accuracy for most configurations.	Type: Variable Access: Read-Only
ComputePolarMotion	Flag controlling computation of earth's polar motion. Value should be set to 0 or 1. Value of 1 causes polar motion effects to be calculated and added to earth's attitude. Value of 0 causes polar motion effects to be ignored.	Type: Variable Access: Read/Write
COUpdateInterval	Update method applied when reading Celestial Object position and velocity information from the planetary forces file (e.g., DE440). A value of zero will cause the position and velocity to be updated to the full accuracy supplied. This is the instantaneous mode. This mode is recommended. A positive value will cause the position and velocity to be updated to the nearest specified seconds. This is the quantitized mode. This mode may introduce discontinuities in the Celestial Object modeling and is not recommended. A negative value will cause the position and velocity to be updated when the requested reading deviates by more that the absolute value in seconds from the previous update. This is the hysteresis mode. This mode may introduce discontinuities in the Celestial Object modeling and is not recommended.	Type: Variable Access: Read/Write Units: s
DeclaredName	The name of the object as declared.	Type: String Access: Read-Only
DefaultAtmosphereModelFile	File name for earth's Atmosphereric Model data.	Type: String Access: Read/Write
DefaultDaylightSavingsTimeFile	File name that provides formulaic values so that FreeFlyer can internally calculate the DST epochs for a given year.	Type: String Access: Read/Write
DefaultDEXXXFile	File name for Planetary model data.	Type: String Access: Read/Write
DefaultEarthOrientationParametersFile	File name Earth Orientation Parameter data.	Type: String Access: Read/Write
DefaultElectronDensityFile	File name for earth's Atmospheric Electron Density model data.	Type: String Access: Read/Write
DefaultGeopotentialFile	File name for earth's Geopotential model data. This property can be overridden for individual Spacecraft using the ForceModel.PlanetoPotentialFilename string array. The potential file used for each celestial body contains values for the physical properties of the body (Gravity Constant (mu), Body Radius, Reciprocal Flattening). These values are used when propagating the Spacecraft any time a potential file is used. For other calculations that depend on the physical properties of a celestial body, such as Spacecraft.Height or propagation of a Spacecraft with a point mass gravitational model, the celestial body physical properties are accessed using syntax such as "Earth.Mu".	Type: String Access: Read/Write
DefaultHPDragFile	File name for Harris-Priester drag model data.	Type: String Access: Read/Write
DefaultMagneticFieldFile	File name for earth's Magnetic model data.	Type: String Access: Read/Write
DefaultSGFFile	File name for the station geodetics data.	Type: String Access: Read/Write
DefaultSolidTideModelFile	File name for earth's Solid Tide model data.	Type: String Access: Read/Write
DefaultStarFieldFile	File name for the star data.	Type: String Access: Read/Write
EarthOrientationModel	Specifies the Earth orientation model to use to define the transformation from inertial to earth-fixed coordinates and vice versa.	Type: Variable Access: Read-Only
IonosphereOptions	The object that controls the Ionosphere is modeled.	Type: IonosphereOptions Access: Read-Only
ModelCelestialPoleOffsets	Determines whether celestial pole offsets are applied when coverting to/from ICRF-to-CIRF or ICRF-to-TEME.	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
SGP4LibraryLicensePath	Path to the license file for the AstroStds library containing an implementation of the SGP4 algorithm. If this is left blank, then the system will look in the path of the library files for the license.	Type: String Access: Read/Write
SGP4LibraryPath	Path to the libraries that contain the implementation of the SGP4 algorithm to use. If this path is not set, it uses the default installed version. Once set, the value of this path cannot be changed.	Type: String Access: Read/Write

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

Attributes

DefaultUTCTAIConversionFile

File name for TAI to UTC conversion data.

This property has been Deprecated. This property no longer has any effect. UTC-TAI conversion data is now included in the same file that contains UTC-UT1 conversion data (SolarSystem.DefaultEarthOrientationParametersFile).

Type: String

Access: Read/Write

DefaultUTCUT1ConversionFile

File name for UT1 correction data.

This property has been Deprecated. Please use DefaultEarthOrientationParametersFile instead.

Type: String

Access: Read/Write

NoradKeplerEqTolerance

Controls the tolerance used in solving Kepler's equation in the Norad propagator. 1e-12 is the value suggested in Spacetrack Report #6, and 1e-6 is the value suggested in Spacetrack Report #3.

This property has been Deprecated. This property no longer has any effect.

Type: Variable

Access: Read/Write

NPUpdateInterval

Method applied when updating Earth's nutation and precession.

A positive value will cause the nutation and precession to be updated to the nearest specified seconds. This is the quantitized mode.

A value of zero will cause the nutation and precession to be updated to the full accuracy supplied. This is the instantaneous mode.

This property has been Deprecated. This property no longer has any effect. Please Use SolarSystem.CIRFEvaluationMode to balance performance vs. accuracy.

Type: Variable

Access: Read/Write

Units: s