TsWait

class TsWait

Api- of the wait utility test step.

Returned by

AddTag(tag)

Add a specific tag to this step.

Parameters:
tag : str

The tag to be set

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:

TsWait

DeactivateSaveIn()

Deactivates the test step’s save in property, so the value will not be stored in a package variable.

DeleteTranslatedCommentText(language)

Deletes a comment for the test step in the given language.

Parameters:
language : str

Language of the text (‘en_US’, ‘de_DE’, ‘zh_CN’)

GetActionColumnText()

Returns the text value of the “action” column.

Returns:

Action column text

Return type:

str

GetComment()

Returns the comment of the test step in the current test case language.

Returns:

Comment text as shown in the comment tab

Return type:

str

GetCommentColumnText()

Returns the text value of the “comment” column.

Returns:

Comment column text

Return type:

str

GetDelayExpression()

Returns the delays period expression.

Returns:

Expression as period of time to be delayed

Return type:

str

GetError()

Returns a list of errors. Note that the error messages depend on the program language ecu.test is set to. Because of that we do not recommend to check against exact error messages, unless you are certain about the respective program language.

Returns:

List of errors

Return type:

list[str]

GetIndex()

Returns the zero based index in the parent.

Returns:

Zero based index

Return type:

integer

GetLineNo()

Returns the test steps line number within its test case.

Returns:

Line number

Return type:

int

GetMaxRangeValue()

Returns the maximal value of the range.

Returns:

Maximal value of range.

Return type:

str

GetMinRangeValue()

Returns the minimal value of the range.

Returns:

Minimal value of range.

Return type:

str

GetParameterColumnText()

Returns the text value of the “parameter” column.

Returns:

Parameter column text

Return type:

str

GetParent()

Returns the parent test step.

Returns:

The parent test step or None if it is a top level test step.

Return type:

TestStep

GetRangeStepSize()

Returns the step size of the range.

Returns:

Step size of range.

Return type:

str

GetSaveInVariableName()

Returns the currently selected variable to save the return value.

Returns:

The variable’s name or None if return value is not saved to a variable by the keyword test step.

Return type:

str

GetTags()

Returns the tags set for this step.

Returns:

A (sorted) list of tags

Return type:

list[str]

GetTestManagementId()

Returns the test management id of the test step.

Returns:

Test step id.

Return type:

str

GetTestStepId()

Returns the test step id.

Returns:

test step id

Return type:

str

GetTranslatedCommentText(language)

Returns the text value of the “comment” column in the given language.

Parameters:
language : str

Language of the requested text (‘en_US’, ‘de_DE’, ‘zh_CN’)

Returns:

Comment column text

Return type:

str

GetType()

Returns the type (class name) of the test step, e.g.

  • “TsPreconditionBlock”

  • “TsWait”

  • “TsIfThenElse”

  • “TsSwitchCase”

  • “TsCaseNode”

Returns:

Type (class name) of the test step

Return type:

str

GetUnit()

Returns the delays unit.

Returns:

Unit of time (min, s, ms)

Return type:

str

GetValueColumnText()

Returns the text value of the “value” column in your current test case language.

Returns:

Value column text

Return type:

str

IsBreakpoint()

Checks whether the test step is a break point.

Returns:

True if test step is a break point, else False

Return type:

boolean

IsContainer()

Returns True, if the test step supports calling GetChildren as well as manipulating the structure of its children. (e. g. via inserting or deleting sub test steps).

Returns:

True if it can contain test steps, else False

Return type:

boolean

IsEnabled()

Returns the state of the test step.

Returns:

True if test step is enabled, otherwise False

Return type:

bool

IsInPostcondition()

Returns True if the test step is located in a postcondition

Returns:

True if the test step is located in a postcondition, else Flase

Return type:

bool

IsInPrecondition()

Returns True if the test step is located in a precondition

Returns:

True if the test step is located in a precondition, else False

Return type:

bool

IsMaxValueIncludedInRange()

Returns whether the maximal value is included in the range.

Returns:

True if maximal value is included (<=), else False (<)

Return type:

boolean

IsMinValueIncludedInRange()

Returns whether the minimal value is included in the range.

Returns:

True if minimal value is included (>=), else False (>)

Return type:

boolean

IsOk()

Returns the internal state of correctness of the test step.

Returns:

True if no problems were found, else False

Return type:

boolean

IsVisible()

Checks whether the test step is visible. This depends on the test step itself or a parent test step being disabled.

Returns:

True if test step is visible, else False

Return type:

boolean

RemoveTag(tag)

Remove a specific tag from this step.

Parameters:
tag : str

The tag to be removed

SetBreakpoint(enable)

Sets or unsets the test step to act as a break point.

Parameters:
enable : boolean

True if test step is a break point, else False

SetComment(comment)

Sets a comment for the test step in the current test case language.

Parameters:
comment : str

Text to be displayed in the comment tab

SetDelay(delay, timeUnit)

Sets the delay and its unit. The test execution is stopped for the specified time span.

Parameters:
delay : str

Expression as period of time to be delayed

timeUnit : str

Unit of time (d, h, min, s, ms)

SetEnabled(state=True)

Enable or disable the test step.

Parameters:
state : bool

True (Default) to enable, False to disable the test step.

SetRange(minValue, maxValue, stepSize, includeMinValue=True, includeMaxValue=False)

Special method to define a range as value 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.

SetSaveInVariableName(variableName)

Sets the name of the variable used for storing data by the return. The variable will be created automatically if it does not already exist in the package where the return is placed in.

Parameters:
variableName : str

The variable’s name. Must not be None or an empty string.

Raises:

ApiError – If variableName is None or an empty string

SetTags(tags)

Set the list of tags for this step. The list of tags will be sorted and stored.

Parameters:
tags : list[str]

The list of tags

SetTestManagementId(testManagementId)

Sets the test management id of the test step.

Parameters:
testManagementId : str

Test management id of the test step

SetTranslatedCommentText(comment, language)

Sets a comment for the test step in the given language.

Parameters:
comment : str

Text to be displayed

language : str

Language of the text (‘en_US’, ‘de_DE’, ‘zh_CN’)

SetUnit(timeUnit)

Sets the time unit of the delay or value range expression

Parameters:
timeUnit : str

Unit of time (d, h, min, s, ms)