Package com.piketec.tpt.api.matlabplatform

Interface MatlabPlatformConfiguration

All Superinterfaces:

IdentifiableRemote, NamedObject, PlatformConfiguration, PlatformOrExecutionItemEnabler, java.rmi.Remote, TptRemote

public interface MatlabPlatformConfiguration
extends PlatformConfiguration

The TPT API representation of the MATLAB/Simulink platform in TPT

Author:

Copyright (c) 2014-2024 Piketec GmbH - MIT License (MIT) - All rights reserved

Field Summary

Fields inherited from interface com.piketec.tpt.api.PlatformConfiguration

ADTF_PLATFORM_TYPE, ARDUINO_FUSION_PLATFORM_TYPE, ASCET_AT_FUSION_PLATFORM_TYPE, ASCET_PLATFORM_TYPE, ASSESSMENT_PLATFORM_TYPE, AUTOSAR_FUSION_PLATFORM_TYPE, AUTOSAR_PLATFORM_TYPE, BOSCH_FUSION_PLATFORM_TYPE, C_PLATFORM_TYPE, CANAPE_FUSION_PLATFORM_TYPE, CANOE_AT_FUSION_PLATFORM_TYPE, CANOE_PLATFORM_TYPE, CARMAKER_FMU_FUSION_PLATFORM_TYPE, CONCURRENT_HIL_PLATFORM_TYPE, CTB_PLATFORM_TYPE, DIAGRAD_FUSION_PLATFORM_TYPE, DSPACE_HIL_AT_FUSION_PLATFORM_TYPE, DSPACE_HIL_PLATFORM_TYPE, DSPACE_PIL_PLATFORM_TYPE, EXE_PLATFORM_TYPE, FEP_PLATFORM_TYPE, FMI_FUSION_PLATFORM_TYPE, FUSION_PLATFORM_TYPE, GDB_FUSION_PLATFORM_TYPE, INCA_FUSION_PLATFORM_TYPE, LABCAR_PLATFORM_TYPE, LAUTERBACH_FUSION_PLATFORM_TYPE, MATLAB_SIMULINK_PLATFORM_TYPE, PEAK_CAN_FUSION_PLATFORM_TYPE, PLS_UDE_FUSION_PLATFORM_TYPE, RADARCAN_PLATFORM_TYPE, REALTIMEMAKER_PLATFORM_TYPE, RTLAB_FUSION_PLATFORM_TYPE, SILVER_PLATFORM_TYPE, SIMULINK_REAL_TIME_PLATFORM_TYPE, SLRT_AT_FUSION_PLATFORM_TYPE, STAND_ALONE_PLATFORM_TYPE, VECTOR_CAN_FUSION_PLATFORM_TYPE, VERISTAND_AT_FUSION_PLATFORM_TYPE, VERISTAND_PLATFORM_TYPE, VTD_FUSION_PLATFORM_TYPE, VW_AUDI_PLATFORM_TYPE, XIL_AT_FUSION_PLATFORM_TYPE

Method Summary

