Click or drag to resize

EarthCentralBody Class

The planet Earth. You should generally obtain an instance of this class from the CentralBodiesFacet instance in the calculation context instead of creating one directly.
Inheritance Hierarchy

Namespace:  AGI.Foundation.Celestial
Assembly:  AGI.Foundation.Models (in AGI.Foundation.Models.dll) Version: 19.5.402.0 (19.5.402.0)
Syntax
public class EarthCentralBody : CentralBody

The EarthCentralBody type exposes the following members.

Constructors
  NameDescription
Public methodEarthCentralBody
Initializes a new instance.
Protected methodEarthCentralBody(EarthCentralBody, CopyContext)
Initializes a new instance as a copy of an existing instance.
Top
Properties
  NameDescription
Public propertyCenterOfMassPoint
Gets or sets a point describing the center of mass of this central body.
(Overrides CentralBodyCenterOfMassPoint.)
Public propertyEquationOfEquinoxes
Gets or sets the default model for the equation of the equinoxes which defines the right ascension of the mean equinox with respect to the true equator and equinox. By default, this uses the UpdatedEquationOfEquinoxes.
Public propertyFixedFrame
Gets or sets the default Fixed frame that corresponds to the surface features of this central body.
(Overrides CentralBodyFixedFrame.)
Public propertyInertialFrame
Gets or sets the default Inertial frame for this central body.
(Overrides CentralBodyInertialFrame.)
Public propertyInternationalCelestialReferenceFrame
Gets or sets the International Celestial Reference Frame.
Public propertyIsFrozen
Gets a value indicating whether this object is frozen. A frozen object cannot be modified and an ObjectFrozenException will be thrown if an attempt is made to do so.
(Inherited from DefinitionalObject.)
Public propertyIsThreadSafe
Gets a value indicating whether the methods on this instance are safe to call from multiple threads simultaneously.
(Inherited from CentralBody.)
Public propertyJ2000Frame
Gets or sets the J2000 Reference Frame.
Public propertyMeanEclipticMeanEquinoxFrame
Gets or sets the Mean Ecliptic Mean Equinox Reference Frame.
Public propertyMeanEclipticTrueEquinoxFrame
Gets or sets the Mean Ecliptic True Equinox Reference Frame.
Public propertyMeanEquatorMeanEquinoxFrame
Gets or sets the Mean Equator Mean Equinox Reference Frame, also known as the "Mean of Date" reference frame.
Public propertyCode exampleMeanSeaLevel
Gets or sets the default mean sea level surface.
Public propertyName
Gets or sets the name of the central body.
(Overrides CentralBodyName.)
Public propertyNutationModel
Gets or sets the default nutation model used in the FK5 transformation from J2000 to the Fixed frame. By default, this is Updated1980NutationModel.
Public propertyOrientationParameters
Gets or sets the default EarthOrientationParameters.
Public propertyPrecessionModel
Gets or sets the default precession model used in the FK5 transformation from J2000 to the Fixed frame.
Public propertyPrincipalFrame
Gets or sets the default Fixed frame that corresponds to the gravity frame of this central body.
(Overrides CentralBodyPrincipalFrame.)
Public propertyPseudoFixedFrame
Gets or sets the pseudo-fixed reference frame. The pseudo-fixed frame does not include the effect of pole wander. Note that this does include the s-prime correction from the International Celestial Reference System. So the only difference between the pseudo-fixed frame and the fixed frame is the 'x' and 'y' offset terms from pole wander computed by the EarthOrientationParameters (EOP). If the EOP data is default (zeros), the pseudo-fixed frame will be the same as the FixedFrame.
Public propertyShape
Gets or sets the shape of this central body.
(Overrides CentralBodyShape.)
Public propertySlowChangingAxesUpdateInterval
Gets or sets the interval, in seconds, on which to recalculate slow-changing relationships between axes.
Public propertyTrueEquatorMeanEquinoxFrame
Gets or sets the True Equator, Mean Equinox (TEME) Reference Frame.
Public propertyTrueEquatorTrueEquinoxFrame
Gets or sets the True Equator True Equinox Reference Frame, also known as the "True of Date" reference frame.
Top
Methods
  NameDescription
