DTCListExpectation

class DTCListExpectation

Returned by

AppendDtc(dtc)

Appends the given DTC to the DTC list.

Info

if a numeric representation is chosen, you must provide a hex string with prefix 0x.

Parameters:
dtc : str

The DTC to append, in the format specified via SetRepresentation()

AppendToleratedDtc(dtc)

Appends the given DTC to the list of tolerated DTCs.

This automatically disables “tolerate all”.

Info

if a numeric representation is chosen, you must provide a hex string with prefix 0x.

Parameters:
dtc : str

The DTC to append, in the format specified via SetRepresentation()

ClearDtcList()

Removes all DTCs from the DTC list.

ClearToleratedDtcList()

Removes all DTCs from the list of tolerated DTCs.

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:

DTCListExpectation

GetDtcList()

Retrieves the list of expected DTCs.

Returns:

List of expected DTCs

Return type:

list[str]

GetDtcListExpression()

Returns the DTC list expression.

Returns:

DTC list expression

Return type:

str

GetRepresentation()

Returns the DTC representation.

Returns:

name of the representation for DTCs

Return type:

str

GetToleratedDtcList()

Retrieves the list of tolerated DTCs.

Returns:

List of tolerated DTCs

Return type:

list[str]

GetToleratedDtcListExpression()

Returns the tolerated DTC list expression.

Returns:

tolerated DTC list expression

Return type:

str

IsExpectPresent()

Returns whether the specified list of DTCs will be expected to be present (True) or absent (False)

Returns:

Specified DTCs will be expected to be present (True) or absent (False)

Return type:

bool

IsTolerateAll()

Returns whether all other DTCs (which are not in the DTC list) should be tolerated.

Returns:

tolerate all (True) or only those in the tolerated list (False)

Return type:

bool

SetDtcListExpression(dtcListExpression)

Sets the DTC list expression.

Parameters:
dtcListExpression : str

DTC list expression

SetExpectAbsent()

Declares that the DTCs specified via AppendDtc() as well SetDtcListExpression() are expected to be absent.

SetExpectPresent()

Declares that the DTCs specified via AppendDtc() as well SetDtcListExpression() are expected to be present.

SetRepresentation(representation)

Sets the DTC representation.

Parameters:
representation : str

Name of the representation for DTCs. Possible values: - ‘Display Trouble Code including FTB ([PCBU]-Code)’ - ‘Display Trouble Code without FTB ([PCBU]-Code)’ - ‘Short Name’ - ‘Description’ - ‘Number (3 Byte)’ - ‘Number (2 Byte)’

SetTolerateAll()

Declares that all all other DTCs (not mentioned in the DTC list) shall be tolerated.

This automatically clears the list and expression of tolerated DTCs

SetToleratedDtcListExpression(toleratedDtcListExpression)

Sets the tolerated DTC list expression.

This automatically disables “tolerate all”.

Parameters:
toleratedDtcListExpression : str

tolerated DTC list expression