API for Analysis Jobs¶

Part of the Object based program API.

class AnalysisJobApi¶

Returned by

• ApiClient.AnalysisJobApi

CreateAnalysisJob()¶

Creates a new analysis job

Returns:

A newly created analysis job

Return type:

AnalysisJob

CreateGenericSignal(signalName)¶

Create a generic signal with a given name for a analysis job.

Parameters:

signalName : str¶

signal name

Returns:

newly created generic analysis job signal

Return type:

AnalysisJobGenericSignal

CreateRecording(recordingName)¶

Create a recording for a analysis job.

Parameters:

recordingName : str¶

recording name

Returns:

newly created analysis job recording

Return type:

AnalysisJobRecording

OpenAnalysisJob(filename)¶

Opens an existing analysis job

Parameters:

filename : str¶

Absolute path to the analysis job file (.ajob) or relative path in regard to the workspace directory

Returns:

Existing analysis job

Return type:

AnalysisJob