Modifier and Type	Method	Description
void	buildModelForFusion(boolean prepareForBuildOnly)	Generate the model for FUSION (named "<testframe>_fusion") from the test frame specified in the MATLAB-configuration.
void	generateIOFile()	Generate the TPT I/O file (see getIOFilePath() for details).
void	generateTestframe(boolean reuseExistingInterfaceData)	Generate the test frame for the model specified in the MATLAB-configuration.
java.lang.String	getCodeCoverageCustomScript()
java.util.List<Pair<java.lang.String,java.lang.String>>	getEnvironmentVariablesList()	Returns the environment variables for the MATLAB/Simulink platform configuration as specified by the user.
java.lang.String	getFinalizeScript()
java.lang.String	getIOFilePath()
java.lang.String	getMatlabVersionName()
java.lang.String	getOriginalModelFilePath()
java.lang.String	getOriginalModelLoadScript()
java.lang.String	getSutSubsystemPath()
java.lang.String	getTestframeFilePath()
java.lang.String	getTestframeModelLoadScript()
java.lang.String	getTestRunScript()
void	importIO(Project.SynchronizationMethod syncMethod)	Import the interface from the configured original model and subsystem block path (default all)
void	importOfflineLoggings()	Import any offline loggings that are activated in the model but not registered in TPT.
boolean	isTestFrameFilePathDeriveFromOriginalModel()
void	openOriginalModel()	Open the original model in MATLAB via running the configured original model load script in MATLAB.
void	openTestframeModel()	Open the test frame model in MATLAB via running the configured test frame model load script in MATLAB.
void	registerOfflineLogging(java.lang.String tptName, java.lang.String typeStr, java.lang.String defaultValueStr, java.lang.String sourceBlockPath, int portNumber, java.lang.String slLogName, java.lang.String tlLogdataStructName, boolean useTlddLogging)	Add a measurement to project declarations and configure the mapping-data for offline logging with TPT.
void	setCodeCoverageCustomScript(java.lang.String codeCoverageCustomScript)	Set the code coverage custom script
void	setCustomTestframeFilePath(java.lang.String testframeFilePath)	Set a custom test frame file path.
void	setEnvironmentVariablesList(java.util.List<Pair<java.lang.String,java.lang.String>> attributes)	Set a list of user-defined environment variables given by pair.first to the value given by the pair.second parameter.
void	setFinalizeScript(java.lang.String finalizeScript)	Set the finalize script
void	setMatlabVersionName(java.lang.String matlabVersionName)	Set the matlab version name.
void	setOriginalModelFilePath(java.lang.String originalModelFilePath)	Set the path to the original model file.
void	setOriginalModelLoadScript(java.lang.String originalModelLoadScript)	Set the original model load script
void	setSutSubsystemPath(java.lang.String sutSubsystemPath)	Set the subsystem block path.
void	setTestframeFilePathDeriveFromOriginalModel()	Automatically derive the test frame file path from the original model.
void	setTestframeModelLoadScript(java.lang.String testframeModelLoadScript)	Set the test frame model load script
void	setTestRunScript(java.lang.String testRunScript)	Set the test run script

Methods inherited from interface com.piketec.tpt.api.IdentifiableRemote

getIdentifier

Methods inherited from interface com.piketec.tpt.api.NamedObject

getName, setName

Methods inherited from interface com.piketec.tpt.api.PlatformConfiguration

copy, getHistorySize, getMapping, getProperties, getStepSize, getTimeOut, getType, initTasmoTestDataGeneration, invoke, setHistorySize, setMapping, setProperties, setStepSize, setTimeOut

Method Detail

setMatlabVersionName

void setMatlabVersionName(java.lang.String matlabVersionName)
                   throws java.rmi.RemoteException

Set the matlab version name.

Parameters:

matlabVersionName - The name of the MATLAB version to be used

Throws:

java.rmi.RemoteException - remote communication problem

getMatlabVersionName

java.lang.String getMatlabVersionName()
                               throws java.rmi.RemoteException

Returns:

The MATLAB version name

Throws:

java.rmi.RemoteException - remote communication problem

setSutSubsystemPath

void setSutSubsystemPath(java.lang.String sutSubsystemPath)
                  throws java.rmi.RemoteException

Set the subsystem block path.

Parameters:

sutSubsystemPath - the new subsystem block path

Throws:

java.rmi.RemoteException - remote communication problem

getSutSubsystemPath

java.lang.String getSutSubsystemPath()
                              throws java.rmi.RemoteException

Returns:

the subsystem block path

Throws:

java.rmi.RemoteException - remote communication problem

setOriginalModelFilePath

void setOriginalModelFilePath(java.lang.String originalModelFilePath)
                       throws java.rmi.RemoteException

Set the path to the original model file.

Parameters:

originalModelFilePath - the path to the new original model file

Throws:

java.rmi.RemoteException - remote communication problem

getOriginalModelFilePath

java.lang.String getOriginalModelFilePath()
                                   throws java.rmi.RemoteException

Returns:

the path to the original model file

Throws:

