Package de.tracetronic.jenkins.plugins.ecutest.wrapper.com.api

Interface ComApplication

All Known Implementing Classes:
ETComClient
public interface ComApplication
Represents the ecu.test specific COMApplication API.

  • Method Details

    • start

      ComTestEnvironment start() throws ETComException
      Starts up the currently loaded test configuration and testbench configuration files.
      Returns:
      the ComTestEnvironment dispatch
      Throws:
      ETComException - in case of a COM exception

    • stop

      ComTestEnvironment stop() throws ETComException
      Stops the currently loaded test configuration and testbench configuration files.
      Returns:
      the ComTestEnvironment dispatch
      Throws:
      ETComException - in case of a COM exception

    • getTestEnvironment

      ComTestEnvironment getTestEnvironment() throws ETComException
      Returns the test environment.
      Returns:
      the ComTestEnvironment dispatch
      Throws:
      ETComException - in case of a COM exception

    • getAnalysisEnvironment

      ComAnalysisEnvironment getAnalysisEnvironment() throws ETComException
      Returns the analysis environment.
      Returns:
      the ComAnalysisEnvironment dispatch
      Throws:
      ETComException - in case of a COM exception

    • getTestManagement

      ComTestManagement getTestManagement() throws ETComException
      Returns the test management module.
      Returns:
      the ComTestEnvironment dispatch
      Throws:
      ETComException - in case of a COM exception

    • getCaches

      ComCaches getCaches() throws ETComException
      Returns the cache module.
      Returns:
      the ComCaches dispatch
      Throws:
      ETComException - in case of a COM exception

    • isApplicationRunning

      boolean isApplicationRunning() throws ETComException
      Checks if the application process is running and ready to use.
      Returns:
      true if application is already running, false otherwise
      Throws:
      ETComException - in case of a COM exception

    • getVersion

      String getVersion() throws ETComException
      Queries the COM-Application version.
      Returns:
      the version string
      Throws:
      ETComException - in case of a COM exception

    • getSetting

      String getSetting(String settingName) throws ETComException
      Queries the COM-Application setting value by name. Possible setting names are:
      • configPath
      • errorLogFile
      • generatorPath
      • language
      • logFile
      • packagePath
      • reportPath
      • templatePath
      • parameterPath
      • traceStepPath
      • userPyModulesPath
      • utilityPath
      • workspacePath
      • offlineModelPath
      • offlineSgbdPath
      • offlineFiuPath
      • settingsPath
      Parameters:
      settingName - the setting name
      Returns:
      the setting value or null if not defined
      Throws:
      ETComException - in case of a COM exception

    • getLoadedPatches

      List<String> getLoadedPatches() throws ETComException
      Queries the list of loaded patches of the COM-Application.
      Returns:
      the list of loaded patches
      Throws:
      ETComException - in case of a COM exception

    • quit

      boolean quit(int timeout) throws ETComException
      Exits the currently running instance of the application (Soft Exit). The optional timeout parameter was introduced with ecu.test 8.0.
      Parameters:
      timeout - the timeout in seconds before giving up to wait for application shutdown and raising an exception
      Returns:
      true if successful
      Throws:
      ETComException - in case of a COM exception

    • exit

      boolean exit(int timeout) throws ETComException
      Exits the currently running instance of the application (Hard Exit), prefer quit(int) instead. The optional timeout parameter was introduced with ecu.test 8.0.
      Parameters:
      timeout - the timeout in seconds before giving up to wait for application shutdown and raising an exception
      Returns:
      true if successful
      Throws:
      ETComException - in case of a COM exception

    • openPackage

      ComPackage openPackage(String path) throws ETComException
      Opens an existing package in COM-Application.
      Parameters:
      path - the full path name of the package to open
      Returns:
      the ComPackage dispatch, if the package is successfully opened, null otherwise
      Throws:
      ETComException - in case of a COM exception

    • closePackage

      boolean closePackage(String path) throws ETComException
      Closes a package.
      Parameters:
      path - the full path name of the package to close
      Returns:
      true if the package was closed, false otherwise
      Throws:
      ETComException - in case of a COM exception

    • openProject

      ComProject openProject(String path, boolean execInCurrentPkgDir, String filterExpression) throws ETComException
      Opens an existing project in COM-Application.
      Parameters:
      path - the full path name of the project to open
      execInCurrentPkgDir - defines whether relative references in the project are resolved starting from the current workspaces package directory or from the project file location
      filterExpression - a valid filter expression (see the main help document, section 'Projects')
      Returns:
      the ComProject dispatch, if the project is successfully opened, null otherwise
      Throws:
      ETComException - in case of a COM exception

    • closeProject

      boolean closeProject(String path) throws ETComException
      Closes a project.
      Parameters:
      path - the full path name of the project to close
      Returns:
      true if the project was closed, false otherwise
      Throws:
      ETComException - in case of a COM exception

    • importProject

      boolean importProject(String path, String importPath, String importConfigPath, boolean replaceFiles) throws ETComException
      Imports a project from an archive.
      Parameters:
      path - the full path name of the project to import
      importPath - the full path name or a relative directory to the default package directory as the projects/packages destination directory
      importConfigPath - the full path name or a relative directory to the default configuration directory as the configurations destination directory
      replaceFiles - specifies whether files of same name should be replaced or left untouched
      Returns:
      the ComPackage dispatch, if the project was successfully imported, null otherwise
      Throws:
      ETComException - in case of a COM exception

    • openTestbenchConfiguration

      boolean openTestbenchConfiguration(String path) throws ETComException
      Opens a test bench configuration file (*.tbc).
      Parameters:
      path - the full path name of the test bench configuration file to open
      Returns:
      true if the configuration was successfully opened, false otherwise
      Throws:
      ETComException - in case of a COM exception

    • openTestConfiguration

      boolean openTestConfiguration(String path) throws ETComException
      Opens a test configuration file (*.tcf).
      Parameters:
      path - the full path name of the test configuration file to open
      Returns:
      true if the configuration was successfully opened, false otherwise
      Throws:
      ETComException - in case of a COM exception

    • getCurrentTestConfiguration

      ComTestConfiguration getCurrentTestConfiguration() throws ETComException
      Provides access to settings of the currently active test configuration file.
      Returns:
      the ComTestConfiguration dispatch
      Throws:
      ETComException - in case of a COM exception

    • getCurrentTestBenchConfiguration

      ComTestBenchConfiguration getCurrentTestBenchConfiguration() throws ETComException
      Provides access to settings of the currently active test bench configuration file.
      Returns:
      the ComTestBenchConfiguration dispatch
      Throws:
      ETComException - in case of a COM exception

    • isStarted

      boolean isStarted() throws ETComException
      Returns whether the currently selected test configuration and testbench configuration are started.
      Returns:
      true if configurations are started, false otherwise
      Throws:
      ETComException - in case of a COM exception

    • waitForIdle

      boolean waitForIdle(int timeout) throws ETComException
      Waits until the job count in the task manager reaches zero. The timeout parameter specifies the maximum waiting time in seconds.
      Parameters:
      timeout - the timeout in seconds
      Returns:
      true if a job count of zero was reached within the timeout
      Throws:
      ETComException - in case of a COM exception

    • updateUserLibraries

      boolean updateUserLibraries() throws ETComException
      Update all user libraries. Only possible if neither a test nor the analysis is running.
      Returns:
      true if success, false otherwise
      Throws:
      ETComException - in case of a COM exception