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
|
DisplayName
|
The name displayed for this object in output windows such as views, plots, and reports.
|
Type: String
Access: Read/Write
|
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
|
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
|
