TsReadAudio

class TsReadAudio

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:

TsReadAudio

DeactivateExpectation()

Deactivates the expectation so that the result will not be evaluated.

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]

GetExpectation()

Returns the expectation expression from the evaluation of the test step, or None, if no expectation was defined.

Returns:

The expectation

Return type:

Expectation

GetExpectationExpression()

Returns the expectation expression from the evaluation of the test step, or None, if no expectation was defined.

Returns:

The expectation

Return type:

string

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

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

GetRecordingDurationExpression()

Returns the expression that determines the recording duration.

Returns:

Recording duration

Return type:

str

GetRecordingDurationUnit()

Returns the unit of the recording duration.

Returns:

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

Return type:

str

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

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

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

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

SetEnabled(state=True)

Enable or disable the test step.

Parameters:
state : bool

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

SetExpectation(expectation)

Sets the expectation in the evaluation of the test step. The expectation will be activated if it was not enabled previously.

Parameters:
expectation

The expectation

SetExpectationExpression(expectation)

Shortcut to set an expectation for an unspecific type in the evaluation of the test step. The expectation will be activated if it was not enabled previously.

Parameters:
expectation : string

The expectation

SetRecordingDuration(duration, unit)

Sets the recording duration.

Parameters:
duration : str

Recording duration expression.

unit : str

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

Returns:

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

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)