TsMultiCheck¶

class TsMultiCheck¶

Returned by

TestStepApi.CreateTsMultiCheck

AddTag(tag)¶

Add a specific tag to this step.

Parameters:

tag : str¶: The tag to be set

AppendTestStep(testStep)¶

Adds a test step at the end of the Multi-Check test step.

Parameters:

testStep¶: Test step to be added, either calculation or read test step

Raises:

ApiError – If the test step to be appended is not calculation or read

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

DeactivateTimeOption()¶: Deactivates any time option set on the test step. This is equivalent to selecting the option “none” in the test step’s time options menu.

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’)

DisableReporting(disable=True)¶

Disables or enables the reporting this test step.

Parameters:

disable : boolean¶: If True the result of this test step will not be reported (optional)

DisableReportingFor(results)¶

Sets for which results reporting of the test step is disabled.

Parameters:

results : list[str]¶: List of results for which the test step will not be reported. Valid results are: u’NONE’, u’SUCCESS’, u’INCONCLUSIVE’, u’FAILED’, u’ERROR’

GetActionColumnText()¶

Returns the text value of the “action” column.

Returns:: Action column text
Return type:: str

GetActiveTimeOptionType()¶

Returns the type of the currently active time option.

Returns:: Type of active time option (“Timeless”, “Finally”, “TrueForWithin”, “Generally”, “SyncOnly”, “PollingCycleMultiplier”)
Return type:: string

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

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

GetMatchType()¶

Returns the match type of the Multi-Check step.

The valid match types can be figured out by using the API method GetMatchTypes.

Returns:: match type
Return type:: str

GetMatchTypes()¶

Returns the possible match types of the Multi-Check step.

Returns:: list of possible match types
Return type:: list[str]

GetMinimumDuration()¶

Returns the minimum duration of the test step’s time option, if a corresponding option has been set.

Returns:: The minimum duration, else None
Return type:: string

GetMinimumDurationUnit()¶

Returns the unit of the minimum duration of the test step’s time option, if a corresponding option has been set.

Returns:: The unit of the minimum duration, else None
Return type:: string

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

GetPollingCycle()¶

Returns the polling cycle of the test step’s time option, if a corresponding option has been set.

Returns:: The polling cycle, else None
Return type:: string

GetPollingCycleUnit()¶

Returns the unit of the polling cycle of the test step’s time option, if a corresponding option has been set.

Returns:: The unit of the polling cycle, else None
Return type:: string

GetReportDisablingResults()¶

Returns for which results reporting of the test step is disabled.

