ScalarAtEndOfSegmentCostFunction Class

Initializes a new instance as a copy of an existing instance.

Initializes a new instance.

Initializes a new instance.

Initializes a new instance.

Initializes a new instance.

Gets or sets if the final state or if the initial state should be used when evaluating this constraint. By default this is Final.

Gets or sets a value indicating whether the cost function is supposed to be minimized or maximized.

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.

Gets or sets an optional name to identify this constraint.

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 this and the ScalarScalar are coupled and changing this property will generally require changing the Scalar as well.

Gets or sets the Scalar to compute a value to minimize or maximize. 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.

Gets or sets the SegmentDefinition whose final ephemeris point (in the StateForNextSegment) will be used to compute a value.

Gets or sets the settings for the ParameterOptimizer associated with this cost function.

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).

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).

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).

Clones this object using the specified context.

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.

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.

Determines whether the specified object is equal to the current object.

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.

Freezes this object. Further attempts to modify it will result in an ObjectFrozenException.

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.

Gets a hash code representing the definition of this object.

Creates and returns the SegmentPropagatorCostFunctionEvaluator.

Serves as the default hash function.

Gets the Type of the current instance.

Determines if this object has the same definition as another object.

Creates a shallow copy of the current Object.

Throws ObjectFrozenException if this object IsFrozen. This method should be called from any method or property that modifies this object.

Returns a string that represents the current object.

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.