TsEesError¶

class TsEesError¶

Returned by

TestStepApi.CreateTsEesError

AddEesPinVariableMappingItem(mappingItem)¶

Adds a mapping item to the test case and adds the associated pin configuration.

Parameters:

mappingItem¶: Ees pin mapping item

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

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

GetDurationExpression()¶

Returns the duration expression of the test step in milliseconds.

Returns:: Duration expression
Return type:: str

GetDutyCycleExpression()¶

Returns the duty cycle expression of the test step.

Returns:: Duty cycle expression
Return type:: str

GetEesPinVariableMappingItems()¶

Returns all ees pin mapping items as list.

Returns:: List of ees pin mapping items
Return type:: list[EesPinVariableMappingItem]

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]

GetErrorType()¶

Returns the type of the error.

Returns:: Type of the error. One of [u’SIMPLE’, u’RESISTOR’]
Return type:: str

GetFrequencyExpression()¶

Returns the frequency expression of the test step in hertz.

Returns:: Frequency expression
Return type:: 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

GetLoad(mappingItem)¶

Returns the load of the pin associated with the mapping item.

Parameters:

mappingItem¶: Ees pin mapping item

Returns:

Whether the pin has a load or not

Return type:

boolean

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

GetPinsWithLoads()¶

Returns all pins as dictionary containing reference names as keys and load modes as values.

Returns:: Dictionary of reference names and load mode
Return type:: dict[string, boolean]

GetPotential()¶

Returns the potential of the test step.

Returns:: Potential
Return type:: str

GetResistorExpression()¶

Returns the resistor expression in ohm.

Returns:: Resistor expression or None
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

GetTimeOption()¶

Returns the time option of the test step.

Returns:: Time option. One of [u’STATIC’, u’DURATION’, u’LOSE_CONTACT’]
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

GetUserPotentialExpression()¶

Returns the user potential expression of the test step.

Returns:: User potential expression or None
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

RemoveEesPinVariableMapping(mappingItem)¶

Removes a mapping item from the test case and deletes the associated pin configuration.

Parameters:

mappingItem¶: Ees pin mapping item

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

SetDurationExpression(durationExpr)¶

Sets the duration expression of the test step in milliseconds. By setting the duration expression the time option will be set to ‘DURATION’ if it was set to ‘STATIC’ before.

Parameters:

durationExpr : str¶: Duration expression

SetDutyCycleExpression(dutyCycleExpr)¶

Sets the duty cycle expression of the test step. By setting the duty cycle expression the time option will be set to ‘LOSE_CONTACT’.

Parameters:

dutyCycleExpr : str¶: Duty cycle expression

SetEnabled(state=True)¶

Enable or disable the test step.

Parameters:

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

SetErrorType(errorType)¶

Sets the type of the error.

Parameters:

errorType : str¶: The type of the error. Must be one of [u’SIMPLE’, u’RESISTOR’]

Raises:

ApiError – If errorType is in [u’SIMPLE’, u’RESISTOR’]

SetFrequencyExpression(freqExpr)¶

Sets the frequency expression of the test step in hertz. By setting the duty cycle expression the time option will be set to ‘LOSE_CONTACT’.

Parameters:

freqExpr : str¶: Frequency expression

SetLoad(mappingItem, load)¶

Sets the load of the pin associated with the mapping item.

Parameters:

mappingItem¶: Ees pin mapping item
load : boolean¶: Whether the pin has a load or not

SetPotential(potential)¶

Sets the potential of the test step. If the potential is one of u’NONE’, u’GROUND’ or u’UBATT’, the user defined potential will be set to None.

Parameters:

potential : str¶: Potential. Must be one of [u’NONE’, u’GROUND’, u’UBATT’, u’USER_DEFINED’].

Raises:

ApiError – If potential is not in [u’NONE’, u’GROUND’, u’UBATT’, u’USER_DEFINED’]

SetResistorExpression(resistorExpr)¶

Sets the resistor expression in ohm. By setting the resistor expression the error type will be set to ‘RESISTOR’ if it was set to ‘SIMPLE’ before.

Parameters:

resistorExpr : str¶: Resistor expression

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

SetTimeOption(timeOption)¶

Sets the time option of the test step. When setting to ‘STATIC’, the properties duration, duty cycle and frequency will be set to None. Choosing ‘DURATION’ will only reset the properties duty cycle and frequency.

Parameters:

timeOption : str¶: Time option. Must be one of [u’STATIC’, u’DURATION’, u’LOSE_CONTACT’]

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

SetUserPotentialExpression(userPotential)¶

Sets the user potential expression of the test step. By setting the user potential expression the potential will be set to ‘USER_DEFINED’.

Parameters:

userPotential : str¶: User potential expression