CentralBodyObstructionConstraint Class

An Access constraint that requires that the view from one object to another not be obstructed by a central body such as the Earth or another planet. Only the spheroidal shape of the central body is considered. That is, terrain and the mean sea level surface are NOT considered.

Inheritance Hierarchy

SystemObject
  AGI.Foundation.InfrastructureDefinitionalObject
    AGI.Foundation.AccessAccessQuery
      AGI.Foundation.AccessAccessConstraint
        AGI.Foundation.Access.ConstraintsCentralBodyObstructionConstraint

Namespace: AGI.Foundation.Access.Constraints
Assembly: AGI.Foundation.Platforms (in AGI.Foundation.Platforms.dll) Version: 24.2.419.0 (24.2.419.0)

Syntax

C++

Copy

public class CentralBodyObstructionConstraint : AccessConstraint, 
	ILinkConstraint

Public Class CentralBodyObstructionConstraint
	Inherits AccessConstraint
	Implements ILinkConstraint

public ref class CentralBodyObstructionConstraint : public AccessConstraint, 
	ILinkConstraint

type CentralBodyObstructionConstraint =  
    class
        inherit AccessConstraint
        interface ILinkConstraint
    end

The CentralBodyObstructionConstraint type exposes the following members.

Constructors

	Name	Description
	CentralBodyObstructionConstraint	Initializes a new instance with default values.
	CentralBodyObstructionConstraint(CentralBody)	Initializes a new instance with the specified central body.
	CentralBodyObstructionConstraint(CentralBodyObstructionConstraint, CopyContext)	Initializes a new instance as a copy of an existing instance.
	CentralBodyObstructionConstraint(IServiceProvider, CentralBody)	Initializes a new instance with the specified constrained link, constrained link end, and central body.

Top

Properties

	Name	Description
	Applicability	Gets or sets the Access situation in which this constraint applies. (Inherited from AccessConstraint.)
	CentralBody	Gets or sets the central body to consider in this constraint.
	ConstrainedLink	Gets or sets the link to which this constraint applies. It is not necessary to set this property when using this constraint with AccessComputation.
	ConstrainedLinkEnd	Gets or sets the end of the link to which this constraint applies.
	DebuggingLogger	Gets or sets a logger to which debugging information will be written. (Inherited from AccessQuery.)
	EvaluationOrder	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.)
	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.)
	Sampling	Gets an instance describing how this constraint is to be sampled. (Inherited from AccessConstraint.)
	Tolerance	Gets or sets the tolerance on the constraint value to use when computing the time when this constraint crosses its threshold.

Top

Methods

	Name	Description
	BuildQueryEvaluator	Builds a query evaluator from this constraint. (Overrides AccessConstraintBuildQueryEvaluator(ConstraintQueryBuilder, EvaluatorGroup).)
	CheckForSameDefinition(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). (Overrides AccessConstraintCheckForSameDefinition(AccessConstraint).)
	CheckForSameDefinition(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.)
	CheckForSameDefinition(CentralBodyObstructionConstraint)	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). (Inherited from AccessQuery.)
	Clone	Clones this object using the specified context. (Overrides DefinitionalObjectClone(CopyContext).)
	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 AccessConstraintComputeCurrentDefinitionHashCode.)
	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. (Overrides AccessConstraintEnumerateDependencies(DependencyEnumerator).)
	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 AccessConstraint.)
	GetDefinitionHashCode	Gets a hash code representing the definition of this object. (Inherited from DefinitionalObject.)
	GetEvaluationOrder	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.)
	GetEvaluator	Gets an evaluator that can be used to evaluate this query for a given time or for intervals of time. (Inherited from AccessQuery.)
	GetEvaluator(IServiceProvider)	Gets an evaluator that can be used to evaluate this query for a given time or for intervals of time. (Inherited from AccessQuery.)
	GetEvaluator(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.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	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.)
	ThrowIfFrozen	Throws ObjectFrozenException if this object IsFrozen. This method should be called from any method or property that modifies this object. (Inherited from DefinitionalObject.)
	ToDisjunctiveNormalForm	Transforms this query to disjunctive normal form (DNF). (Inherited from AccessConstraint.)
	ToString	Returns a string that represents the current object. (Overrides ObjectToString.)

Top

Remarks

This constraint requires that both ends of the ConstrainedLink provide ILocationPointService.

After obtaining the positions of the two objects in the fixed frame, this constraint uses GetDegreeOfObstruction(Cartesian, Cartesian) to determine whether the central body lies between the two points. When accounting for light-time delay, the constraint will iterate to find the position and orientation of the central body ellipsoid at the time when the photon is at its point of closest approach. This is done with respect to the observer specified when creating the AccessEvaluator, ConstrainedLinkEnd is not used by this constraint.

Reference

AGI.Foundation.Access.Constraints Namespace