AnalysisJob¶

class AnalysisJob¶

Returned by

• AnalysisJobApi.CreateAnalysisJob

• AnalysisJobApi.OpenAnalysisJob

AddGenericSignal(genericSignal)¶

Adds a new generic signal.

Note:

The name of the generic signal should be unique.

Parameters:

genericSignal¶

Generic signal to add

AddRecording(recording)¶

Adds a new recording.

Note:

The name of the recordings should be unique.

Parameters:

recording¶

Recording to add

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:

AnalysisJob

GetAnalysisReference()¶

Returns the name of the trace analysis which is used.

Returns:

name of trace analysis within package (GetPackageReference())

Return type:

str

GetFilename()¶

Returns the file name of the analysis job file as absolute path, if this file was loaded or saved.

Returns:

The file name of the origin file or None

Return type:

str

GetGenericSignals()¶

Returns all generic signals with their assignments.

Returns:

Generic signals

Return type:

list[AnalysisJobGenericSignal]

GetGlobalConstants()¶

Returns the container of defined global constants.

Returns:

Container for global constants

Return type:

GlobalConstantsDefinition

GetMapping()¶

Returns the mapping of the analysis job.

Returns:

Mapping of the analysis job

Return type:

Mapping

GetPackageReference()¶

Returns the absolute Package file path in which the corresponding trace analysis exists.

Returns:

Package file path or None, if not set.

Return type:

str

GetParameter(name)¶

Retrieves the value assigned to a parameter.

Parameters:

name : string¶

Name of the parameter

Returns:

Parameter value as Python literal expression

Return type:

str

Raises:

ApiError: When parameter does not exist

GetParameters()¶

Retrieves the values assigned to template parameters.

Returns:

A dictionary of parameter name -> parameter value (Python literal expression) mappings

Return type:

dict[str, str]

GetRecordings()¶

Returns all recordings.

Returns:

Recordings

Return type:

list[AnalysisJobRecording]

GetTestConfigurationPath()¶

Returns the path to the test configuration file, absolute or relative to the ‘Configuration’ directory.

Returns:

Path to the test configuration or None

Return type:

str

RemoveGenericSignal(genericSignal)¶

Removes a generic signal.

Parameters:

genericSignal¶

Existing generic signal

RemoveParameter(name)¶

Removes the parameter specified by the given name.

Parameters:

name : str¶

Name of the parameter to remove

Raises:

ApiError: When parameter does not exist

RemoveRecording(recording)¶

Removes a recording.

Parameters:

recording¶

Existing recording.

Save(filename=None, allowCompatibilityFallback=False)¶

Saves the analysis job.

Appends file ending (.ajob) if needed.

Parameters:

filename : str¶

Absolute or relative workspace file name of the analysis job. Leave out to save the package to its origin file (previously set with Save() or from TraceAnalysisApi.OpenAnalysisJob())

allowCompatibilityFallback : bool¶

If True and a compatibility mode is active, save in the minimum compatible version when needed. If False, compatibility problems raise an exception instead.

SetAnalysisReference(analysisName)¶

Sets the trace analysis to be used by the given name.

Parameters:

analysisName : str¶

name of the trace analysis within Package (GetPackageReference())

SetGlobalConstants(value)¶

Sets the complete set of global constants.

Parameters:

value¶

new global constants

SetPackageReference(packageReference)¶

Sets the Package file path in which the corresponding trace analysis exists.

Parameters:

packageReference : str¶

Package file path absolute or relative to workspace Packages directory

SetParameter(name, valueExpression)¶

Assigns a value to a parameter.

Parameters:

name : string¶

Name of the parameter

valueExpression : str¶

Value to assign to the parameter (must be a Python literal expression, for example “‘string’”, “5”, “[1, 2]”, “None”, “True”)

Raises:

ApiError: When valueExpression is not a Python literal expression

SetParameters(parameters)¶

Assigns values to parameters.

Parameters:

parameters : dict[str, str]¶

Dictionary of parameter name -> parameter value (Python literal expression, for example “‘string’”, “5”, “[1, 2]”, “None”, “True”) mappings

Raises:

ApiError: When parameter value is not a Python literal expression

SetTestConfigurationPath(testConfiguration)¶

Sets the path to the test configuration file, absolute or relative to the ‘Configuration’ directory.

Parameters:

testConfiguration : str¶

Path to the test configuration file or None