MapExpression¶

class MapExpression¶

Returned by

ExpressionApi.CreateMapExpression

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

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

GetXDistributionDefaultValue()¶

Returns the default value which is used as a fallback if no explicit value for a distribution element on the x axis is defined.

Returns:: Expression to be used as default value for distribution
Return type:: str

GetXDistributionValue(index)¶

Gets the x distribution level of the given position.

Parameters:

index : int¶: Element position to return

Returns:

distribution value

Return type:

str

GetXDistributionValues()¶

Returns a list of all x distribution values. Values not explicitely set are represented by the default value.

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

GetYDimension()¶

Returns the y dimension of the matrix.

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

GetYDistributionDefaultValue()¶

Returns the default value which is used as a fallback if no explicit value for a distribution element on the y axis is defined.

Returns:: Expression to be used as default value for distribution
Return type:: str

GetYDistributionValue(index)¶

Gets the y distribution level of the given position.

Parameters:

index : int¶: Element position to return

Returns:

distribution value

Return type:

str

GetYDistributionValues()¶

Returns a list of all y distribution values. Values not explicitely set are represented by the default value.

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

RemoveValue(xIndex, yIndex)¶

Removes the expression defining an element’s value.

Parameters:

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

RemoveXDistributionValue(index)¶

Removes the x distribution value of the given index.

Parameters:

index : int¶: Element position to remove

RemoveYDistributionValue(index)¶

Removes the y distribution value of the given index.

Parameters:

index : int¶: Element position to remove

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

SetXDistributionDefaultValue(value)¶

Sets the default value which is used as a fallback if no explicit value for a distribution element on the x axis is defined.

Parameters:

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

SetXDistributionValue(index, value)¶

Sets the y distribution value of the given position.

Parameters:

index : int¶: Element position to set
value : str¶: Expression

SetYDistributionDefaultValue(value)¶

Sets the default value which is used as a fallback if no explicit value for a distribution element on the y axis is defined.

Parameters:

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

SetYDistributionValue(index, value)¶

Sets the y distribution value of the given position.

Parameters:

index : int¶: Element position to set
value : str¶: Expression