OptimizationConstraint Object

The OptimizationConstraint object allows the user to access properties of any constraint being used in an optimization process. This object is not creatable in script, but can be added to an Optimizer object as seen in the example below. OptimizationConstraints that have been added to an Optimizer object can be accessed through properties and methods on the Optimizer object. See the Optimization Guide for more information.

Available In Editions:

Timing Precision Mode

Name	Description	Attributes
CyclicRangeSpan	Defines the span of the cyclic range of the constraint. This is the difference between the upper and lower cyclic values. This can improve convergence when modeling an angular parameter, for example Spacecraft.TA.	Type: Variable Access: Read/Write
DeclaredName	The name of the object as declared.	Type: String Access: Read-Only
Label	The label for this optimization constraint.	Type: String Access: Read-Only
LowerBound	Lower bound associated with the Constraint. Note that this property can be set using the SetBounds methods.	Type: Variable Access: Read-Only
Name	The name displayed for this object in output windows such as views, plots, and reports.	Type: String Access: Read/Write
ObjectId	The unique identifier for the object.	Type: Variable Access: Read-Only
ObjectType	The type of the object.	Type: String Access: Read-Only
Scale	The scale factor used for the constraint parameter. This can be used to normalize constraint values to be the same order of magnitude to preserve better matrix conditioning.	Type: Variable Access: Read/Write
UpperBound	Upper bound associated with the Constraint. Note that this property can be set using the SetBounds method.	Type: Variable Access: Read-Only

Name	Description
ClearSavedStates	Clears previous saved states for this object.
GetFromFile	Load the object state from the specified FreeFlyer object file.
GetFromString	Load the object state from the specified string.
PutToFile	Convert the object state to FreeFlyer object xml and write to a file.
PutToString	Convert the object state to FreeFlyer object xml and return as a string.
ReferenceEquals	Returns 1 if the argument refers to the calling object and 0 otherwise.
Restore	Restore an object's state from a previously saved state.
Save	Save the object's state so that it can be restored later.
SetEqualityBounds	Sets the equality value to use when enforcing the equality constraint.
SetLowerAndUpperBounds	Sets the lower and upper bound values of the constraint.
SetLowerBound	Sets the lower bound value of the constraint.
SetUpperBound	Sets the upper bound value of the constraint.

OptimizationConstraint Object

Description

Available In Editions:

Timing Precision Mode