TsKeywordArgument¶
- class TsKeywordArgument¶
- Clone()¶
Call this method if you want to use API-objects in multiple contexts, e.g. if you want to insert a specific test step in multiple blocks.
- Returns:
A copy of this object
- Return type:
- GetIdentifier()¶
Returns the identifier of the argument.
- Returns:
Identifier of argument.
- Return type:
str
- GetKeywordValueExpression()¶
Returns the value expression of the argument.
- Returns:
Expression of argument.
- Return type:
- GetName()¶
Returns the name of the underlying argument, if the containing keyword catalog is loaded.
- Returns:
Name of argument.
- Return type:
str
- GetUnit()¶
Returns the unit of the argument.
- Returns:
Unit string of argument or None if no unit information is attached.
- Return type:
str
- GetValueExpression()¶
Returns the value expression of the argument.
- Returns:
Expression of argument.
- Return type:
str
- SetKeywordValueExpression(expression)¶
Sets the value expression of the argument.
- Parameters:
- expression¶
Expression of argument.
- SetUnit(unit)¶
Sets the unit of the argument.
- Parameters:
- unit : str¶
Unit string of argument. Use None to remove unit information.
- SetValueExpression(value)¶
Sets the value expression of the argument.
- Parameters:
- value : str¶
Expression of argument.
-
SetValueRangeExpression(minValue, maxValue, stepSize, includeMinValue=
True, includeMaxValue=False)¶ Special method to define a range as value expression for the argument.
- Parameters:
- minValue : str¶
Expression of the lower limit
- maxValue : str¶
Expression of the upper limit
- stepSize : str¶
Expression of the step size
- includeMinValue : boolean¶
If True (default) the minimum value is a candidate for the random value at runtime. If False it is not a possible candidate to pick from.
- includeMaxValue : boolean¶
If True the maximum value is a candidate for the random value at runtime; if False (default) it is not.