Package com.piketec.tpt.api

Interface PlatformConfiguration

    • Field Detail

      • ADTF_PLATFORM_TYPE

        static final java.lang.String ADTF_PLATFORM_TYPE
        Type String for ADTF Platform
        See Also:
        Constant Field Values

      • ASCET_PLATFORM_TYPE

        static final java.lang.String ASCET_PLATFORM_TYPE
        Type String for ASCET Platform
        See Also:
        Constant Field Values

      • ASCET_AT_FUSION_PLATFORM_TYPE

        static final java.lang.String ASCET_AT_FUSION_PLATFORM_TYPE
        Type String for ASCET@FUSION Platform
        See Also:
        Constant Field Values

      • AUTOSAR_PLATFORM_TYPE

        static final java.lang.String AUTOSAR_PLATFORM_TYPE
        Type String for AUTOSAR Platform
        See Also:
        Constant Field Values

      • ASSESSMENT_PLATFORM_TYPE

        static final java.lang.String ASSESSMENT_PLATFORM_TYPE
        Type String for Assessment Platform
        See Also:
        Constant Field Values

      • BOSCH_FUSION_PLATFORM_TYPE

        static final java.lang.String BOSCH_FUSION_PLATFORM_TYPE
        See Also:
        Constant Field Values

      • CANOE_PLATFORM_TYPE

        static final java.lang.String CANOE_PLATFORM_TYPE
        Type String for CANoe Platform
        See Also:
        Constant Field Values

      • C_PLATFORM_TYPE

        static final java.lang.String C_PLATFORM_TYPE
        Type String for C Platform
        See Also:
        Constant Field Values

      • CANOE_AT_FUSION_PLATFORM_TYPE

        static final java.lang.String CANOE_AT_FUSION_PLATFORM_TYPE
        Type String for CANoe@FUSION Platform
        See Also:
        Constant Field Values

      • CTB_PLATFORM_TYPE

        static final java.lang.String CTB_PLATFORM_TYPE
        Type String for CTB Platform
        See Also:
        Constant Field Values

      • CONCURRENT_HIL_PLATFORM_TYPE

        static final java.lang.String CONCURRENT_HIL_PLATFORM_TYPE
        Type String for Concurrent HiL Platform
        See Also:
        Constant Field Values

      • EXE_PLATFORM_TYPE

        static final java.lang.String EXE_PLATFORM_TYPE
        Type String for EXE Platform
        See Also:
        Constant Field Values

      • FUSION_PLATFORM_TYPE

        static final java.lang.String FUSION_PLATFORM_TYPE
        Type String for FUSION Platform
        See Also:
        Constant Field Values

      • LABCAR_PLATFORM_TYPE

        static final java.lang.String LABCAR_PLATFORM_TYPE
        Type String for LABCAR Platform
        See Also:
        Constant Field Values

      • MATLAB_SIMULINK_PLATFORM_TYPE

        static final java.lang.String MATLAB_SIMULINK_PLATFORM_TYPE
        Type String for MATLAB/Simulink Platform
        See Also:
        Constant Field Values

      • RADARCAN_PLATFORM_TYPE

        static final java.lang.String RADARCAN_PLATFORM_TYPE
        Type String for RADARCAN Platform
        See Also:
        Constant Field Values

      • SILVER_PLATFORM_TYPE

        static final java.lang.String SILVER_PLATFORM_TYPE
        Type String for Silver Platform
        See Also:
        Constant Field Values

      • SIMULINK_REAL_TIME_PLATFORM_TYPE

        static final java.lang.String SIMULINK_REAL_TIME_PLATFORM_TYPE
        Type String for Simulink Real-Time Platform
        See Also:
        Constant Field Values

      • STAND_ALONE_PLATFORM_TYPE

        static final java.lang.String STAND_ALONE_PLATFORM_TYPE
        Type String for Stand-alone Platform
        See Also:
        Constant Field Values

      • VW_AUDI_PLATFORM_TYPE

        static final java.lang.String VW_AUDI_PLATFORM_TYPE
        Type String for VW / Audi Platform
        See Also:
        Constant Field Values

      • VERISTAND_PLATFORM_TYPE

        static final java.lang.String VERISTAND_PLATFORM_TYPE
        Type String for VeriStand Platform
        See Also:
        Constant Field Values

      • VERISTAND_AT_FUSION_PLATFORM_TYPE

        static final java.lang.String VERISTAND_AT_FUSION_PLATFORM_TYPE
        Type String for VeriStand@FUSION Platform
        See Also:
        Constant Field Values

      • DSPACE_HIL_PLATFORM_TYPE

        static final java.lang.String DSPACE_HIL_PLATFORM_TYPE
        Type String for dSPACE HiL Platform
        See Also:
        Constant Field Values

      • DSPACE_HIL_AT_FUSION_PLATFORM_TYPE

        static final java.lang.String DSPACE_HIL_AT_FUSION_PLATFORM_TYPE
        Type String for dSPACE HiL@FUSION Platform
        See Also:
        Constant Field Values

      • XIL_AT_FUSION_PLATFORM_TYPE

        static final java.lang.String XIL_AT_FUSION_PLATFORM_TYPE
        Type String for ASAM XIL@FUSION Platform
        See Also:
        Constant Field Values

      • FEP

        static final java.lang.String FEP
        Type String for dSPACE HiL@FUSION Platform
        See Also:
        Constant Field Values

    • Method Detail

      • getType

        java.lang.String getType()
                  throws ApiException,
                         java.rmi.RemoteException
        Throws:
        ApiException
        java.rmi.RemoteException

      • getTimeOut

        long getTimeOut()
         throws java.rmi.RemoteException
        Returns:
        Returns the platform timeout in microseconds.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setTimeOut

        void setTimeOut​(long timeOut)
         throws java.rmi.RemoteException
        Set the platform timeout.
        Parameters:
        timeOut - Timeout in microseconds.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • getStepSize

        long getStepSize()
          throws java.rmi.RemoteException
        Returns:
        Returns the step size of the platform in microseconds.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setStepSize

        void setStepSize​(long stepSize)
          throws java.rmi.RemoteException
        Set the step size for the platform.
        Parameters:
        stepSize - Step size in microseconds.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • getHistorySize

        int getHistorySize()
            throws java.rmi.RemoteException
        Returns:
        Returns the size of the ring buffer (history) that is used to enable access to signal values of preceding steps of a test case.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setHistorySize

        void setHistorySize​(int historySize)
             throws java.rmi.RemoteException
        Set the size of the ring buffer (history) that is used to enable access to signal values of preceding steps of a test case.
        Parameters:
        historySize - The new size of the history in steps.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • getProperties

        PropertyMap getProperties()
                   throws java.rmi.RemoteException
        Returns the properties of the platform adapter as PropertyMap.

        A PropertyMap maps the properties as follows: String -> Property. A Property is either a ProperyMap or a String value.

        The structure of the PropertyMap depends on the type of the platform adapter.
        Returns:
        A PropertyMap with the settings for the platform adapter.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setProperties

        void setProperties​(PropertyMap properties)
            throws java.rmi.RemoteException
        Set the configuration for the platform adapter via PropertyMap.

        Since an incomplete PropertyMap could lead to unpredictable behavior, it is generally recommended to modify the PropertyMap returned by getProperties().

        Parameters:
        properties - A PropertyMap for the respective platform adapter.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • invoke

        void invoke​(java.lang.String functionName,
            PropertyMap parameterOrNull)
     throws ApiException,
            java.rmi.RemoteException
        Run a function of this particular platform adapter (e.g., import-interface, ...). The available functions depend on the actual platform represented by this object. Some platforms do not have functions.

        The function is identified by its name. The PropertyMap can be used to provide additional parameters to the function.

        If the function name is unknown or if the PropertyMap does not match the expected structure, an ApiException is invoked. Often exception message contains a hint which functions are available.
        Parameters:
        functionName - Name of the function to be invoked
        parameterOrNull - A PropertyMap representing the function arguments or null
        Throws:
        java.rmi.RemoteException - remote communication problem
        ApiException - If the function is not available or the PropertyMap is invalid for the invoked function.

      • initTasmoTestDataGeneration

        TasmoTestDataGenerationController initTasmoTestDataGeneration​(Mapping mapping)
                                                       throws java.rmi.RemoteException
        Initialize the TASMO test case generation with this Platform.
        Parameters:
        mapping - The mapping containing the TASMO input specification to be used.
        Returns:
        The interface that provides access to TASMO test data generation.
        Throws:
        java.rmi.RemoteException - remote communication problem
        ApiException - If TASMO is not licensed, the plugin needed for this platform is not loaded or this platform is not supported by TASMO.

      • copy

        ResultAndLogs<PlatformConfiguration> copy​(Project target,
                                          int targetIndex)
                                   throws ApiException,
                                          java.rmi.RemoteException
        Copies this into the given target that can be a different Project that is opened in the same TPT instance. If the target already contains an element with the same name a new one will be generated.
        Parameters:
        target - The project to copy this into. Can be another Project than the one this belongs to.
        targetIndex - The index where the copy will be inserted. Use Integer.MAX_VALUE to append the copy at the end.
        Returns:
        The copy of this and all log messages that occured during copying.
        Throws:
        ApiException - If target is null or copying failed.
        java.rmi.RemoteException - remote communication problem