DiagRoutineMappingItem¶

class DiagRoutineMappingItem¶

A diagnostic routine mapping item for CreateTsCall() with call mode ~ApiClient.CALL.

Returned by

MappingApi.CreateDiagRoutineMappingItem

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

GetAccessType()¶

Returns a string identifying the mapping item’s type. (such as MODEL, BUS, MEASUREMENT, …)

Returns:: access type
Return type:: str

GetCategory()¶

Returns the category

Returns:: Category
Return type:: str

GetDescription()¶

Returns the description

Returns:: Description
Return type:: str

GetDisplayedType()¶

Returns a “nice” representation of the type as displayed in the “type” column of the mapping panel

Returns:: the displayed mapping type
Return type:: str

GetEcuKey()¶

Returns the ECU key.

Returns:: ECU key
Return type:: str

GetInputParameterEnumeration(parameterName)¶

Returns the enumeration of the input parameter.

Parameters:

parameterName : str¶: name of the parameter

Returns:

Dictionary with the (text: value) pairs

Return type:

dict[str, int]

GetInputParameterNames()¶

Returns the names of the input parameters.

Returns:: names of the input parameters
Return type:: list[str]

GetInputParameterUnit(parameterName)¶

Returns the unit of the input parameter.

Parameters:

parameterName : str¶: name of the parameter

Returns:

unit of the parameter

Return type:

str

GetName()¶

Returns the RoutineControl name.

Returns:: RoutineControl name
Return type:: str

GetOutputParameterEnumeration(parameterName)¶

Returns the enumeration of the output parameter.

Parameters:

parameterName : str¶: name of the parameter

Returns:

Dictionary with the (text: value) pairs

Return type:

dict[str, int]

GetOutputParameterNames()¶

Returns the names of the output parameters.

Returns:: names of the output parameters
Return type:: list[str]

GetOutputParameterUnit(parameterName)¶

Returns the unit of the output parameter.

Parameters:

parameterName : str¶: name of the parameter

Returns:

unit of the parameter

Return type:

str

GetReferenceName()¶

Returns the reference name of the mapping.

Returns:: The reference name of the mapping
Return type:: str

GetSubMapping()¶

Returns contained Mapping or None if item does not support sub-mappings.

Returns:: Mapping with all submappings of the mapping item
Return type:: Mapping

GetSystemIdentifier()¶

Returns the system identifier providing the currently mapped test quantity

Returns:: system identifier
Return type:: str

GetTargetPath()¶

Returns the path this mapping item is currently pointing at

Returns:: complete path to the destination test quantity
Return type:: str

GetVariableType()¶

Returns the type of the target variable or None if target has no type.

Returns:: The type of the target variable. (e.g. VALUE, MATRIX, CURVE, …)
Return type:: str

IsAutogenerated()¶

Returns whether the mapping item is autogenerated.

Returns:: True, if autogenerated flag is set, else False
Return type:: boolean

SetAutogenerated(value=True)¶

Sets whether the mapping item is autogenerated.

Parameters:

value : boolean¶: The new state.

SetCategory(category)¶

Sets the category

Parameters:

category : str¶: The new category to be used

SetDescription(description)¶

Sets the description

Parameters:

description : str¶: The new description to be used

SetReferenceName(name, updateTestSteps=False)¶

Sets the reference name of the mapping.

Parameters:

name : str¶: The reference name of the mapping
updateTestSteps : bool¶: update all usages of this mapping item. Throws an error if it is used in a global mapping or if it is not yet part of a mapping space.