Click or drag to resize

DynamicMatrixPropagationParameter Class

Represents a DynamicMatrix which in turn represents a particular parameter in the state during integration.
Inheritance Hierarchy

Namespace:  AGI.Foundation.Geometry
Assembly:  AGI.Foundation.Models (in AGI.Foundation.Models.dll) Version: 19.2.399.0 (19.2.399.0)
Syntax
public sealed class DynamicMatrixPropagationParameter : DynamicMatrix

The DynamicMatrixPropagationParameter type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyColumnDimension
Gets or sets the number of columns.
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 propertyRowDimension
Gets or sets the number of rows.
Public propertyStateParameter
Gets or sets a parameter which represents the state during propagation. In general, users should never need to explicitly set this property. It should only be set in cases where elements of a state require additional instances of a NumericalPropagator inside their implementation in order to produce their values. In such cases, it may be necessary to distinguish between the state of the exterior propagator and the state of the interior propagator. In these cases, it is up to the user to ensure that both the state and all of its elements are configured with the same parameter. Otherwise, the state will throw an exception when creating its propagator.
Top
Methods
  NameDescription
Public methodClone
Clones this object using the specified context.
(Overrides DefinitionalObjectClone(CopyContext).)
Public methodStatic memberConfigureIndicesOnEvaluator

This is called by PropagationStateElement instances using DynamicMatrixPropagationParameter so that the element can update the indices used to identify the individual values corresponding to this scalar in the state during evaluation. In general, this should only be called from within the GetConverter(EvaluatorGroup, MotionInt32) method when configuring the indices provided by the NumericalPropagatorDefinition.

The EvaluatorGroup will create an evaluator based on the StateParameter and cache it for future calls. This method updates the instance variables for the indices so that it will reflect the scalar's elements within the state during evaluation. In general, this breaks the "Evaluator Pattern" by altering data on an evaluator after construction. However, so long as it is done once and only once prior to any evaluation this is deemed as following the "Evaluator Pattern" which stipulates that an evaluator should always return the same value for a given time.

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.
(Inherited from DefinitionalObject.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodFreeze
Freezes this object. Further attempts to modify it will result in an ObjectFrozenException.
(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<Matrix> of this instance at a given JulianDate. See GetEvaluator(EvaluatorGroup) for more details.
(Inherited from DynamicMatrix.)
Public methodGetEvaluator(EvaluatorGroup) (Overrides DynamicMatrixGetEvaluator(EvaluatorGroup).)
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.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also