SignalDescriptionFile¶

class SignalDescriptionFile¶

Returned by

• SignalDescriptionApi.CreateSignalDescriptionFile

• SignalDescriptionApi.OpenSignalDescriptionFile

AppendInputSignal(signalName)¶

Append an input signal.

Parameters:

signalName : str¶

The input signal name

AppendSignal(signal)¶

Append a signal description as last element.

Parameters:

signal¶

Signal description

ClearInputSignals()¶

Clear the input signals defined in the description file.

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:

SignalDescriptionFile

Close()¶

Closes the signal description. After closing the file it can not be modified/accessed anymore.

ConvertToMat(destinationPath, sampleRate=100, signalList=None)¶

Converts the signals in the description file to a new MAT file

Parameters:

destinationPath : str¶

Absolute path to store MAT file

sampleRate : integer¶

Number of samples per second

signalList : list[str]¶

Signal names to be exported or None to export all signals

GetAllSignalNames()¶

Returns a list of names of all signals defined in the description file

Returns:

Signal names

Return type:

list[str]

GetAllSignals()¶

Returns a list of all signals defined in the description file

Returns:

Signals

Return type:

list[SignalDescription]

GetInputSignals()¶

Returns a list of all input signals defined in the description file.

Returns:

The input signal names

Return type:

list[str]

GetParameterComment(parameterName)¶

Returns the description of a parameter.

Parameters:

parameterName : str¶

The name of the parameter

Returns:

The description of the parameter

Return type:

str

GetParameterNames()¶

Returns an alphabetically sorted list of parameter names that are specified in this file.

Returns:

List of parameter names

Return type:

list[str]

GetParameterValue(parameterName)¶

Returns the default value of a parameter.

Parameters:

parameterName : str¶

The name of the parameter

Returns:

The default value of the parameter

Return type:

float

RemoveInputSignal(signalName)¶

Remove an input signal.

Parameters:

signalName : str¶

The input signal name

RemoveParameter(parameterName)¶

Removes a parameter from the signal description file.

Parameters:

parameterName : str¶

The name of the parameter that shall be removed

RemoveSignal(signal)¶

Remove a signal description.

Parameters:

signal¶

Signal description

SaveSti(destinationPath, version='2.1', absFileReference=False)¶

Stores the current signal description to a sti file.

Parameters:

destinationPath : str¶

Absolute path to store STI file

version : str¶

STI Version with which the stimulation file should be saved

absFileReference : bool¶

STI file is created with absolute file references

SaveStz(destinationPath, version='2.1')¶

Stores the current signal description to a stz file. The stz will also contain all referenced signal descriptions

Parameters:

destinationPath : str¶

Absolute path to store STZ file

version : str¶

STZ Version with which the stimulation file should be saved

SetParameter(parameterName, defaultValue, comment='')¶

Adds a new parameter to the signal description file. If a parameter with this name already exists, the defaultValue and comment will be overwritten.

Parameters:

parameterName : str¶

The name of the parameter

defaultValue : float¶

The default value of the parameter

comment : str¶

Description of the parameter