Interface DSpacePiLConfiguration

    • Method Detail

      • synchronizeFromReference

        void synchronizeFromReference()
                               throws java.rmi.RemoteException,
                                      ApiException
        Automatically applies all the settings from the referenced MATLAB Platform. See setMatlabSyncPlatform(MatlabPlatformConfiguration) to specify the reference MATLAB Platform
        Throws:
        java.rmi.RemoteException - remote communication problem
        ApiException - if settings are missing or the reference Platform was not set.
      • getWorkingDirectory

        java.lang.String getWorkingDirectory()
                                      throws java.rmi.RemoteException
        Gets the current Working directory, by default the working directory is set to .pilData
        Returns:
        the current Working directory
        Throws:
        java.rmi.RemoteException - remote communication problem
      • setWorkingDirectory

        void setWorkingDirectory​(java.lang.String workingDirectory)
                          throws java.rmi.RemoteException
        Sets the Working directory
        Parameters:
        workingDirectory - the Working directory to be used
        Throws:
        java.rmi.RemoteException - remote communication problem
      • getMatlabSyncPlatform

        MatlabPlatformConfiguration getMatlabSyncPlatform()
                                                   throws java.rmi.RemoteException
        Gets the currently selected Matlab/Simulink reference configuration
        Returns:
        the currently selected Matlab/Simulink configuration
        Throws:
        java.rmi.RemoteException - remote communication problem
      • setMatlabSyncPlatform

        void setMatlabSyncPlatform​(MatlabPlatformConfiguration configuration)
                            throws java.rmi.RemoteException,
                                   ApiException
        Sets the MATLAB/Simulink reference configuration
        Parameters:
        configuration - the MATLAB/Simulink configuration to be selected, must not be null
        Throws:
        java.rmi.RemoteException - remote communication problem
        ApiException - if the configuration is not part of the current project
      • getTargetLinkVersion

        java.lang.String getTargetLinkVersion()
                                       throws java.rmi.RemoteException
        Gets the TargetLink version
        Returns:
        the current TargetLink version
        Throws:
        java.rmi.RemoteException - remote communication problem
      • setTargetLinkVersion

        void setTargetLinkVersion​(java.lang.String targetLinkVersion)
                           throws java.rmi.RemoteException
        Sets the TargetLink version
        Parameters:
        targetLinkVersion - the TargetLink version to be used
        Throws:
        java.rmi.RemoteException - remote communication problem
      • getBoardName

        java.lang.String getBoardName()
                               throws java.rmi.RemoteException
        Gets the TargetLink name of the target PiL board or simulator
        Returns:
        the current board name
        Throws:
        java.rmi.RemoteException - remote communication problem
      • setBoardName

        void setBoardName​(java.lang.String boardName)
                   throws java.rmi.RemoteException
        Sets the TargetLink name of the target PiL board or simulator
        Parameters:
        boardName - the board name to be used
        Throws:
        java.rmi.RemoteException - remote communication problem
      • getTargetLinkSimulationHandlerDirPath

        java.lang.String getTargetLinkSimulationHandlerDirPath()
                                                        throws java.rmi.RemoteException
        Gets the directory of the TargetLink simulation handler, i.e. the binary 'TLLoader.exe' of the dSPACE TargetLink installation
        Returns:
        the current TargetLink simulation handler directory
        Throws:
        java.rmi.RemoteException - remote communication problem
      • setTargetLinkSimulationHandlerDirPath

        void setTargetLinkSimulationHandlerDirPath​(java.lang.String targetLinkSimulationHandlerDir)
                                            throws java.rmi.RemoteException
        Sets the directory of the TargetLink simulation handler, i.e. the binary 'TLLoader.exe' of the dSPACE TargetLink installation
        Parameters:
        targetLinkSimulationHandlerDir - the TargetLink simulation handler directory to be used
        Throws:
        java.rmi.RemoteException - remote communication problem
      • getBoardConfigurationFilePath

        java.lang.String getBoardConfigurationFilePath()
                                                throws java.rmi.RemoteException
        Gets the XML configuration file path for the TargetLink simulation module which specifies the simulation and communication server
        Returns:
        the current board configuration file path
        Throws:
        java.rmi.RemoteException - remote communication problem
      • setBoardConfigurationFilePath

        void setBoardConfigurationFilePath​(java.lang.String boardConfigurationFile)
                                    throws java.rmi.RemoteException
        Sets the XML configuration file path for the TargetLink simulation module which specifies the simulation and communication server
        Parameters:
        boardConfigurationFile - the TargetLink board configuration file path to be used
        Throws:
        java.rmi.RemoteException - remote communication problem
      • getUserConfigurationFilePath

        java.lang.String getUserConfigurationFilePath()
                                               throws java.rmi.RemoteException
        Gets the XML configuration file path for the TargetLink simulation module which specifies the target simulator
        Returns:
        the current configuration file path
        Throws:
        java.rmi.RemoteException - remote communication problem
      • setUserConfigurationFilePath

        void setUserConfigurationFilePath​(java.lang.String userConfigurationFile)
                                   throws java.rmi.RemoteException
        Sets the XML configuration file path for the TargetLink simulation module which specifies the target simulator
        Parameters:
        userConfigurationFile - the configuration file path to be used
        Throws:
        java.rmi.RemoteException - remote communication problem
      • getTargetApplicationFilePath

        java.lang.String getTargetApplicationFilePath()
                                               throws java.rmi.RemoteException
        Gets the target application file path to be used as system under test (SUT)
        Returns:
        the current target application file path
        Throws:
        java.rmi.RemoteException - remote communication problem
      • setTargetApplicationFilePath

        void setTargetApplicationFilePath​(java.lang.String targetApplicationFile)
                                   throws java.rmi.RemoteException
        Sets the target application file path which will be used as system under test (SUT)
        Parameters:
        targetApplicationFile - the target application file path to be used
        Throws:
        java.rmi.RemoteException - remote communication problem