MeasureMappingItem¶

class MeasureMappingItem¶

Returned by

MappingApi.CreateMeasurementMappingItem

AllowOtherRaster(forceRaster)¶

Set that the registration of the raster should be enforced

Parameters:

forceRaster : bool¶: Set if the specified raster should be enforced or not

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

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

GetRaster()¶

Returns the raster of the mapping item.

Returns:: Raster
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

IsOtherRasterAllowed()¶

Returns if the registration of the raster should be enforced

Returns:: Name of selected raster
Return type:: bool

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

SetRaster(rasterName)¶

Sets the enumeration of the mapping item.

Parameters:

rasterName : str¶: Raster to be set

Returns:

True if the raster has changed, else False

Return type:

bool

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.