Click or drag to resize

ExtremeValueOfSegmentConstraint Class

This constraint will take the extreme value of a Scalar computed while propagating a SegmentPropagator. No interpolation will be done on the values of the Scalar.
Inheritance Hierarchy

Namespace:  AGI.Foundation.NumericalMethods
Assembly:  AGI.Foundation.SegmentPropagation (in AGI.Foundation.SegmentPropagation.dll) Version: 19.1.398.0 (19.1.398.0)
Syntax
public class ExtremeValueOfSegmentConstraint : SegmentPropagatorConstraint

The ExtremeValueOfSegmentConstraint type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyDesiredValue
Gets or sets the threshold that the evaluated value will be compared to when solving for a particular trajectory. This value must not vary in time; consider using a ParameterizedValueDefinitionT if you want to change this value at propagation time.
(Inherited from SegmentPropagatorConstraint.)
Public propertyExtremumType
Gets or sets if the minimum or maximum value of the Scalar will be the computed constraint value.
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 propertyName
Gets or sets an optional name to identify this constraint.
(Inherited from SegmentPropagatorConstraint.)
Public propertyParameter
Gets or sets the parameter to use when evaluating the Scalar. The Scalar must be same to evaluate at any time during the ephemeris of the Segment. The common way to do that is to create a Scalar that is built from a ParameterizedOnStateScalar, ParameterizedOnStatePoint or ParameterizedOnStateVector with this parameter as their parameter. Note that there is coupling between this and the Scalar, and as such be sure to update this property if the parameter the Scalar depends on changes.
Public propertyScalar
Gets or sets the Scalar to compute a value to compare to the DesiredValue. This Scalar must be same to evaluate at any time during the ephemeris of the Segment. The common way to do that is to create a Scalar that is built from a ParameterizedOnStateScalar, ParameterizedOnStatePoint or ParameterizedOnStateVector with this parameter as their parameter.
Public propertyScaling
Gets or sets the Scaling of the constraint. By default this is NoScalingOnConstraint. It is important to note that the actual scale factor is only available through the evaluator.
(Inherited from SegmentPropagatorConstraint.)
Public propertySegment
Gets or sets the SegmentDefinition whose initial and final ephemeris points (in the StateForNextSegment) will be used to compute a value.
Public propertyTolerance
Gets or sets the tolerance that determines if the evaluated value equals the DesiredValue.
(Inherited from SegmentPropagatorConstraint.)
Top
Methods
  NameDescription
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 SegmentPropagatorConstraint.)
Protected methodCheckForSameDefinition(ExtremeValueOfSegmentConstraint)
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(SegmentPropagatorConstraint)
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 SegmentPropagatorConstraintCheckForSameDefinition(SegmentPropagatorConstraint).)
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 SegmentPropagatorConstraintComputeCurrentDefinitionHashCode.)
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 SegmentPropagatorConstraintEnumerateDependencies(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
Creates and returns the SegmentPropagatorConstraintEvaluator.
(Overrides SegmentPropagatorConstraintGetEvaluator(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.)
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.)
Protected methodValidateProperties
Validates that required properties are configured correctly in order to get an evaluator for this instance. Derived classes should call this method when implementing GetEvaluator(EvaluatorGroup), as well as validate their own properties.
(Inherited from SegmentPropagatorConstraint.)
Top
See Also