MatrixExpression¶

class MatrixExpression¶

Returned by

ExpressionApi.CreateMatrixExpression

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

GetDefaultValue()¶

Returns the default value which is used as a fallback if no explicit value for an element is defined.

Returns:: Expression used as default value
Return type:: str

GetLines()¶

Returns a list of values for all lines. Each line itself is also a list of all the values within the line. Values not explicitely set are represented by the default value.

Returns:: Sorted list containing all values
Return type:: list[list[str]]

GetValue(xIndex, yIndex)¶

Returns the expression defining an element’s value.

Parameters:

xIndex : int¶: Elements x position
yIndex : int¶: Elements y position

Returns:

Expression

Return type:

str

GetXDimension()¶

Returns the x dimension of the matrix.

Returns:: maximum number of elements in x dimension
Return type:: int

GetYDimension()¶

Returns the y dimension of the matrix.

Returns:: maximum number of elements in y dimension
Return type:: int

RemoveValue(xIndex, yIndex)¶

Removes the expression defining an element’s value.

Parameters:

xIndex : int¶: Elements x position
yIndex : int¶: Elements y position

SetDefaultValue(value)¶

Sets the default value which is used as a fallback if no explicit value for an element is defined.

Parameters:

value : str¶: Expression to be used as default value

SetValue(xIndex, yIndex, value)¶

Sets the expression defining an element’s value.

Parameters:

xIndex : int¶: Elements x position
yIndex : int¶: Elements y position
value : str¶: Expression