NumericVariable¶

class NumericVariable¶

Returned by

VariableApi.CreateNumericVariable

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:: NumericVariable

GetDescription()¶

Returns the description of the variable.

Returns:: Description of variable
Return type:: str

GetInitialNumericValueString()¶

Returns the initial value string of the variable, or None if it is not a Numeric.

The initial value is returned exactly as it has been typed in (e.g. in hex, or with additional zeroes), unless it has been set via SetInitialNumericValue(), which stores only the numeric value itself.

Returns:: Initial value of the variable
Return type:: str

GetInitialValue()¶

Returns the initial value of the variable or None if it is not a Numeric.

Returns:: Initial value of the variable
Return type:: int/float

GetName()¶

Returns the name of the variable.

Returns:: Name of variable
Return type:: str

GetType()¶

Returns the type of the initial value of the variable.

Returns:: type of the initial value
Return type:: str

IsParameter()¶

Returns whether the variable is a parameter.

Returns:: True if parameter, else False
Return type:: boolean

IsRecorded()¶

Returns whether the variable is recorded during execution.

Returns:: True if recorded, else False
Return type:: boolean

IsReturn()¶

Returns whether the variable is a return value.

Returns:: True if return value, else False
Return type:: boolean

SetDescription(description)¶

Sets the description of the variable.

Parameters:

description : str¶: Description of variable

SetInitialNumericValueString(value)¶

Sets the initial value of the variable as string.

The string will be stored exactly as typed (e.g. in hex, or with additional zeroes).

Parameters:

value : str¶: Initial value of the variable

SetInitialValue(value)¶

Sets the initial value of the variable.

Only the numeric value itself will be stored, not the way it has been typed in (e.g. in hex, or with additional zeroes).

Parameters:

value : int/float¶: Initial value of the variable

SetParameter(enable=True)¶

Sets whether the variable is a parameter or not.

Parameters:

enable : boolean¶: Whether the variable is a parameter or not

SetRecorded(enable=True)¶

Sets the recording state of the variable to the value of enable.

Parameters:

enable : boolean¶: Whether to enable the recording of the variable

SetReturn(enable=True)¶

Sets whether the variable is a return value or not.

Parameters:

enable : boolean¶: Whether the variable is a return value or not