Protected methodCheckForSameDefinition(CentralBody)
Checks to determine if another instance has the same definition as this instance and returns if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
(Overrides CentralBodyCheckForSameDefinition(CentralBody).)
Protected methodCheckForSameDefinition(DefinitionalObject)
Checks to determine if another instance has the same definition as this instance and returns if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
(Inherited from CentralBody.)
Protected methodCheckForSameDefinition(EarthCentralBody)
Checks to determine if another instance has the same definition as this instance and returns if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
Public methodClone
Clones this object using the specified context.
(Overrides DefinitionalObjectClone(CopyContext).)
Protected methodComputeCurrentDefinitionHashCode
Computes a hash code based on the current properties of this object. Derived classes MUST override this method and compute a hash code that combines: a unique hash code seed, the base implementation result, and the hash codes of all new fields introduced by the derived class which are used in the CheckForSameDefinition(DefinitionalObject) method.
(Overrides CentralBodyComputeCurrentDefinitionHashCode.)
Public methodEnumerateDependencies
Enumerates the dependencies of this object by calling EnumerateT(T) for each object that this object directly depends upon. Derived classes which contain additional dependencies MUST override this method, call the base implementation, and enumerate dependencies introduced by the derived class.
(Overrides DefinitionalObjectEnumerateDependencies(DependencyEnumerator).)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFreeze
Freezes this object. Further attempts to modify it will result in an ObjectFrozenException.
(Inherited from DefinitionalObject.)
Protected methodFreezeAggregatedObjects
Called by Freeze to also freeze any objects that are considered to be a part of this object. Derived classes which contain additional aggregated objects MUST override this method, call the base implementation, and freeze aggregated objects introduced by the derived class. The objects that need to be frozen in this method are frequently created in this object's constructor and are not settable via properties.
(Inherited from DefinitionalObject.)
Public methodGetAzimuthElevationRangeEvaluator(VectorDisplacement)
Gets an evaluator to find the azimuth, elevation, and range of a displacement vector as observed from the initial point.
(Inherited from CentralBody.)
Public methodGetAzimuthElevationRangeEvaluator(Vector, Point)
Gets an evaluator to find the azimuth, elevation, and range of a vector as observed from a given point.
(Inherited from CentralBody.)
Public methodGetAzimuthElevationRangeEvaluator(VectorDisplacement, EvaluatorGroup)
Gets an evaluator to find the azimuth, elevation, and range of a displacement vector as observed from the initial point, and associates the evaluator with the specified evaluator group.
(Inherited from CentralBody.)
Public methodGetAzimuthElevationRangeEvaluator(Vector, Point, EvaluatorGroup)
Gets an evaluator to find the azimuth, elevation, and range of a vector as observed from a given point, and associates the evaluator with the specified evaluator group.
(Inherited from CentralBody.)
Public methodGetDefinitionHashCode
Gets a hash code representing the definition of this object.
(Inherited from DefinitionalObject.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetService
Gets the service object of the specified type.
(Inherited from CentralBody.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsSameDefinition
Determines if this object has the same definition as another object.
(Inherited from DefinitionalObject.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodObserveCartographicPoint(Point)
Gets an evaluator that can be used to find the Cartographic motion of a point relative to this central body.
(Inherited from CentralBody.)
Public methodObserveCartographicPoint(Point, EvaluatorGroup)
Gets an evaluator that can be used to find the Cartographic motion of a point relative to this central body.
(Inherited from CentralBody.)
Public methodSynchronizeOrigins (Overrides CentralBodySynchronizeOrigins.)
Protected methodThrowIfFrozen
Throws ObjectFrozenException if this object IsFrozen. This method should be called from any method or property that modifies this object.
(Inherited from DefinitionalObject.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks
See EarthCentralBody for a description of the default instance of this class that is found in the CalculationContext.
Examples
This example shows how to obtain the Earth from the calculation context:
C#
EarthCentralBody earth = CentralBodiesFacet.GetFromContext().Earth;
See Also