ReportAnalysisJob¶

class ReportAnalysisJob¶

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

ExportAnalysisJob(path)¶

Writes deposited analysis job as an ajob-file for downstream analysis.

Parameters:

path : str¶: Path where ajob-file is written to. Must include the file extension “.ajob”.

GetAllEpisodes()¶

Returns all episodes of the analysis job regardless of the position in the report.

Returns:: List of trace step results
Return type:: list[ReportAnalysisEpisode]

GetDuration()¶

Returns the execution duration.

Returns:: Execution duration in seconds
Return type:: float

GetName()¶

Returns the name of the analysis job.

Returns:: name of the analysis job
Return type:: str

GetOriginalResult()¶

Returns the result verdict of the analysis job.

Returns:: the result verdict
Return type:: str

GetRecordingInfos()¶

Returns an object encapsulating the recording info of the analysis job.

Returns:: The recording info table
Return type:: list[ReportRecordingInfo]

GetResult()¶

Returns the result verdict of the analysis job.

Returns:: the result verdict
Return type:: str

GetStimulationPackage()¶

This call is only valid for analysis jobs derived from analysis packages and returns the invoked stimulation package. For parameterized stimulations, the resulting package object characterizes a particular parameter set.

Returns:: stimulation package
Return type:: ReportPackage

GetTraceAnalysis()¶

Returns the root element ‘trace analysis’ (report item) of the analysis job.

Returns:: Root element of job or None if trace analysis was not executed.
Return type:: ReportAnalysisStep

GetTraceSteps(recursive=False)¶

Returns direct/all children trace steps of the trace analysis.

Parameters:

recursive : boolean¶: Defines whether children of children are included, defaults to False.

Returns:

List of trace step results. If the analysis has not been executed, an empty list will be returned.

Return type:

list[ReportAnalysisStep]

IsDownstream()¶

Returns whether the analysis job was created as a downstream analysis. If so, it was not processed within the project execution. Instead, is has to be executed afterwards.

Note:: A downstream analysis has the default result NONE instead of INCONCLUSIVE.
Returns:: True, if the analysis job was created as downstream analysis.
Return type:: bool