DifferentialCorrector Object

Name

Description

Attributes

Converged

Flag indicating an iteration of the targeting loop has met the specified goals. This flag is intended to be used to control the generation of output within the targeting loop when only an execution of the loop at the solution is desired to be output.

= 0 Has not met goals

= 1 Has met goals.

Type:   Variable

Access: Read-Only

DeclaredName

The name of the object as declared.

Type:   String

Access: Read-Only

GoalAchieved

Goal property's achieved (or present) value, where the array index (i.e., 'n') ranges from 0 to GoalCount - 1.

Type:   Array

Access: Read-Only

GoalCount

Number of properties that are part of the goal.

Type:   Variable

Access: Read-Only

GoalName

Goal property's name, where the array index (i.e., 'n') ranges from 0 to GoalCount - 1.

Type:   StringArray

Access: Read-Only

GoalTarget

Goal property's target value, where the array index (i.e., 'n') ranges from 0 to GoalCount - 1.

Type:   Array

Access: Read-Only

IterationMode

String indicating the present mode of execution for a targeting loop.

Nominal = First execution or correction has been applied.

Perturbation = Perturbation to one of the varied properties has been applied.

Converged = All goals have been met within their given tolerances.

Failed = Maximum number of corrections has been attempted without meeting all the specified goals.

Type:   String

Access: Read-Only

Iterations

Number of iterations through the targeting process that have been performed. This is equivalent to the number of corrections that have been applied.

Type:   Variable

Access: Read-Only

MaxIterations

Maximum number of corrections that will be attempted by the targeting process.

Type:   Variable

Access: Read/Write

Name

The name displayed for this object in output windows such as views, plots, and reports.

Type:   String

Access: Read/Write

NominalIteration

Flag indicating nominal iterations of the targeting loop. This flag is intended to be used to control the generation of output within the targeting loop when only the non perturbation executions of the loop are desired to be output.

Type:   Variable

Access: Read-Only

ObjectId

The unique identifier for the object.

Type:   Variable

Access: Read-Only

ObjectType

The type of the object.

Type:   String

Access: Read-Only

SensitivityMatrix

The sensitivty matrix. The number of rows equals the number of varys, and the number of columns equals the number of achieves.

Type:   Matrix

Access: Read-Only

VaryCount

Number of properties that are being varied.

Type:   Variable

Access: Read-Only

VaryFinal

Varied property's final (or present) value, where the array index (i.e., 'n') ranges from 0 to VaryCount - 1.

Type:   Array

Access: Read-Only

VaryInitial

Varied property's initial value, where the array index (i.e., 'n') ranges from 0 to VaryCount - 1.

Type:   Array

Access: Read-Only

VaryName

Varied property's name, where the array index (i.e., 'n') ranges from 0 to VaryCount - 1.

Type:   StringArray

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.

Name

Description

Attributes

Sensitivity

Sensitivity matrix, where the array index (i.e., 'n') ranges from 0 to (VaryCount * GoalCount) - 1.

This property has been Deprecated. Please use DifferentialCorrector.SensitivityMatrix instead, using indices to access elements of the matrix.

Type:   Array

Access: Read-Only