Click or drag to resize

CentralBodySurfaceCurveElevationAngleConstraint Class

An Access constraint that requires that an object be between a span of elevation angles from any or all of the points along a given line on the surface of the central body.
Inheritance Hierarchy

Namespace:  AGI.Foundation.Access.Constraints
Assembly:  AGI.Foundation.Platforms (in AGI.Foundation.Platforms.dll) Version: 19.1.398.0 (19.1.398.0)
Syntax
public class CentralBodySurfaceCurveElevationAngleConstraint : MinimumMaximumAccessConstraint, 
	ILinkConstraint

The CentralBodySurfaceCurveElevationAngleConstraint type exposes the following members.

Constructors
  NameDescription
Public methodCentralBodySurfaceCurveElevationAngleConstraint
Initializes a new instance with default values.
Public methodCentralBodySurfaceCurveElevationAngleConstraint(Double)
Initializes a new instance with the specified minimum value.
Public methodCentralBodySurfaceCurveElevationAngleConstraint(CentralBody, Double)
Initializes a new instance with the specified central body and minimum value.
Public methodCentralBodySurfaceCurveElevationAngleConstraint(CentralBodySurfaceCurveElevationAngleConstraint, CopyContext)
Initializes a new instance as a copy of an existing instance.
Public methodCentralBodySurfaceCurveElevationAngleConstraint(IServiceProvider, LinkRole, Double)
Initializes a new instance with the specified constrained link, constrained link end, and minimum value.
Public methodCentralBodySurfaceCurveElevationAngleConstraint(IServiceProvider, LinkRole, CentralBody, Double)
Initializes a new instance with the specified constrained link, constrained link end, central body, and minimum value.
Top
Properties
  NameDescription
Public propertyAccessToWholeObject
Gets or sets a flag indicating whether to constrain based on any or all points along the line. If true, the constraint will ensure that the elevation constraint is satisfied for all points along the line. If false, the constraint will be satisfied by any point along the line.
Public propertyApplicability
Gets or sets the Access situation in which this constraint applies.
(Inherited from AccessConstraint.)
Public propertyCentralBody
Gets or sets the central body relative to which the elevation is computed.
Public propertyConstrainedLink
Gets or sets the link to which this constraint applies. It is not necessary to set this property when using this constraint with AccessComputation.
Public propertyConstrainedLinkEnd
Gets or sets the end of the link to which this constraint applies. This is the end that is anchored to the line target. It is not necessary to set this property when using this constraint with AccessComputation.
Public propertyDebuggingLogger
Gets or sets a logger to which debugging information will be written.
(Inherited from AccessQuery.)
Public propertyEvaluationOrder
Gets or sets a number indicating the evaluation order of this constraint relative to other constraints. All constraints involved in an AccessComputation or that share a common parent (e.g. AccessQueryAnd or AccessQueryOr) in an AccessQuery are sorted by this value before being evaluated in ascending order, so constraints with a lower evaluation order are evaluated earlier than constraints with a higher evaluation order.
(Inherited from AccessConstraint.)
Public propertyGranularity
Gets or sets the maximum angular distance in radians between sample points along the polyline.
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 propertyIsMaximumEnabled
Gets or sets the flag indicating whether a maximum threshold is used in calculating constraint satisfaction.
(Inherited from MinimumMaximumAccessConstraint.)
Public propertyIsMinimumEnabled
Gets or sets the flag indicating whether a minimum threshold is used in calculating constraint satisfaction.
(Inherited from MinimumMaximumAccessConstraint.)
Public propertyMaximumTolerance
Gets or sets the tolerance associated with the MaximumValue to be used when computing threshold crossings.
(Inherited from MinimumMaximumAccessConstraint.)
Public propertyMaximumValue
Gets or sets the maximum function value that is allowed for this constraint to be satisfied. By default this is PositiveInfinity.
(Inherited from MinimumMaximumAccessConstraint.)
Public propertyMinimumTolerance
Gets or sets the tolerance associated with the MinimumValue to be used when computing threshold crossings.
(Inherited from MinimumMaximumAccessConstraint.)
Public propertyMinimumValue
Gets or sets the minimum function value that is required for this constraint to be satisfied. By default, this is NegativeInfinity.
(Inherited from MinimumMaximumAccessConstraint.)
Public propertySampling
Gets an instance describing how this constraint is to be sampled.
(Inherited from AccessConstraint.)
Top
Methods
  NameDescription
Public methodBuildQueryEvaluator
Builds a query evaluator from this constraint.
(Overrides AccessConstraintBuildQueryEvaluator(ConstraintQueryBuilder, EvaluatorGroup).)
Protected methodCheckForSameDefinition(AccessConstraint)
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 MinimumMaximumAccessConstraint.)
Protected methodCheckForSameDefinition(AccessQuery)
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 AccessConstraint.)
Protected methodCheckForSameDefinition(CentralBodySurfaceCurveElevationAngleConstraint)
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 AccessQuery.)
Protected methodCheckForSameDefinition(MinimumMaximumAccessConstraint)
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 MinimumMaximumAccessConstraintCheckForSameDefinition(MinimumMaximumAccessConstraint).)
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 MinimumMaximumAccessConstraintComputeCurrentDefinitionHashCode.)
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 AccessConstraintEnumerateDependencies(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 AccessConstraint.)
Public methodGetDefinitionHashCode
Gets a hash code representing the definition of this object.
(Inherited from DefinitionalObject.)
Public methodGetEvaluationOrder
Returns EvaluationOrder, indicating the suggested evaluation order of this constraint when it is used as part of an AccessQuery. Queries that hold sub-queries (such as an AccessQueryAnd) generally evaluate their sub-queries in ascending order of this value, so constraints with a lower evaluation order are evaluated earlier than constraints with a higher evaluation order.
(Inherited from AccessConstraint.)
Public methodGetEvaluator
Gets an evaluator that can be used to evaluate this query for a given time or for intervals of time.
(Inherited from AccessQuery.)
Public methodGetEvaluator(IServiceProvider)
Gets an evaluator that can be used to evaluate this query for a given time or for intervals of time.
(Inherited from AccessQuery.)
Public methodGetEvaluator(IServiceProvider, EvaluatorGroup)
Gets an evaluator that can be used to evaluate this query for a given time or for intervals of time.
(Inherited from AccessConstraint.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
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 methodToDisjunctiveNormalForm
Transforms this query to disjunctive normal form (DNF).
(Inherited from AccessConstraint.)
Public methodToString
Returns a string that represents the current object.
(Overrides ObjectToString.)
Top
Remarks

Elevation is the angle between the relative position vector, measured from any given point along the line to the other object, and the plane tangent to the surface of the central body at any given point along the line. Elevation is measured as positive away from the central body.

This constraint requires that the ConstrainedLinkEnd of the ConstrainedLink provide the ICentralBodySurfaceCurveService and that the other end of the link provide the ILocationPointService.

The motion is computed from the PointEvaluator obtained from the ILocationPointService of the non-constrained end of the ConstrainedLink. The calculation uses the ICentralBodySurfaceCurveService to obtain the curve representing the CentralBodySurfaceCurve. Elevation is calculated based on the surface normals on the Ellipsoid.

See Also