Click or drag to resize

CentralBodySurfaceCurve Class

A curve (or polyline) on the surface of a CentralBody. This class can be used alone or as an ObjectExtension when ICentralBodySurfaceCurveService is required, such as when computing access with a CentralBodySurfaceCurveElevationAngleConstraint.
Inheritance Hierarchy

Namespace:  AGI.Foundation.Platforms
Assembly:  AGI.Foundation.Platforms (in AGI.Foundation.Platforms.dll) Version: 19.5.402.0 (19.5.402.0)
Syntax
public class CentralBodySurfaceCurve : ObjectExtension, 
	ICentralBodySurfaceCurveService

The CentralBodySurfaceCurve type exposes the following members.

Constructors
  NameDescription
Public methodCentralBodySurfaceCurve
Initializes a new instance. SurfaceCurve and CentralBody must be set before this instance is used.
Public methodCentralBodySurfaceCurve(CentralBody, EllipsoidSurfaceCurve)
Initializes a new instance as a surface curve on a specified central body.
Public methodCentralBodySurfaceCurve(CentralBody, IEnumerableCartographic)
Initializes a new instance as a polyline defined by a set of planetodetic cartographic points on a specified central body.
Protected methodCentralBodySurfaceCurve(CentralBodySurfaceCurve, CopyContext)
Initializes a new instance as a copy of an existing instance.
Top
Properties
  NameDescription
Public propertyCentralBody
Gets or sets the central body providing the topology and orientation of the SurfaceCurve, and on which the curve is defined. The Ellipsoid property of the SurfaceCurve is expected to match the Shape of this central body.
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 propertyOwner
Gets the owner of this extension.
(Inherited from ObjectExtension.)
Public propertySurfaceCurve
Gets or sets the definition of the curve on the surface of the central body. The Ellipsoid property of this instance is expected to match the Shape of the CentralBody.
Top
Methods
  NameDescription
Protected methodCheckForSameDefinition(CentralBodySurfaceCurve)
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).
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 ObjectExtension.)
Protected methodCheckForSameDefinition(ObjectExtension)
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 ObjectExtensionCheckForSameDefinition(ObjectExtension).)
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 ObjectExtensionComputeCurrentDefinitionHashCode.)
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 ObjectExtensionEnumerateDependencies(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 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 ObjectExtension.)
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.)
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
See Also