TraceStepTemplate¶

class TraceStepTemplate¶

Returned by

• TraceStepTemplateApi.OpenTraceStepTemplate

• TraceStepTemplateApi.SearchTraceStepTemplates

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:

TraceStepTemplate

GetDescription()¶

Returns the description of the trace step template.

Returns:

The Description

Return type:

str

GetName()¶

Returns the name of the trace step template.

Returns:

The name

Return type:

str

GetParameterDefaultValues()¶

Returns text representation of the default parameter values of the trace step template. Those values are applied of value None is passed to a trace step.

Returns:

The text representations of the default values of all parameters

Return type:

list[str]

GetParameterDescriptions()¶

Returns the descriptions of all parameters of a trace step template.

Returns:

The descriptions of all parameters

Return type:

list[str]

GetParameterDirections()¶

Returns the direction of all parameters of a trace step template.

Returns:

The direction of all parameters

Return type:

list[str]

GetParameterNames()¶

Returns the names of all parameters of a trace step template.

Returns:

The names of all parameters

Return type:

list[str]

GetParameterTypes()¶

Returns the types of all parameters of a trace step template.

Returns:

The types of all parameters

Return type:

list[str]

GetSignalDescriptions()¶

Returns the descriptions of all signals of a trace step template.

Returns:

The Descriptions of all signals

Return type:

list[str]

GetSignalDirections()¶

Returns the direction of all signals of a trace step template.

Returns:

The direction of all signals

Return type:

list[str]

GetSignalNames()¶

Returns the names of all signals of the trace step template.

Returns:

The Names of all signals

Return type:

list[str]

GetSignalOptionalFlags()¶

Returns the “is optional” flags of all signals of a trace step template.

Returns:

The “is optional” flags of all signals

Return type:

list[boolean]

GetType()¶

Returns the specific type of the trace step template, i.e.

• “TraceStepTemplatePythonEvent”

• “TraceStepTemplatePythonEventDeprecated”

• “TraceStepTemplatePythonStream”

• “TraceStepTemplateTimingDiagram”

• “TraceStepTemplateLogic”

• “TraceStepTemplateNumpy”

• “TraceStepTemplateInternal”

• “TraceStepTemplateMissing”

• “TraceStepTemplateBroken”

If the particular type cannot be resolved, the method will return

• “TraceStepTemplate”

Returns:

The type of the template

Return type:

str

IsBroken()¶

Returns whether the trace step template represents a broken trace step template.

Note:

This status is set initially and will not be changed if the trace step template is fixed later on. You need to close and re-open the package, obtain the trace step from the re-opened package using Package.GetTraceAnalyses, TraceStepContainer.GetTraceSteps(), etc., and call TemplateBasedTraceStep.GetTemplate() on the new instance.

Returns:

True if the trace step template is broken

Return type:

boolean

IsMissing()¶

Returns whether the trace step template represents a missing trace step template.

Note:

This status is set initially and will not be changed if the trace step template becomes available later on. You need to close and re-open the package, obtain the trace step from the re-opened package using Package.GetTraceAnalyses, TraceStepContainer.GetTraceSteps(), etc., and call TemplateBasedTraceStep.GetTemplate() on the new instance.

Returns:

True if the file of the trace step template is not found

Return type:

boolean