API for Signal Descriptions¶

Part of the Object based program API.

class SignalDescriptionApi¶

API to access signal description files

Returned by

• ApiClient.SignalDescriptionApi

SignalApi¶

Returns the SignalApi namespace.

Returns:

SignalApi namespace

Return type:

SignalApi

CreateSignalDescriptionFile()¶

Creates a new sti or stz file.

Returns:

Signal description

Return type:

SignalDescriptionFile

OpenSignalDescriptionFile(filename, upgradeLegacyFile=True)¶

Opens an existing sti or stz file.

Parameters:

filename : str¶

Name of the signal description file to open

upgradeLegacyFile : bool¶

Selects whether a sti in version 1.0 should be upgraded or if loading should be aborted. A backup copy of the original file is saved at the same location with the suffix “.bak”.

Returns:

Signal description

Return type:

SignalDescriptionFile