CentralBody Class

A central body, such as a planet, star, asteroid, libration point, etc.

Inheritance Hierarchy

SystemObject
  AGI.Foundation.InfrastructureDefinitionalObject
    AGI.Foundation.CelestialCentralBody
      More...

Namespace: AGI.Foundation.Celestial
Assembly: AGI.Foundation.Models (in AGI.Foundation.Models.dll) Version: 24.2.419.0 (24.2.419.0)

Syntax

C++

Copy

public abstract class CentralBody : DefinitionalObject, 
	IThreadAware, ICloneWithContext, IServiceProvider, IOrientationAxesService, ILocationPointService, 
	IKinematicStateService

Public MustInherit Class CentralBody
	Inherits DefinitionalObject
	Implements IThreadAware, ICloneWithContext, IServiceProvider, IOrientationAxesService, 
	ILocationPointService, IKinematicStateService

public ref class CentralBody abstract : public DefinitionalObject, 
	IThreadAware, ICloneWithContext, IServiceProvider, IOrientationAxesService, ILocationPointService, 
	IKinematicStateService

[<AbstractClassAttribute>]
type CentralBody =  
    class
        inherit DefinitionalObject
        interface IThreadAware
        interface ICloneWithContext
        interface IServiceProvider
        interface IOrientationAxesService
        interface ILocationPointService
        interface IKinematicStateService
    end

The CentralBody type exposes the following members.

Constructors

	Name	Description
	CentralBody	Initializes a new instance.
	CentralBody(CentralBody, CopyContext)	Initializes a new instance as a copy of an existing instance.

Top

Properties

	Name	Description
	CenterOfMassPoint	Gets or sets a point describing the center of mass of this central body.
	FixedFrame	Gets or sets the default Fixed frame that corresponds to the surface features of this central body.
	InertialFrame	Gets or sets the default Inertial frame for this central body.
	IsFrozen	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.)
	IsThreadSafe	Gets a value indicating whether the methods on this instance are safe to call from multiple threads simultaneously.
	Name	Gets or sets the name of the central body.
	PrincipalFrame	Gets or sets the default Fixed frame that corresponds to the gravity frame of this central body.
	Shape	Gets or sets the shape of this central body.

Top

Methods

	Name	Description
	CheckForSameDefinition(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).
	CheckForSameDefinition(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). (Overrides DefinitionalObjectCheckForSameDefinition(DefinitionalObject).)
	Clone	Clones this object using the specified context. (Inherited from DefinitionalObject.)
	ComputeCurrentDefinitionHashCode	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 DefinitionalObjectComputeCurrentDefinitionHashCode.)
	EnumerateDependencies	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. (Inherited from DefinitionalObject.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	Freeze	Freezes this object. Further attempts to modify it will result in an ObjectFrozenException. (Inherited from DefinitionalObject.)
	FreezeAggregatedObjects	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.)
	GetAzimuthElevationRangeEvaluator(VectorDisplacement)	Gets an evaluator to find the azimuth, elevation, and range of a displacement vector as observed from the initial point.
	GetAzimuthElevationRangeEvaluator(Vector, Point)	Gets an evaluator to find the azimuth, elevation, and range of a vector as observed from a given point.
	GetAzimuthElevationRangeEvaluator(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.
	GetAzimuthElevationRangeEvaluator(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.
	GetDefinitionHashCode	Gets a hash code representing the definition of this object. (Inherited from DefinitionalObject.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetService	Gets the service object of the specified type.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsSameDefinition	Determines if this object has the same definition as another object. (Inherited from DefinitionalObject.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ObserveCartographicPoint(Point)	Gets an evaluator that can be used to find the Cartographic motion of a point relative to this central body.
	ObserveCartographicPoint(Point, EvaluatorGroup)	Gets an evaluator that can be used to find the Cartographic motion of a point relative to this central body.
	SynchronizeOrigins	Remakes the InertialFrame, FixedFrame, and PrincipalFrame so that they have the same origin as the current CenterOfMassPoint.
	ThrowIfFrozen	Throws ObjectFrozenException if this object IsFrozen. This method should be called from any method or property that modifies this object. (Inherited from DefinitionalObject.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Reference

AGI.Foundation.Celestial Namespace

Inheritance Hierarchy