TemplateBasedTraceStep

class TemplateBasedTraceStep

Returned by

AddTag(tag)

Add a specific tag to this step.

Parameters:
tag : str

The tag to be set

AppendTraceStep(traceStep)

Adds a trace step at the end of its children.

Parameters:
traceStep

Trace step to be added

AssignGenericSignal(sigName, genSig)

Bind a generic signal to a signal of the trace step.

Note:

It is not valid to assign a generic signal to multiple trace step signals!

Parameters:
sigName : str

Name if trace step signal

genSig

The generic signal object

Returns:

An object representing the signal binding. If a there is already a signal binding for sigName, the signal binding object an its settings will be reused; otherwise, a new signal binding object will be created.

Return type:

SignalBinding

AssignGenericSignalByName(sigName, genSigName)

Bind a generic signal to a signal of the trace step.

Note:

It is not valid to assign a generic signal to multiple trace step signals!

Parameters:
sigName : str

Name of trace step signal

genSigName : str

Name of the generic signal

Returns:

An object representing the signal binding. If there is already a signal binding for sigName, the signal binding object and its settings will be reused; otherwise, a new signal binding object will be created.

Return type:

SignalBinding

ClearSignalBinding(sigName)

Clears the signal binding for the given signal name.

Parameters:
sigName : str

The signal name

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:

TemplateBasedTraceStep

GetAbsolutePath()

Returns the absolute path of the referenced file.

Returns:

absolute path or None if the path reference cannot be resolved

Return type:

str

GetDescription()

Returns the description of the trace analysis element.

Returns:

The description

Return type:

str

GetIndex()

Returns the zero based index in the parent.

Returns:

Zero based index

Return type:

int

GetLineNo()

Returns the trace steps line number within its trace analysis.

Returns:

Line number

Return type:

int

GetName()

Returns the name of the trace analysis element.

Returns:

The name

Return type:

str

GetParameter(paramName)

Retrieves the expression assigned to a template parameter.

Parameters:
paramName : string

Name of the parameter

Returns:

Expression assigned to the parameter

Return type:

string

GetParameters()

Retrieves the expressions assigned to template parameters.

Returns:

A dictionary of parameter name -> parameter value (expression) mappings

Return type:

dict[str, str]

GetReferenceExpression()

Returns the expression of the reference.

Returns:

The expression as a string.

Return type:

str

GetReportConfig()

Returns the report config for this trace step.

Returns:

The report config object

Return type:

ReportConfig

GetSignalBinding(sigName)

Get the signal binding for a signal.

Parameters:
sigName : str

Name of trace step signal

Return type:

SignalBinding

Returns:

An object representing the signal binding. None if there is no generic signal bound.

GetSignalBindings()

Get all signal bindings.

Returns:

A dictionary of mappings: input signal name -> generic signal object

Return type:

dict[str, SignalBinding]

GetTags()

Returns the tags set for this step.

Returns:

A (sorted) list of tags

Return type:

list[str]

GetTemplate()

Returns the assigned trace step template.

Note:

Use TraceStepTemplate.IsMissing() to check whether the trace step template file was found and loaded.

Returns:

A trace step template object.

Return type:

TraceStepTemplate

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

IsVisible()

Checks whether the trace step is visible. This depends on the trace step itself or a parent trace step being disabled.

Returns:

True if trace step is visible, else False

Return type:

boolean

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

SetParameter(paramName, paramValue)

Assigns a value to a template parameter.

Parameters:
paramName : string

Name of the parameter

paramValue : string

Value to assign to the parameter (can be an expression)

SetParameters(paramDict)

Assigns values to template parameters.

Parameters:
paramDict : dict[str, str]

Dictionary of parameter name -> parameter value (expression) mappings

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

SetTemplate(template, allowInvalid=False)

Sets the referenced trace step template via object.

Parameters:
template

The trace step template object to reference

allowInvalid : bool

If True no exception is thrown when setting a missing or broken template

SetTemplateByReference(templatePath, libraryNamespace=None)

Sets the referenced trace step template via reference.

Parameters:
templatePath : str

relativ Path of the trace step template

libraryNamespace : str

namespace of the workspace library