TraceAnalysis

class TraceAnalysis

Returned by

AddTag(tag)

Add a specific tag to this step.

Parameters:
tag : str

The tag to be set

AppendGenericSignal(genericSignal)

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

Parameters:
genericSignal

The generic signal to be appended

AppendTraceStep(traceStep)

Adds a trace step at the end of its children.

Parameters:
traceStep

Trace step to be added

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:

TraceAnalysis

ExportToAnalysisPackage(filename)

Exports this trace analysis to an analysis package. The analysis package will not take over any synchronization configuration and all signal bindings will be adjusted to rely on generic mappings.

Parameters:
filename : str

Filename of the analysis package to be saved

GetConditionalGenericSignals()

Returns the list of signals that can be optional or mandatory for running the trace analysis depending on the values of global constants.

Returns:

The list of undetermined signals.

Return type:

list[GenericSignal]

GetDescription()

Returns the description of the trace analysis element.

Returns:

The description

Return type:

str

GetGenericSignal(name)

Returns the generic signal of given name.

Parameters:
name : str

The name of the generic signal

Returns:

A generic signal

Return type:

GenericSignal

GetGenericSignals()

Returns all generic signal.

Returns:

The list of generic signals

Return type:

list[GenericSignal]

GetMandatoryGenericSignals()

Returns the list of signals that are mandatory for running the trace analysis.

Returns:

The list of mandatory signals.

Return type:

list[GenericSignal]

GetName()

Returns the name of the trace analysis element.

Returns:

The name

Return type:

str

GetOptionalGenericSignals()

Returns the list of signals that are optional for running the trace analysis.

Returns:

The list of optional signals.

Return type:

list[GenericSignal]

GetReferencedTraceStepTemplates()

Returns a list with all referenced trace step templates.

Returns:

A list of the referenced trace step templates

Return type:

list[str]

GetTags()

Returns the tags set for this step.

Returns:

A (sorted) list of tags

Return type:

list[str]

GetTraceSteps(skipDisabledSteps=False, recursive=False)

Returns either direct or all children of the trace step.

Parameters:
skipDisabledSteps : boolean

Defines whether disabled trace steps should be excluded, defaults to False.

recursive : boolean

Defines whether children of children are included, defaults to False.

Returns:

The trace steps as flat list.

Return type:

list[TraceStep]

GetType()

Returns the type (class name) of the trace step, e.g.

  • ‘Episode’

  • ‘AnalysisBlock’

  • ‘TriggerBlock’

  • ‘Calculation’

  • ‘TemplateBasedTraceStep’

  • ‘TraceAnalysisReference’

  • ‘TraceAnalysisReferenceDeprecated’

Returns:

Type (class name) of the trace step

Return type:

str

GetUuid()

Returns the UUID of the trace step.

Returns:

UUID of the trace step

Return type:

str

InsertTraceStep(traceStep, position)

Adds a trace step at a certain line of the trace analysis.

Parameters:
traceStep

Trace step to be added

position : integer

Target index of child beginning with 0

IsContainer()

Checks whether this trace step can contain trace steps.

Returns:

True if it can contain trace steps, else False

Return type:

boolean

IsEnabled()

Checks whether the trace step is enabled.

Returns:

True if trace step is enabled, else False

Return type:

boolean

IsOk()

Returns the internal state of correctness of the trace step.

Returns:

True if no problems were found, else False

Return type:

boolean

RemoveGenericSignal(name)

Removes a generic signal from the trace analysis.

Parameters:
name : str

The name of the generic signal

RemoveTag(tag)

Remove a specific tag from this step.

Parameters:
tag : str

The tag to be removed

RemoveTraceStep(traceStep)

Removes the given trace step from the trace analysis.

Parameters:
traceStep

Trace step to be removed

SetDescription(value)

Sets the description of the trace analysis element.

Parameters:
value : str

The new description

SetEnabled(enable)

Enables or disables the trace step (this also affects child trace steps).

Parameters:
enable : boolean

If True, enables the trace step, if False, disables the trace step

SetName(value)

Sets the name of the trace analysis element.

Parameters:
value : str

The new name

SetTags(tags)

Set the list of tags for this step. The list of tags will be sorted and stored.

Parameters:
tags : list[str]

The list of tags