ExtremeValueOfSegmentInequalityConstraint Class |
Namespace: AGI.Foundation.NumericalMethods
The ExtremeValueOfSegmentInequalityConstraint type exposes the following members.
Name | Description | |
---|---|---|
ExtremeValueOfSegmentInequalityConstraint | Initializes a new instance. Before GetEvaluator(EvaluatorGroup) can be called, Scalar, Segment, BoundType, and BoundValue must be configured, and Settings must be configured with a valid Tolerance. Scaling defaults to NoScalingOnInequalityConstraint. | |
ExtremeValueOfSegmentInequalityConstraint(ExtremeValueOfSegmentInequalityConstraint, CopyContext) | Initializes a new instance as a copy of an existing instance. | |
ExtremeValueOfSegmentInequalityConstraint(InequalityBoundType, SegmentDefinition, Double, Double, ExtremumType) |
Initializes a new instance.
| |
ExtremeValueOfSegmentInequalityConstraint(InequalityBoundType, Scalar, SegmentDefinition, Double, Double, TimeBasedStateParameter, ExtremumType) |
Initializes a new instance.
| |
ExtremeValueOfSegmentInequalityConstraint(InequalityBoundType, Scalar, SegmentDefinition, Double, Double, TimeBasedStateParameter, ExtremumType, InequalityConstraintScaling, Double) |
Initializes a new instance.
|
Name | Description | |
---|---|---|
BoundType |
Gets or sets a value indicating whether the BoundValue represents a lower or an upper bound.
(Inherited from SegmentPropagatorInequalityConstraint.) | |
BoundValue |
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 SegmentPropagatorInequalityConstraint.) | |
ExtremumType |
Gets or sets if the minimum or maximum value of the Scalar
will be the computed constraint value.
| |
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.) | |
Name |
Gets or sets an optional name to identify this constraint.
(Inherited from SegmentPropagatorInequalityConstraint.) | |
Parameter |
Gets or sets the parameter to use when evaluating the Scalar. The Scalar
must be set 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.
| |
Scalar |
Gets or sets the Scalar to compute a value to compare to the
BoundValue. This Scalar
must be set 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.
| |
Segment |
Gets or sets the SegmentDefinition whose entire computed ephemeris points
(in the StateForNextSegment) will be used to compute a value.
| |
Settings |
Gets or sets the settings for the ParameterOptimizer
associated with this constraint.
(Inherited from SegmentPropagatorInequalityConstraint.) |
Name | Description | |
---|---|---|
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 SegmentPropagatorInequalityConstraint.) | |
CheckForSameDefinition(ExtremeValueOfSegmentInequalityConstraint) |
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(SegmentPropagatorInequalityConstraint) |
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 SegmentPropagatorInequalityConstraintCheckForSameDefinition(SegmentPropagatorInequalityConstraint).) | |
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 SegmentPropagatorInequalityConstraintComputeCurrentDefinitionHashCode.) | |
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 SegmentPropagatorInequalityConstraintEnumerateDependencies(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 SegmentPropagatorInequalityConstraint.) | |
GetDefinitionHashCode |
Gets a hash code representing the definition of this object.
(Inherited from DefinitionalObject.) | |
GetEvaluator |
Creates and returns the SegmentPropagatorInequalityConstraintEvaluator.
(Overrides SegmentPropagatorInequalityConstraintGetEvaluator(EvaluatorGroup).) | |
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.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) | |
ValidateProperties |
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.
(Overrides SegmentPropagatorInequalityConstraintValidateProperties.) |