TsStimulate¶

class TsStimulate¶

Returned by

TestStepApi.CreateTsStimulate

AddTag(tag)¶

Add a specific tag to this step.

Parameters:

tag : str¶: The tag to be set

AppendSegment(expression)¶

Appends a signal segment as last element.

Note:

The syntax for the expression is the same as used within the dialog of the stimulate test step. E.g.: ‘ConstantSegment(duration=3.5, value=2.0)’

Parameters:

expression : str¶: The signal segment expression

Raises:

ApiError – If the given expression is no valid segment

ClearSegments()¶: Removes all signal segments.

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

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

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

GetMappingItemReferenceName()¶

Returns the unique reference name of the mapping item used by this test step.

Returns:: Reference name of used mapping item
Return type:: str

GetOperation()¶

Get the operation method used for stimulation.

‘direct’: Directly stimulate the defined stimulus to model signal
‘add’: Overlay model signal by adding the defined stimulus
‘multiply’: Overlay model signal by multiplying the defined stimulus

Returns:: The operation
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

GetRepresentation(axis='z')¶

Returns the representation of a certain axis of the accessed test quantity.

Parameters:

axis : str¶: Axis to set representation for (x, y, z)

Returns:

Representation for axis (PHYS, TEXT, RAW, BITS)

Return type:

str

GetSaveInVariableName()¶

Returns the currently selected variable to save the data.

Returns:: The variable’s name
Return type:: string

GetSegment(index)¶

Returns the signal segment expression at the specified position.

Parameters:

index : int¶: The position (zero-based)

Returns:

The signal segment expression

Return type:

str

GetSegments()¶

Returns a list of all signal segment expressions.

Returns:: The signal segment expressions
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

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(axis='z')¶

Returns the unit of a certain axis of the accessed test quantity.

Parameters:

axis : str¶: Axis to set unit for (x, y, z)

Returns:

Unit for axis

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

InsertSegment(expression, index)¶

Inserts a signal segment at the specified position.

Note:

The syntax for the expression is the same as used within the dialog of the stimulate test step. E.g.: ‘ConstantSegment(duration=3.5, value=2.0)’

Parameters:

expression : str¶: The signal segment expression
index : int¶: The position (zero-based)

Raises:

ApiError – If the given expression is no valid segment

IsAutoStopStimulation()¶

Returns the actual state of auto stop stimulation.

Returns:: The stimulus playback is stopped automatically when it has finished
Return type:: boolean

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

IsSynchronousExecution()¶

Returns the actual state for the synchronous execution option.

Returns:: The test step waits until the stimulus playback has finished
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

RemoveSegment(index)¶

Removes a signal segment at the specified position.

Parameters:

index : int¶: The position (zero-based)

RemoveTag(tag)¶

Remove a specific tag from this step.

Parameters:

tag : str¶: The tag to be removed

SetAutoStopStimulation(state)¶

Sets whether the stimulus playback shall be stopped automatically when it has finished. Auto stop stimulation only works for enabled synchronous execution.

Parameters:

state : boolean¶: Set auto stop stimulus playback

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.

SetOperation(operation)¶

Set the operation method used for stimulation.

‘direct’: Directly stimulate the defined stimulus to model signal
‘add’: Overlay model signal by adding the defined stimulus
‘multiply’: Overlay model signal by multiplying the defined stimulus

Parameters:

operation : str¶: The operation. Possible values: “direct”, “add” or “multiply”

Raises:

ValueError – If the given operation is not any of “direct”, “add” or “multiply”.

SetRepresentation(representation='PHYS', axis='z')¶

Sets the representation of a certain axis of the accessed test quantity.

Parameters:

representation : str¶: Representation for axis (PHYS, TEXT, RAW, BITS)
axis : str¶: Axis to set representation for (x, y, z)

SetSaveInVariableName(variableName)¶

Sets the name of the variable used for storing data by the test step. The variable will be created automatically if it does not already exist in the package where the test step is placed in. This method must not be called, if the test step has not been added to a package previously.

Parameters:

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

Raises:

ApiError –

If SaveIn was called before the test step was added to a package.
If variableName is None or an empty string

SetSynchronousExecution(state)¶

Sets the state for the synchronous execution option and. This determines whether the test step waits until the stimulus playback has finished.

Parameters:

state : boolean¶: True to activate, False to deactivate synchronous execution

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(unit, axis='z')¶

Sets the unit of a certain axis of the accessed test quantity.

Parameters:

unit : str¶: Unit for axis
axis : str¶: Axis to set unit for (x, y, z)