java.rmi.RemoteException - remote communication problem

getTestframeFilePath

java.lang.String getTestframeFilePath()
                               throws java.rmi.RemoteException

Returns:

the path to the test frame file. If deriving the test frame file path is enabled, this will return the automatically derived path.

Throws:

java.rmi.RemoteException - remote communication problem

getIOFilePath

java.lang.String getIOFilePath()
                        throws java.rmi.RemoteException

Returns:

The absolute path to the TPT I/O file (with suffix "_tpt_io.m"). This is automatically derived from the configured test frame file path.

Throws:

java.rmi.RemoteException - remote communication problem

setCustomTestframeFilePath

void setCustomTestframeFilePath(java.lang.String testframeFilePath)
                         throws java.rmi.RemoteException

Set a custom test frame file path.

Parameters:

testframeFilePath - the new test frame file path

Throws:

java.rmi.RemoteException - remote communication problem

isTestFrameFilePathDeriveFromOriginalModel

boolean isTestFrameFilePathDeriveFromOriginalModel()
                                            throws java.rmi.RemoteException

Returns:

true if the test frame file path is derived from the original model

Throws:

java.rmi.RemoteException - remote communication problem

setTestframeFilePathDeriveFromOriginalModel

void setTestframeFilePathDeriveFromOriginalModel()
                                          throws java.rmi.RemoteException

Automatically derive the test frame file path from the original model.

Throws:

java.rmi.RemoteException - remote communication problem

setOriginalModelLoadScript

void setOriginalModelLoadScript(java.lang.String originalModelLoadScript)
                         throws java.rmi.RemoteException

Set the original model load script

Parameters:

originalModelLoadScript - the new original model load script

Throws:

java.rmi.RemoteException - remote communication problem

getOriginalModelLoadScript

java.lang.String getOriginalModelLoadScript()
                                     throws java.rmi.RemoteException

Returns:

the original model load script

Throws:

java.rmi.RemoteException - remote communication problem

setTestframeModelLoadScript

void setTestframeModelLoadScript(java.lang.String testframeModelLoadScript)
                          throws java.rmi.RemoteException

Set the test frame model load script

Parameters:

testframeModelLoadScript - the new test frame model load script

Throws:

java.rmi.RemoteException - remote communication problem

getTestframeModelLoadScript

java.lang.String getTestframeModelLoadScript()
                                      throws java.rmi.RemoteException

Returns:

the test frame model load script

Throws:

java.rmi.RemoteException - remote communication problem

setTestRunScript

void setTestRunScript(java.lang.String testRunScript)
               throws java.rmi.RemoteException

Set the test run script

Parameters:

testRunScript - the new test run script

Throws:

java.rmi.RemoteException - remote communication problem

getTestRunScript

java.lang.String getTestRunScript()
                           throws java.rmi.RemoteException

Returns:

the test run script

Throws:

java.rmi.RemoteException - remote communication problem

setCodeCoverageCustomScript

void setCodeCoverageCustomScript(java.lang.String codeCoverageCustomScript)
                          throws java.rmi.RemoteException

Set the code coverage custom script

Parameters:

codeCoverageCustomScript - the new code coverage custom script

Throws:

java.rmi.RemoteException - remote communication problem

getCodeCoverageCustomScript

java.lang.String getCodeCoverageCustomScript()
                                      throws java.rmi.RemoteException

Returns:

the code coverage custom script

Throws:

java.rmi.RemoteException - remote communication problem

setFinalizeScript

void setFinalizeScript(java.lang.String finalizeScript)
                throws java.rmi.RemoteException

Set the finalize script

Parameters:

finalizeScript - the new finalize script

Throws:

java.rmi.RemoteException - remote communication problem

getFinalizeScript

java.lang.String getFinalizeScript()
                            throws java.rmi.RemoteException

Returns:

the finalize script

Throws:

java.rmi.RemoteException - remote communication problem

getEnvironmentVariablesList

java.util.List<Pair<java.lang.String,java.lang.String>> getEnvironmentVariablesList()
                                                                                   throws java.rmi.RemoteException