Returns:: List of results for which the test step will not be reported
Return type:: list[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

GetTestSteps(skipDisabledSteps=True, recursive=False, whiteList=None, blackList=None)¶

Returns the children of the test step.

Parameters:

skipDisabledSteps : boolean¶: Defines whether disabled test steps should be excluded.
recursive : boolean¶: Specifies whether only the direct children of the test step or recursively all test steps from the complete test step tree should be returned.
whiteList : list[str]¶: If specified, only those test steps whose class name is on this list are returned.
blackList : list[str]¶: If specified, only those test steps whose class name is not on this list are returned.

Returns:

List with all children test steps

Return type:

list[TestStep]

GetTimeout()¶

Returns the timeout of the test step’s time option, if a corresponding option has been set.

Returns:: The timeout else None
Return type:: string

GetTimeoutUnit()¶

Returns the unit of the timeout of the test step’s time option, if a corresponding option has been set.

Returns:: The unit of the timeout else None
Return type:: string

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

GetValueColumnText()¶

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

Returns:: Value column text
Return type:: str

InsertTestStep(testStep, position)¶

Adds a test step at a certain position of the Multi-Check test step.

Parameters:

testStep¶: Test step to be added, either calculation or read test step
position : integer¶: Target index of child beginning with 0

Raises:

ApiError – If the test step to be inserted is not calculation or read

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

IsOk()¶

Returns the internal state of correctness of the test step.

Returns:: True if no problems were found, else False
Return type:: boolean

IsReportingDisabled()¶

Returns whether reporting of this test step is disabled.

Returns:: True if reporting is disabled
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

RemoveTestStep(testStep)¶

Removes a test step from the container.

Parameters:

testStep¶: Test step to be removed

Raises:

ApiError:

When the test step is not a direct child of the container
When the test step is not editable

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

SetEnabled(state=True)¶

Enable or disable the test step.

Parameters:

state : bool¶: True (Default) to enable, False to disable the test step.

SetMatchType(name)¶

Sets the match type of the Multi-Check step.

The valid match types can be figured out by using the API method GetMatchTypes.

Parameters:

name : str¶: match type

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

SetTimeOptionOnlySynchronization(timeout, pollingCycle=None, timeoutUnit='ms', pollingCycleUnit='ms')¶

Sets the test step’s time option to “only synchronization”.

Parameters:

timeout : string¶: The timeout to be used
pollingCycle : string¶: Optional polling cycle to be used.
timeoutUnit : string¶: Optional unit for the timeout (ms, s, min, h or d)
pollingCycleUnit : string¶: Optional unit for the polling cycle (ms, s, min, h or d)

SetTimeOptionPollingCycleMultiplier(pollingCycleMultiplier)¶

Sets the test step’s time option to “polling cycle multiplier”. This option must only be used when inserting the test step into a Multi-Check!

Parameters:

pollingCycleMultiplier : string¶: The polling cycle multiplier to be used.

SetTimeOptionTrueForAtLeast(minimumDuration, pollingCycle=None, minimumDurationUnit='ms', pollingCycleUnit='ms')¶

Sets the test step’s time option to “true for at least”.

Parameters:

minimumDuration : string¶: The minimum duration to be used
pollingCycle : string¶: Optional polling cycle to be used
minimumDurationUnit : string¶: Optional unit for the minimum duration (ms, s, min, h or d)
pollingCycleUnit : string¶: Optional unit for the polling cycle (ms, s, min, h or d)

SetTimeOptionTrueForAtLeastWithin(minimumDuration, timeout, pollingCycle=None, timeoutUnit='ms', minimumDurationUnit='ms', pollingCycleUnit='ms')¶

Sets the test step’s time option to “true for at least … within …”.

Parameters:

minimumDuration : string¶: The minimum duration to be used
timeout : string¶: The timeout to be used
pollingCycle : string¶: Optional polling cycle to be used
timeoutUnit : string¶: Optional unit for the timeout (ms, s, min, h or d)
minimumDurationUnit : string¶: Optional unit for the minimum duration (ms, s, min, h or d)
pollingCycleUnit : string¶: Optional unit for the polling cycle (ms, s, min, h or d)

SetTimeOptionWaitUntilTrue(timeout, pollingCycle=None, timeoutUnit='ms', pollingCycleUnit='ms')¶

Sets the test step’s time option to “wait until true”.

Parameters:

timeout : string¶: The timeout to be used
pollingCycle : string¶: Optional polling cycle to be used.
timeoutUnit : string¶: Optional unit for the timeout (ms, s, min, h or d)
pollingCycleUnit : string¶: Optional unit for the polling cycle (ms, s, min, h or d).

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’)

IsFulfilledForEach()¶

Returns True, if the option “fulfilled for each test step” is activated. Else False.

Returns:: True, if the option “fulfilled for each test step” is activated. Else False.
Return type:: boolean

Deprecated since version 2025.2: Please use method GetMatchType instead.

SetFullFilledForEach(value)¶

Sets the expectation, the Multi-Check is fulfilled for. If value is True, the expectation will be set to “each test step”, else it will be “least one test step”

Parameters:

value : boolean¶: True, for “each test step”, False for “least one test step”

Deprecated since version 2025.2: Please use method SetMatchType instead.