TraceAnalysisReferenceDeprecated¶
- class TraceAnalysisReferenceDeprecated¶
-
- AssignGenericSignal(direction, sigName, genSig)¶
Bind a generic signal to a signal of the referenced trace analysis.
- Parameters:
- 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:
- AssignGenericSignalByName(direction, sigName, genSigName)¶
Bind a generic signal to a signal of the referenced trace analysis.
- Parameters:
- 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:
- 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:
- 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
- GetPackagePath()¶
Returns the path to the referenced package.
- Note:
May throw an exception if the expression of the path cannot be resolved. In that case, try using
GetPackagePathExpression().- Returns:
The package path. Returns None if no path is set.
- Return type:
str
- GetPackagePathExpression()¶
Returns the expression representing the path of the referenced package.
- Returns:
The expression representing the package path. Returns None if no path is set.
- Return type:
str
- GetParameter(paramName)¶
Retrieves the expression assigned to a package parameter.
- Parameters:
- paramName : str¶
Name of the parameter
- Returns:
Expression assigned to the parameter
- Return type:
str
- GetParameterNames()¶
Returns the names of the parameters that can be configured for the referenced trace analysis.
- Returns:
The list of valid parameter names
- Return type:
list[str]
- GetParameters()¶
Retrieves all package parameters with its expressions.
- Returns:
Dictionary with expressions assigned to the parameters
- Return type:
dict[str, str]
- GetPkgParameters()¶
Returns a list of the incoming parameter names located in the referenced package.
- Returns:
The parameter names
- Return type:
list[str]
- GetPkgReturns()¶
Returns a list of the outgoing parameters located in the referenced package.
- Returns:
The return names
- Return type:
list[str]
- GetPkgTraceAnalyses()¶
Returns a list of the trace analysis names located in the referenced package.
- Returns:
The names of the trace analyses
- Return type:
list[str]
- GetReturn(varInternal)¶
Retrieves the variable name assigned to a package return value.
- Parameters:
- varInternal : str¶
Name of the return variable in the called package
- Returns:
Assigned variable of the calling package. Empty string if there is not any variable assigned.
- Return type:
str
- GetReturns()¶
Retrieves the return value assignments.
- Returns:
Assigned variables of the calling package
- Return type:
dict[str, str]
- GetSignalBinding(direction, sigName)¶
Get the signal binding for a signal.
- Parameters:
- Return type:
- Returns:
An object representing the signal binding.
- GetTags()¶
Returns the tags set for this step.
- Returns:
A (sorted) list of tags
- Return type:
list[str]
- GetTraceAnalysisName()¶
Returns the name of the referenced trace analysis.
- Return type:
str
- Returns:
The name of the referenced trace analysis
- 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
- 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
- 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
- SetPackagePath(packagePath)¶
Sets the package path.
- Note:
Signal bindings will be synchronized. Deprecated bindings will be deleted.
- Parameters:
- packagePath : str¶
The package path
- SetParameter(paramName, paramValue)¶
Assigns a value to a package parameter.
- SetParameters(paramDict)¶
Assigns values to package parameters.
- Parameters:
- paramDict : dict[str, str]¶
Dictionary of parameter name -> parameter value (expression) mappings
- SetReturn(varInternal, varExternal)¶
Assigns a return value to a variable.
- SetReturns(returnDict)¶
Assigns package return values to variables.
- Parameters:
- returnDict : dict[str, str]¶
Dictionary of return variable -> variable of the calling package mappings