API for Trace Analyses¶

Part of the Object based program API.

class TraceAnalysisApi¶

Returned by

• PackageApi.TraceAnalysisApi

CreateAssertion(name, description=None)¶

Creates an assertion trace step.

Parameters:

name : str¶

The name of newly created trace step

description : str¶

The description of newly created trace step

Returns:

New trace analysis assertion step

Return type:

Assertion

CreateBlock(name, description=None)¶

Creates a block.

Parameters:

name : str¶

The name of newly created trace analysis

description : str¶

The description of newly created trace step

Returns:

New block

Return type:

AnalysisBlock

CreateCalculation(name, description=None)¶

Creates a calculation trace step.

Parameters:

name : str¶

The name of newly created trace step

description : str¶

The description of newly created trace step

Returns:

New trace analysis calculation step

Return type:

Calculation

CreateEpisode(name, description=None)¶

Creates an episode.

Parameters:

name : str¶

The name of newly created episode

description : str¶

The description of newly created episode

Returns:

New trace analysis episode

Return type:

Episode

CreateGenericSignal(name, description=None)¶

Creates a generic signal to the trace analysis. The name must be python-conform!

Parameters:

name : str¶

The name of the generic signal

description : str¶

The description of newly created generic signal

Returns:

The new generic signal

Return type:

GenericSignal

CreateIfDef()¶

Creates an IfDef block.

Returns:

New trace analysis IfDef block

Return type:

IfDef

CreateIfThenElse()¶

Creates an IfThenElse block.

Returns:

New trace analysis IfThenElse block

Return type:

IfThenElse

CreatePlot(name, description=None)¶

Creates a plot.

Parameters:

name : str¶

The name of newly created plot

description : str¶

The description of newly created plot

Returns:

New trace analysis plot

Return type:

Plot

CreatePlotCalculatedSignal(expression, name='')¶

Creates a calculated plot signal to be used for a plot (PlotCalculatedSignal).

Parameters:

expression : str¶

The expression from which the signal will be calculated.

name : str¶

Display name in the plot (optional, otherwise expression string will be used).

Returns:

A calculated plot signal

Return type:

PlotCalculatedSignal

CreatePlotSignal(name, signalType='GENERIC')¶

Creates a plot signal to be used for a plot (PlotSignal).

Parameters:

name : str¶

Name of the plot signal

signalType : str¶

Type of plot signal to be mapped (GENERIC, TRACESTEP)

Returns:

A plot signal

Return type:

PlotSignal

CreateSignalRecording(name=None, description=None)¶

Creates a signal recording step.

Parameters:

name : str¶

The name of newly created signal recording

description : str¶

The description of newly created signal recording

Returns:

New trace analysis signal recording step

Return type:

SignalRecording

CreateSwitchDefCase()¶

Creates a SwitchDefCase block.

Returns:

New trace analysis SwitchDefCase block

Return type:

SwitchDefCase

CreateTemplateBasedTraceStep(name=None, description=None)¶

Creates a trace step that references a trace step template.

Note:

After creation the template reference has to be set by calling TemplateBasedTraceStep.SetTemplate()!

Parameters:

name : str¶

The name of the newly created trace step. If None, the trace step template name will be used.

description : str¶

The description of the newly created trace step

Returns:

New template based trace step

Return type:

TemplateBasedTraceStep

CreateTraceAnalysis(name, description=None)¶

Creates a trace analysis.

Parameters:

name : str¶

The name of newly created trace analysis

description : str¶

The description of newly created trace step

Returns:

New trace analysis

Return type:

TraceAnalysis

CreateTraceAnalysisReference(name, description=None)¶

Creates a reference to another trace analysis of a different package that works like an episode.

Parameters:

name : str¶

The name of newly created trace analysis reference

description : str¶

The description of newly created trace analysis reference

Returns:

New trace analysis reference

Return type:

TraceAnalysisReference

CreateTraceAnalysisReferenceFromMappingItem(mappingItem)¶

Creates a reference to another trace analysis of a different package that works like an episode, referenced in the given mappingItem.

Parameters:

mappingItem¶

The mapping item referencing the analysis package

Returns:

New trace analysis reference

Return type:

TraceAnalysisReference

CreateTriggerBlock(name, description=None)¶

Creates a trigger block.

Parameters:

name : str¶

The name of newly created trace step

description : str¶

The description of newly created trace step

Returns:

New trigger block

Return type:

TriggerBlock