Optimizer.AddStateVariableBlock(Variable, String, Variable, Variable, Variable, Variable, Variable) Method

Top 

Description

Creates "n" new entries in the Optimizer.StateVariables array, while providing initial values for StateVariable properties. Label is used as a prefix to create incremented labels for each entry.

 

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

Click here to see the documentation for this object in nanosecond timing precision mode.

 

Method Signature

Optimizer.AddStateVariableBlock(

Variable n,


String baseLabel,


Variable initialGuess,


Variable lowerBound,


Variable upperBound,


Variable scale,


Variable perturbation)

 

 

Arguments

n


Description:

The number of optimization variables to add.

Valid Range:

n ≥ 0

 

 

baseLabel


Description:

The base label for this block of optimization variables.

 

 

initialGuess


Description:

The initial guess for this block of optimization variables.

 

 

lowerBound


Description:

Lower bound for this block of optimization variables.

 

 

upperBound


Description:

Upper bound for this block of optimization variables.

 

 

scale


Description:

The scale for this block of optimization variables.

Valid Range:

scale ≥ 0

 

 

perturbation


Description:

Perturbation for this block of optimization variables.

 

 

 

Return Value

Type:

number

 

 

Returns the updated number of optimization variables.

 

Syntax

myVariable1 = myOptimizer1.AddStateVariableBlock(myVariable2, myString1, myVariable3, myVariable4, myVariable5, myVariable6, myVariable7);

 

 

See also

Optimizer Object

Optimizer.AddStateVariableBlock