VectorVariable¶

class VectorVariable¶

Returned by

VariableApi.CreateVectorVariable

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

DeleteInitialElementValue(x)¶

Deletes the expression defining an element’s value.

Parameters:

x : int¶: Element position to delete.

GetDescription()¶

Returns the description of the variable.

Returns:: Description of variable
Return type:: str

GetDimension()¶

Returns the length of the vector.

Returns:: Maximum number of elements.
Return type:: int

GetInitialElementValue(x)¶

Returns the value expression at the index x of a vector.

Parameters:

x : int¶: Element position to get.

Returns:

Expression

Return type:

str

GetInitialValue()¶

Returns the initial value of the vector.

Returns:: The initial value of the vector as a list of string expressions.
Return type:: str

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

SetDimension(dimension)¶

Sets a new dimension for the vector variable. If the new dimension is smaller than the pre-existing vector, then the right-most values will be cut off.

Parameters:

dimension : int¶: The new dimension size.

SetInitialElementValue(x, value)¶

Sets the value at a specific index.

Parameters:

x : int¶: Element position to set.
value : str¶: Any Python expression as a string.

SetInitialValue(value)¶

Sets the initial values of the vector.

Parameters:

value : str¶: Initial values of the vector in the form of a list of string expressions.

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