<< Click here to display Table of Contents >> Navigation: Trading Objects Reference > Test > Functions:

GetSteppedParameter

Contents

When a test is being simulated this function will returns all the attributes of each stepped parameter, or when the values of the parameters are zero, it will return the number of stepped parameters to be sequenced.

Syntax:
test.GetSteppedParameter( paramIndex, paramValueIndex )

Parameter:	Description:
paramIndex	ParamIndex is based on the stepping priority.
paramValueIndex	paramValueIndex is shown below.

Example:
steppedParameterCount = test.GetSteppedParameter( 0, 0 ) PRINT "Using the following stepped parameters." PRINT "Name", _ "Step Start", _ "Step End", _ "Step Step", _ "Step Count", _ "Step Index", _ "Step Value", _ "Step Priority" FOR i = 1 to steppedParameterCount ' Stepped parameter values StepName = test.GetSteppedParameter( i, 1 ) stepStart = test.GetSteppedParameter( i, 2 ) stepEnd = test.GetSteppedParameter( i, 3 ) stepStep = test.GetSteppedParameter( i, 4 ) stepCount = test.GetSteppedParameter( i, 5 ) stepIndex = test.GetSteppedParameter( i, 6 ) stepValue = test.GetSteppedParameter( i, 7 ) stepPriority = test.GetSteppedParameter( i, 8 ) PRINT stepName, _ stepStart, _ stepEnd, _ stepStep, _ stepCount, _ stepIndex, _ stepValue, _ stepPriority NEXT

Example:

steppedParameterCount = test.GetSteppedParameter( 0, 0 )

PRINT "Using the following stepped parameters."
PRINT "Name", _

"Step Start", _

"Step End", _

"Step Step", _

"Step Count", _

"Step Index", _

"Step Value", _

"Step Priority"

FOR i = 1 to steppedParameterCount
' Stepped parameter values
StepName = test.GetSteppedParameter( i, 1 )
stepStart = test.GetSteppedParameter( i, 2 )
stepEnd = test.GetSteppedParameter( i, 3 )
stepStep = test.GetSteppedParameter( i, 4 )
stepCount = test.GetSteppedParameter( i, 5 )
stepIndex = test.GetSteppedParameter( i, 6 )
stepValue = test.GetSteppedParameter( i, 7 )
stepPriority = test.GetSteppedParameter( i, 8 )

PRINT stepName, _

stepStart, _

stepEnd, _

stepStep, _

stepCount, _

stepIndex, _

stepValue, _

stepPriority
NEXT

Returns:
When values greater than 0 are used in each of the parameter locations, the return value will be the attributes of each parameter. When 0 is used in both of the parameter fields, the number of stepped parameters in the test is the returned information.

Returns:

When values greater than 0 are used in each of the parameter locations, the return value will be the attributes of each parameter.

When 0 is used in both of the parameter fields, the number of stepped parameters in the test is the returned information.

Links:

See Also:

Edit Time: 5/31/2017 10:30:12 AM

Topic ID#: 360