API for Configurations

Part of the Object based program API.

class ConfigurationApi

API to access configuration files

Returned by

ReportFilterApi

Returns the ReportFilterApi namespace.

Returns:

ReportFilterApi namespace

Return type:

ReportFilterApi

CreateTestBenchConfiguration()

Creates new test bench configuration.

Returns:

New empty test bench configuration

Return type:

TestBenchConfiguration

CreateTestConfiguration()

Creates a new test configuration.

Returns:

New empty test configuration

Return type:

TestConfiguration

GetChangesForTestBenchConfigurations(oldTestBenchConfig, newTestBenchConfig)

Get the changes that exist between two given test bench configurations.

Parameters:
oldTestBenchConfig

The old test bench configuration to compare.

newTestBenchConfig

The new test bench configuration to compare.

Returns:

The changes that exist between the two test bench configurations.

Return type:

list[Change]

GetChangesForTestConfigurations(oldTestConfig, newTestConfig)

Get the changes that exist between two given test configurations.

Parameters:
oldTestConfig

The old test configuration to compare.

newTestConfig

The new test configuration to compare.

Returns:

The changes that exist between the two test configurations.

Return type:

list[Change]

OpenTestBenchConfiguration(filename)

Opens an existing test bench configuration (*.tbc).

Parameters:
filename : str

File name of the test bench configuration file (*.tbc); Either absolute or relative to the ‘Configuration’ directory

Returns:

Loaded test bench configuration

Return type:

TestBenchConfiguration

Raises:

ApiError – If the test bench configuration file (*.tbc) does not exist.

OpenTestConfiguration(filename)

Opens an existing test configuration.

Parameters:
filename : str

File name of the test configuration file (*.tcf); Either absolute or relative to the ‘Configuration’ directory

Returns:

Loaded test configuration

Return type:

TestConfiguration

Raises:

ApiError – If the test configuration file (*.tcf) does not exist.

SearchTestBenchConfigurations(searchCriteria, useExtendedMode=False)

Searches the current workspace and library workspaces for Testbenchconfigurations matching the given search criteria.

Parameters:
searchCriteria : str

The search criteria expressed in the ecu.test filter syntax. See section “Handling” => “Filter” of the ecu.test User Documentation.

useExtendedMode : boolean

If True, extended search strings are enabled. The default is False, meaning each word in the searchCriteria will be enclosed by wildcards and mapped to the filename. (e.g. “hello world” => “Name = ‘*hello*’ and Name = ‘*world*’”)

Returns:

All matching Testbenchconfigurations. If no file matches, an emtpy list is returned.

Return type:

list[TestBenchConfiguration]

Raises:

ApiError – If the searchCriteria has an illegal syntax.

SearchTestConfigurations(searchCriteria, useExtendedMode=False)

Searches the current workspace and library workspaces for Testconfigurations matching the given search criteria.

Parameters:
searchCriteria : str

The search criteria expressed in the ecu.test filter syntax. See section “Handling” => “Filter” of the ecu.test User Documentation.

useExtendedMode : boolean

If True, extended search strings are enabled. The default is False, meaning each word in the searchCriteria will be enclosed by wildcards and mapped to the filename. (e.g. “hello world” => “Name = ‘*hello*’ and Name = ‘*world*’”)

Returns:

All matching Testconfigurations. If no file matches, an emtpy list is returned.

Return type:

list[TestConfiguration]

Raises:

ApiError – If the searchCriteria has an illegal syntax.