Returns the environment variables for the MATLAB/Simulink platform configuration as specified by the user. This list corresponds to the "Environments Variables" tab of the MATLAB/Simulink platform configuration GUI.

Returns:

User attributes as list.

Throws:

java.rmi.RemoteException - remote communication problem

setEnvironmentVariablesList

void setEnvironmentVariablesList(java.util.List<Pair<java.lang.String,java.lang.String>> attributes)
                          throws ApiException,
                                 java.rmi.RemoteException

Set a list of user-defined environment variables given by pair.first to the value given by the pair.second parameter.

Parameters:

attributes - user-defined attribute list

Throws:

ApiException - if attributes==null || pair.second == null || pair.first==null || pair.first.contains("\n")

java.rmi.RemoteException - remote communication problem

importIO

void importIO(Project.SynchronizationMethod syncMethod)
       throws java.rmi.RemoteException

Import the interface from the configured original model and subsystem block path (default all)

Parameters:

syncMethod - Should the objects be synchronized by name or by external name

Throws:

java.rmi.RemoteException - remote communication problem

importOfflineLoggings

void importOfflineLoggings()
                    throws java.rmi.RemoteException

Import any offline loggings that are activated in the model but not registered in TPT.

Throws:

java.rmi.RemoteException - remote communication problem

generateTestframe

void generateTestframe(boolean reuseExistingInterfaceData)
                throws java.rmi.RemoteException

Generate the test frame for the model specified in the MATLAB-configuration.

Parameters:

reuseExistingInterfaceData - Specify if interface data from a previous interface import that still exists in the MATLAB workspace shall be used

Throws:

java.rmi.RemoteException - remote communication problem

buildModelForFusion

void buildModelForFusion(boolean prepareForBuildOnly)
                  throws java.rmi.RemoteException

Generate the model for FUSION (named "<testframe>_fusion") from the test frame specified in the MATLAB-configuration. This model model will then automatically be built into a custom fusion node dll file using the Simulink Coder or Embedded Coder (unless the prepareForBuildOnly flag is set).

Parameters:

prepareForBuildOnly - Set to true if the model for FUSION shall only be generated and not be built automatically.

Throws:

java.rmi.RemoteException - remote communication problem

generateIOFile

void generateIOFile()
             throws java.rmi.RemoteException

Generate the TPT I/O file (see getIOFilePath() for details). If this file already exists it will be overwritten.

Throws:

java.rmi.RemoteException - remote communication problem

openOriginalModel

void openOriginalModel()
                throws java.rmi.RemoteException

Open the original model in MATLAB via running the configured original model load script in MATLAB.

Throws:

java.rmi.RemoteException - remote communication problem

openTestframeModel

void openTestframeModel()
                 throws java.rmi.RemoteException

Open the test frame model in MATLAB via running the configured test frame model load script in MATLAB.

Throws:

java.rmi.RemoteException - remote communication problem

registerOfflineLogging

void registerOfflineLogging(java.lang.String tptName,
                            java.lang.String typeStr,
                            java.lang.String defaultValueStr,
                            java.lang.String sourceBlockPath,
                            int portNumber,
                            java.lang.String slLogName,
                            java.lang.String tlLogdataStructName,
                            boolean useTlddLogging)
                     throws java.rmi.RemoteException

Add a measurement to project declarations and configure the mapping-data for offline logging with TPT. The settings are not automatically applied in MATLAB.

Note: This is for internal use only and may change in future versions of TPT.

Parameters:

tptName - The name of the new Measurement

typeStr - The type string of the new Measurement

defaultValueStr - The default value of the new Measurement

sourceBlockPath - The source block path of the simulink signal that shall be logged

portNumber - The source port number of the simulink signal that shall be logged

slLogName - The simulink logging name

tlLogdataStructName - The TargetLink log data struct name (empty if simulink logging is used)

useTlddLogging - Enable to use logging via TargetLink DD, otherwise block-logging is used

Throws:

java.rmi.RemoteException - remote communication problem