Custom GUI for parameters¶

ParameterPanel¶

class traceAnalysisAPI.ParameterPanel¶

Interface to be implemented by a custom parameterization GUI panel. The panel must inherit from wx.Panel or any sub class.

__init__(parent)¶

Parameters:

parent : wx.Window¶

The parent window

SetupParams(traceStepData)¶

Fill your custom GUI with information of the trace step.

Parameters:

traceStepData¶

Interface to the trace step data like parameters and signals.

OnOk()¶

This method is called if the user clicks the OK button of the trace step dialog. Check the user input here.

Returns:

Returns True if user input is OK and the dialog can be closed, else False.

Return type:

bool

StoreParams(traceStepData)¶

Collect the information of your custom GUI and update the parameterization accordingly via TraceStepDataAPI.SetParameterValue()

Parameters:

traceStepData¶

Interface to the trace step data like parameters and signals.

TraceStepDataAPI¶

class traceAnalysisAPI.TraceStepDataAPI¶

The TraceStepDataAPI provides functions to access information about parameters and signals of a trace step and it’s underlying trace step prototype. The API allows changing values of parameters as well. It is used to develop a custom user interface for trace steps.

GetSignalNames()¶

Returns a list of signal names used in the trace step.

Return type:

list[str]

GetSignalDescription(sigName)¶

Returns the description for a given signal.

Parameters:

sigName : str¶

The name of the desired signal.

Return type:

str

GetSignalDirection(sigName)¶

Returns the direction for a given signal.

Parameters:

sigName : str¶

The name of the desired signal.

Returns:

IN or OUT

Return type:

str

GetParameterNames()¶

Returns a list of parameter names used in the trace step.

Return type:

list[str]

GetParameterDescription(paramName)¶

Returns the description for a given parameter.

Parameters:

paramName : str¶

the name of the desired parameter

Return type:

str

GetParameterType(paramName)¶

Returns the type for a given parameter.

Parameters:

paramName : str¶

The name of the desired parameter.

Returns:

INTEGER, FLOAT, STRING, BOOLEAN, PYOBJECT

Return type:

str

GetParameterValue(paramName)¶

Returns the current value for a given parameter.

Parameters:

paramName : str¶

The name of the desired parameter.

Return type:

Value or None

SetParameterValue(paramName, value)¶

Sets a new value for a given parameter. Values can only be assigned to parameters with direction IN.

Parameters:

paramName : str¶

The name of the desired parameter.

value : str|int|float|bool¶

The new parameter value.

Returns:

True on success, otherwise False

Return type:

bool

Raises:

• TypeError – Invalid type for parameter value.

• ValueError – Invalid assignment to OUT parameter.