AnalysisJobGenericSignal

class AnalysisJobGenericSignal

Returned by

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:

AnalysisJobGenericSignal

GetMappingName()

Returns the name of the mapping item of the recoding assigned to the generic signal.

Returns:

mapping name assigned to this signal, which is used to resolve the real signal.

Return type:

str

GetName()

Returns the name of the generic signal.

Returns:

name of generic signal

Return type:

str

GetRecording(analysisJob)

Get assigned recording from analysis job.

Note:

Do not use in the context of a analysis package (*.ta)

Parameters:
analysisJob

analysis job from which the assigned recording should be extracted.

Returns:

recording from analysis job which is assigned to the signal

Return type:

AnalysisJobRecording

SetMappingName(mappingName)

Sets mapping name, which should be used to resolve the signal.

Parameters:
mappingName : str

name of an existing mapping.

SetRecording(recording)

Set reference to recording which the signal will use.

Note:

Do not use in the context of a analysis package (*.ta)

Parameters:
recording

recording or None, when signal should be resolved only from the mapping item name. In the last case the mapping name must be unique in the analysis job.