MappingFiles¶
- class MappingFiles¶
- AddMappingArtifactReference(mappingReference)¶
Adds an artifact reference to a mapping file to the list.
- Parameters:
- mappingReference¶
Artifact reference to a mapping file
-
AddMappingFile(filePath, namespace=
None)¶ Adds a mapping file to the list.
- Parameters:
- filePath : str¶
Path to the mapping file (absolute or relative to parameter directory)
- namespace : str¶
Identifier of the workspace to which a relative filePath is resolved. If not present or None, the namespace is determined automatically. It is also possible to reference a library workspace using its namespace. A relative filePath is resolved relative to the parameters directory of the given namespace. For example, the namespace parameter ‘myLibrary’ results in ‘<libraries.myLibrary.parameters>/MyMapping.xam’.
- ClearMappingFiles()¶
Clears all entries from the mapping file list.
- 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:
- GetMappingArtifactReferences()¶
Returns artifact references to mapping files.
- Returns:
A list of all artifact references
- Return type:
list[
ArtifactReference]
- RemoveMappingArtifactReference(mappingReference)¶
Removes an artifact reference to a mapping file from the list.
- Parameters:
- mappingReference¶
Artifact reference to a mapping file
- RemoveMappingFile(index)¶
Removes a mapping file from the list.
- Parameters:
- index : int¶
The index of the mapping file to remove
- GetMappingFiles()¶
Returns the mapping file paths, relative to the workspace directory.
- Returns:
A list of all mapping files
- Return type:
list[str]
Deprecated since version 2024.2: Use
GetMappingArtifactReferences()instead