Optimizer.GetStateVariableValue(Variable) Method

Top 

Description

Returns the current value of the requested state variable. The current value is obtained from the third party optimization engine, and is updated upon every call to Minimize/Maximize.

 

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.GetStateVariableValue(

Variable index)

 

 

Arguments

index


Description:

Index of the state variable value to return.

Valid Range:

index ≥ 0

 

 

 

Return Value

Type:

number

 

 

Returns the value of the specified state variable.

 

Syntax

myVariable1 = myOptimizer1.GetStateVariableValue(myVariable2);

 

 

See also

Optimizer Object

Optimizer.GetStateVariableValue