GetSteppedParameter
Contents
When a test is running, this function will returns all the attributes of each stepped parameter.
This function is only used in the Set Parameters script.
Set Parameters Custom Script Section
To obtain information from each of the stepped parameters, or use the function to assign a value, use this function with an index value, and paramValueRef:
Enumeration Value Syntax: |
|---|
test.GetSteppedParameter(steppedParameterIndex, paramValueRef, [value]) |
Parameter: |
Description: |
|---|---|
paramIndex |
Each Stepping Parameter Index is based on its assigned stepping priority when the parameter was created. It is usually used in a look after the number of stepped parameters are known. |
paramValueRef |
The Parameter Value References are shown in the table below. |
[value] |
?? |
This table was created from what had worked before, and what I thought might be the current process to identify the parameter's type:
GetSteppedParameter Reference Table:
ParameterStepped Index: |
Parameter Option: |
Enumeration: |
Item Type: |
|---|---|---|---|
0 |
Stepped Test Count |
0 |
0 |
1 |
name |
1 |
Unknown |
2 |
start value |
2 |
Float |
3 |
end value |
3 |
Integer |
4 |
step value |
4 |
Percent |
5 |
step count |
5 |
Dollars |
6 |
current step |
6 |
Cents |
7 |
current value |
7 |
Boolean |
8 |
stepping priority |
8 |
Selector |
9 |
type |
9 |
Set |
10 |
set value |
10 |
String |
11 |
|
|
Date |
Use the function to get the count the number of parameters being stepped:
Count Parameter Uses this Syntax" 0 " value in the parameter locations: |
|---|
steppingCount = test.GetSteppedParameter( 0 ) |
This is my best guess as to how the might be sourced:
ENUM value is returned when the first parameter is an index that identifies a stepping parameter's index location, and the second represents the information request:
Enumeration Value Syntax: |
|---|
test.GetSteppedParameter( paramIndex, paramValueIndex, itemType ) |
Current Example in the TBB Help:
Example: |
|---|
NOTE:test.GetSteppedParameter(index,6) to return a 1 based index value, rather than 0 based. test.GetSteppedParameter(index, 10, value) which sets the value of the parameter. GetSteppedParameter returns a string, so convert to number if necessary.
steppedParameterCount = test.GetSteppedParameter( 0, 0 ) "Step Start", _ "Step "Step End", _ "Step Step", _ "Step Count", _ "Step Index", _ "Step Value", _ "Step Priority" testSteps = test.GetSteppedParameter( i, 0 ) stepName, _ stepStart, _ stepEnd, _ stepStep, _ stepCount, _ stepIndex, _ stepValue, _ stepPriority |
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. |
Links: |
|---|
Was: Before Test, NOW: Set Parameters |
See Also: |
|
Edit Time: 1/6/2021 4:28:46 PM |
Topic ID#: 360 |