Click or drag to resize

VectorApparentDisplacement Class

A vector representing the apparent directed displacement from an initial point to a final point as the points move over time. The apparent displacement accounts for light travel time given the SignalDirection and optionally can account for aberration caused by the motion of the observer's frame.
Inheritance Hierarchy

Namespace:  AGI.Foundation.Geometry
Assembly:  AGI.Foundation.Core (in AGI.Foundation.Core.dll) Version: 19.1.398.0 (19.1.398.0)
Syntax
public class VectorApparentDisplacement : VectorDisplacement

The VectorApparentDisplacement type exposes the following members.

Constructors
  NameDescription
Public methodVectorApparentDisplacement
Initializes a new instance. The user must set InertialFrame, InitialPoint, FinalPoint so that the apparent displacement accounting for light travel time can be modeled. Optionally, the user must set the VelocityOfMovingFrame in order to model the affect of aberration on the apparent displacement. LightTravelTimeConvergenceTolerance is initialized to 5E-5. Direction is initialized to Receive. VelocityOfMovingFrame is uninitialized.
Protected methodVectorApparentDisplacement(VectorApparentDisplacement, CopyContext)
Initializes a new instance as a copy of an existing instance.
Public methodVectorApparentDisplacement(Point, Point, ReferenceFrame)
Initializes a new instance of the VectorApparentDisplacement class which only accounts for light travel time.
Public methodVectorApparentDisplacement(Point, Point, ReferenceFrame, VectorVelocity)
Initializes a new instance of the VectorApparentDisplacement class which accounts for aberration in addition to light travel time.
Public methodVectorApparentDisplacement(Point, Point, ReferenceFrame, SignalDirection, Double)
Initializes a new instance of the VectorApparentDisplacement class which only accounts for light travel time.
Public methodVectorApparentDisplacement(Point, Point, ReferenceFrame, SignalDirection, Double, VectorVelocity)
Initializes a new instance of the VectorApparentDisplacement class which accounts for aberration in addition to light travel time.
Top
Properties
  NameDescription
Public propertyConserveDistanceForAberration
Gets or sets a value indicating whether to only correct for the direction of the vector and not its magnitude when computing the aberration due to relative motion of the observer with respect to the target.
Public propertyDirection
Gets or sets the direction in which the signal travels with respect to the initial point.
Public propertyFinalPoint
Gets or sets the point which defines the ending of the displacement vector.
(Inherited from VectorDisplacement.)
Public propertyInertialFrame
Gets or sets the inertial frame in which the light path is modeled.
Public propertyInitialPoint
Gets or sets the point which defines the beginning of the displacement vector.
(Inherited from VectorDisplacement.)
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 propertyLightTravelTimeConvergenceTolerance
Gets or sets the tolerance required to indicate convergence of the light travel time adjustment.
Public propertyVelocityOfMovingFrame
Gets or sets the velocity of the moving frame in which the affect of aberration is to be determined.
Top
Methods
  NameDescription
Public methodAdd
Add a vector to this one.
(Inherited from Vector.)
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 Vector.)
Protected methodCheckForSameDefinition(Vector)
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 VectorDisplacement.)
Protected methodCheckForSameDefinition(VectorApparentDisplacement)
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(VectorDisplacement)
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 VectorDisplacementCheckForSameDefinition(VectorDisplacement).)
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 VectorDisplacementComputeCurrentDefinitionHashCode.)
Public methodCreateVectorDerivative
Constructs a vector which represents a derivative of this vector.
(Inherited from Vector.)
Public methodCross
Produce the vector cross product between this vector and another one.
(Inherited from Vector.)
Public methodDivide(Double)
Divide this vector by a scale factor.
(Inherited from Vector.)
Public methodDivide(Scalar)
Divide this vector by a scale factor.
(Inherited from Vector.)
Public methodDot
Produce the vector dot product between this vector and another one.
(Inherited from Vector.)
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 VectorDisplacementEnumerateDependencies(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 methodGetEvaluator
Gets an evaluator that can be used to find the Motion<Cartesian> of this vector at a given date with respect to the axes in which it is defined. See GetEvaluator(EvaluatorGroup) for details.
(Inherited from Vector.)
Public methodGetEvaluator(EvaluatorGroup)
Gets an evaluator that can be used to find the relative Motion<Cartesian> between the InitialPoint and FinalPoint in InitialPoint's ReferenceFrame at a given JulianDate.
(Overrides VectorGetEvaluator(EvaluatorGroup).)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetLightTravelTimeEvaluator
Gets an evaluator that evaluates the light travel time between the two points involved in this displacement vector. If the input JulianDate to the evaluator represents the moment of an event at the InitialPoint, the returned Duration is the time until the event will be observed at the FinalPoint.
Public methodGetLightTravelTimeEvaluator(EvaluatorGroup)
Gets an evaluator that evaluates the light travel time between the two points involved in this displacement vector. If the input JulianDate to the evaluator represents the moment of an event at the InitialPoint, the returned Duration is the time until the event will be observed at the FinalPoint.
Public methodGetScalarElement(CartesianElement, Axes)
Returns a Scalar representing the X, Y, Z, or Magnitude of this vector.
(Inherited from Vector.)
Public methodGetScalarElement(CartesianElement, Axes, Int32)
Returns a Scalar representing the X, Y, Z, or Magnitude, or any derivative of those elements of this vector.
(Inherited from Vector.)
Public methodGetService
Gets the service object of the specified type.
(Inherited from Vector.)
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 methodMultiply(Double)
Multiply this vector by a scale factor.
(Inherited from Vector.)
Public methodMultiply(Scalar)
Multiply this vector by a scale factor.
(Inherited from Vector.)
Public methodSubtract
Subtract a vector from this one.
(Inherited from Vector.)
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
Fields
  NameDescription
Public fieldStatic memberDefaultLightTimeConvergenceTolerance
The default tolerance required to indicate convergence of the light travel time adjustment.
Top
See Also