Package com.piketec.tpt.api.dspacepil
Interface DSpacePiLConfiguration
-
- All Superinterfaces:
IdentifiableRemote
,NamedObject
,PlatformConfiguration
,PlatformOrExecutionItemEnabler
,java.rmi.Remote
,TptRemote
public interface DSpacePiLConfiguration extends PlatformConfiguration
The TPT API representation of the dSpace PiL 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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getBoardConfigurationFilePath()
Gets the XML configuration file path for the TargetLink simulation module which specifies the simulation and communication serverjava.lang.String
getBoardName()
Gets the TargetLink name of the target PiL board or simulatorMatlabPlatformConfiguration
getMatlabSyncPlatform()
Gets the currently selected Matlab/Simulink reference configurationjava.lang.String
getTargetApplicationFilePath()
Gets the target application file path to be used as system under test (SUT)java.lang.String
getTargetLinkSimulationHandlerDirPath()
Gets the directory of the TargetLink simulation handler, i.e. the binary 'TLLoader.exe' of the dSPACE TargetLink installationjava.lang.String
getTargetLinkVersion()
Gets the TargetLink versionjava.lang.String
getUserConfigurationFilePath()
Gets the XML configuration file path for the TargetLink simulation module which specifies the target simulatorjava.lang.String
getWorkingDirectory()
Gets the current Working directory, by default the working directory is set to .pilDatavoid
setBoardConfigurationFilePath(java.lang.String boardConfigurationFile)
Sets the XML configuration file path for the TargetLink simulation module which specifies the simulation and communication servervoid
setBoardName(java.lang.String boardName)
Sets the TargetLink name of the target PiL board or simulatorvoid
setMatlabSyncPlatform(MatlabPlatformConfiguration configuration)
Sets the MATLAB/Simulink reference configurationvoid
setTargetApplicationFilePath(java.lang.String targetApplicationFile)
Sets the target application file path which will be used as system under test (SUT)void
setTargetLinkSimulationHandlerDirPath(java.lang.String targetLinkSimulationHandlerDir)
Sets the directory of the TargetLink simulation handler, i.e. the binary 'TLLoader.exe' of the dSPACE TargetLink installationvoid
setTargetLinkVersion(java.lang.String targetLinkVersion)
Sets the TargetLink versionvoid
setUserConfigurationFilePath(java.lang.String userConfigurationFile)
Sets the XML configuration file path for the TargetLink simulation module which specifies the target simulatorvoid
setWorkingDirectory(java.lang.String workingDirectory)
Sets the Working directoryvoid
synchronizeFromReference()
Automatically applies all the settings from the referenced MATLAB Platform.-
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
-
synchronizeFromReference
void synchronizeFromReference() throws java.rmi.RemoteException, ApiException
Automatically applies all the settings from the referenced MATLAB Platform. SeesetMatlabSyncPlatform(MatlabPlatformConfiguration)
to specify the reference MATLAB Platform- Throws:
java.rmi.RemoteException
- remote communication problemApiException
- 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 benull
- Throws:
java.rmi.RemoteException
- remote communication problemApiException
- 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
-
-