Package com.piketec.tpt.api.autosarplatform

Interface AutosarPlatformConfiguration

All Superinterfaces:

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

public interface AutosarPlatformConfiguration
extends PlatformConfiguration

The TPT API representation of the AUTOSAR 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	addAdditionalIcludeFolder(java.lang.String path)	Add a path to the list of additional include folders.
void	addArxmlFile(java.lang.String path)	Add an arxm file.
void	addRepositoryArxmlFile(java.lang.String path)	Add an arxm file from the repository.
void	addRepositoryIcludeFolder(java.lang.String path)	Add a path to the list of include folders from the repository.
void	addRepositorySourceFile(java.lang.String path)	Add a source file from the repository.
void	addSourceFile(java.lang.String path)	Add a source file.
void	addSystemConstantValueSet(java.lang.String name)	Add a system constant value set that shall be used.
void	disableCoverage()	Disable any sort of code coverage measurement in this platform
void	generateCode(boolean compile)	Generate the test frame code and optionally compile it.
RemoteList<java.lang.String>	getAdditionalIcludeFoldersList()	Get the currently configured additional included paths.
RemoteCollection<java.lang.String>	getArxmlFiles()	Get the paths of the currently selected arxml files.
java.lang.String	getCompiler()
CoverageSettings	getCoverageSettings()	Get the current coverage settings
java.lang.String	getCustomInterfaceFilePath()
java.lang.String	getOutputFolderPath()	Get the path to the output folder.
java.lang.String	getProjectRootFolderPath()	Get the path to the project root folder.
RemoteCollection<java.lang.String>	getRepositoryArxmlFiles()	Get the paths of the currently selected arxml files from the repository.
RemoteList<java.lang.String>	getRepositoryIncludeFoldersList()	Get the currently configured included paths from the repository.
RemoteCollection<java.lang.String>	getRepositorySourceFiles()	Get the paths of the currently selected source files from the repository.
RemoteList<RunnableSchedulingItem>	getRunnables()	Get the runnables imported from the arxml files.
java.lang.String	getSelectedSWC()	Get the AUTOSAR SWC that shall be tested.
RemoteCollection<java.lang.String>	getSourceFiles()	Get the paths of the currently selected source files.
java.lang.String	getStubHeaderFiles()	Get the configured stub header files (sepparated by comma)
RemoteCollection<java.lang.String>	getSystemConstantValueSets()
java.lang.String	getSystemForSignalMapping()	Get the name of the system whose data mapping shall be used for sender-receiver elements.
java.util.List<java.lang.String>	importIO(Project.SynchronizationMethod syncMethod)	Import the interface based on the current settings (default all)
boolean	is64Bit()
boolean	isAssumeAllPortElementsExplicitAccess()
boolean	isCumulateCoverage()
boolean	isImportParameterCurveMapTypes()
boolean	isUseEffectiveInterface()
boolean	isUseRepository()
boolean	isUseSystemMapping()
void	refreshRunnables()	Refresh the list of runnables from the arxml with the current settings.
void	set64Bit(boolean is64Bit)	Configure if the test frame should be compiled in 64 bit
void	setAssumeAllPortElementsExplicitAccess(boolean assumeAllPortElementsExplicitAccess)
void	setCompiler(java.lang.String name)	Set the name of the compiler to be used
CTCCoverageSettings	setCoverageToCTC()	Enable CTC++ coverage measurement to be used for this platform
GCovCoverageSettings	setCoverageToGCov()	Enable GNU gcov coverage measurement to be used for this platform
void	setCumulateCoverage(boolean cumulate)	Set if the coverage data will be cumulated
void	setCustomInterfaceFilePath(java.lang.String path)	Set the custom interface file path.
void	setImportParameterCurveMapTypes(boolean importParameterCurveMapTypes)
void	setOutputFolderPath(java.lang.String path)	Set the path to the output folder.
void	setProjectRootFolderPath(java.lang.String path)	Set the path to the project root folder.
void	setSelectedSWC(java.lang.String swc)	Set the AUTOSAR SWC that shall be tested.
void	setStubHeaderFile(java.lang.String stubHeaderFile)	Set the stub header file
void	setSystemForSignalMapping(java.lang.String systemName)	Set the name of the system from which the data mapping for sender-receiver elements shall be used.
void	setUseEffectiveInterface(boolean useEffectiveInterface)
void	setUseRepository(boolean useRepository)	Configure if arxml and source files from the AAUTOSAR repository files should be used.
void	setUseSystemMapping(boolean useSystemMapping)	Enable or disable using a system to use its data mapping for sender-receiver elements.

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

setProjectRootFolderPath

void setProjectRootFolderPath(java.lang.String path)
                       throws java.rmi.RemoteException

Set the path to the project root folder.

Parameters:

path - The new path to the project root folder

Throws:

java.rmi.RemoteException - remote communication problem

getProjectRootFolderPath

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

Get the path to the project root folder.

Returns:

The path to the project root folder

Throws:

java.rmi.RemoteException - remote communication problem

setOutputFolderPath

void setOutputFolderPath(java.lang.String path)
                  throws java.rmi.RemoteException

Set the path to the output folder.

Parameters:

path - The new path to the output folder

Throws:

java.rmi.RemoteException - remote communication problem

getOutputFolderPath

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

Get the path to the output folder.

Returns:

The path to the output folder

Throws:

java.rmi.RemoteException - remote communication problem

setCompiler

void setCompiler(java.lang.String name)
          throws java.rmi.RemoteException

Set the name of the compiler to be used

Parameters:

name - The name of the desired compiler

Throws:

java.rmi.RemoteException - remote communication problem

getCompiler

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

Returns:

The name of the currently used compiler

Throws:

java.rmi.RemoteException - remote communication problem

set64Bit

void set64Bit(boolean is64Bit)
       throws java.rmi.RemoteException

Configure if the test frame should be compiled in 64 bit

Parameters:

is64Bit - true if the code should be compiled in 64 bit, false otherwise

Throws:

java.rmi.RemoteException - remote communication problem

is64Bit

boolean is64Bit()
         throws java.rmi.RemoteException

Returns:

true if the test frame will be compiled in 64 bit, false otherwise

Throws:

java.rmi.RemoteException - remote communication problem

addArxmlFile

void addArxmlFile(java.lang.String path)
           throws ApiException,
                  java.rmi.RemoteException

Add an arxm file. This paths must be relative to the configured project root folder for this platform (see getProjectRootFolderPath().

Parameters:

path - The new path to Add

Throws:

ApiException - In case the added path is invalid or already contained.

java.rmi.RemoteException - remote communication problem

getArxmlFiles

RemoteCollection<java.lang.String> getArxmlFiles()
                                          throws java.rmi.RemoteException

Get the paths of the currently selected arxml files. All paths are relative to the configured project root folder for this platform (see getProjectRootFolderPath().

Returns:

A remote collection with the selected configured arxml files

Throws:

java.rmi.RemoteException - remote communication problem

setSelectedSWC

void setSelectedSWC(java.lang.String swc)
             throws java.rmi.RemoteException

Set the AUTOSAR SWC that shall be tested. This must be the short name from the arxml.

Parameters:

swc - The short name of the AUTOSAR SWC

Throws:

java.rmi.RemoteException - remote communication problem

getSelectedSWC

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

Get the AUTOSAR SWC that shall be tested. This is the short name from the arxml.

Returns:

The short name of the AUTOSAR SWC

Throws:

java.rmi.RemoteException - remote communication problem

addSystemConstantValueSet

void addSystemConstantValueSet(java.lang.String name)
                        throws java.rmi.RemoteException

Add a system constant value set that shall be used. This must be the short name from the arxml.

Parameters:

name - The short name of the system constant value set.

Throws:

java.rmi.RemoteException - remote communication problem

getSystemConstantValueSets

RemoteCollection<java.lang.String> getSystemConstantValueSets()
                                                       throws java.rmi.RemoteException

Returns:

A remote collection with the configured system constant value sets. The entries are the short names from the arxml.

Throws:

java.rmi.RemoteException - remote communication problem

addSourceFile

void addSourceFile(java.lang.String path)
            throws ApiException,
                   java.rmi.RemoteException

Add a source file. This paths must be relative to the configured project root folder for this platform (see #getProjectRootFolderPath().

Parameters:

path - The new path to Add

Throws:

ApiException - In case the added path is invalid or already contained.

java.rmi.RemoteException - remote communication problem

getSourceFiles

RemoteCollection<java.lang.String> getSourceFiles()
                                           throws java.rmi.RemoteException

Get the paths of the currently selected source files. All paths are relative to the configured project root folder for this platform (see #getProjectRootFolderPath().

Returns:

A remote collection with the selected configured source files

Throws:

java.rmi.RemoteException - remote communication problem

addAdditionalIcludeFolder

void addAdditionalIcludeFolder(java.lang.String path)
                        throws java.rmi.RemoteException

Add a path to the list of additional include folders. This path may be absolute or relative to the project root folder for this platform.

Parameters:

path - The new path to Add

Throws:

java.rmi.RemoteException - remote communication problem

getAdditionalIcludeFoldersList

RemoteList<java.lang.String> getAdditionalIcludeFoldersList()
                                                     throws java.rmi.RemoteException

Get the currently configured additional included paths.

Returns:

A remote list with the currently configured additional include paths

Throws:

java.rmi.RemoteException - remote communication problem

setStubHeaderFile

void setStubHeaderFile(java.lang.String stubHeaderFile)
                throws java.rmi.RemoteException

Set the stub header file

Parameters:

stubHeaderFile - the new stub header file

Throws:

java.rmi.RemoteException - remote communication problem

getStubHeaderFiles

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

Get the configured stub header files (sepparated by comma)

Returns:

the configured stub header files

Throws:

java.rmi.RemoteException - remote communication problem

setImportParameterCurveMapTypes

void setImportParameterCurveMapTypes(boolean importParameterCurveMapTypes)
                              throws java.rmi.RemoteException

Parameters:

importParameterCurveMapTypes - true to import application data type with category CURVE or MAP for parameters as curve/map type to TPT, false to import them with the underlying implementation data type instead.

Throws:

java.rmi.RemoteException - remote communication problem

isImportParameterCurveMapTypes

boolean isImportParameterCurveMapTypes()
                                throws java.rmi.RemoteException

Returns:

true if importing application data type with category CURVE or MAP for parameters as curve/map type to TPT, false otherwise.

Throws:

java.rmi.RemoteException - remote communication problem

setAssumeAllPortElementsExplicitAccess

void setAssumeAllPortElementsExplicitAccess(boolean assumeAllPortElementsExplicitAccess)
                                     throws java.rmi.RemoteException

Parameters:

assumeAllPortElementsExplicitAccess - true to enable the "assume explicit access for all port elements" option, false to disable it

Throws:

java.rmi.RemoteException - remote communication problem

isAssumeAllPortElementsExplicitAccess

boolean isAssumeAllPortElementsExplicitAccess()
                                       throws java.rmi.RemoteException

Returns:

true if the "assume explicit access for all port elements" option enabled, false otherwise.

Throws:

java.rmi.RemoteException - remote communication problem

isUseRepository

boolean isUseRepository()
                 throws java.rmi.RemoteException

Returns:

true if using repositry files is enabled, false otherwise.

Throws:

java.rmi.RemoteException - remote communication problem

setUseRepository

void setUseRepository(boolean useRepository)
               throws java.rmi.RemoteException

Configure if arxml and source files from the AAUTOSAR repository files should be used.

Parameters:

useRepository - true to enable using repositry files, false to disable it

Throws:

java.rmi.RemoteException - remote communication problem

isUseEffectiveInterface

boolean isUseEffectiveInterface()
                         throws java.rmi.RemoteException

Returns:

Is the the "use effective interface" option enabled

Throws:

java.rmi.RemoteException - remote communication problem

setUseEffectiveInterface

void setUseEffectiveInterface(boolean useEffectiveInterface)
                       throws java.rmi.RemoteException

Parameters:

useEffectiveInterface - En- or disable the "use effective interface" option

Throws:

java.rmi.RemoteException - remote communication problem

addRepositoryArxmlFile

void addRepositoryArxmlFile(java.lang.String path)
                     throws ApiException,
                            java.rmi.RemoteException

Add an arxm file from the repository. This paths must be relative to the repository root folder.

Parameters:

path - The new path to Add

Throws:

ApiException - In case the added path is invalid or already contained.

java.rmi.RemoteException - remote communication problem

getRepositoryArxmlFiles

RemoteCollection<java.lang.String> getRepositoryArxmlFiles()
                                                    throws java.rmi.RemoteException

Get the paths of the currently selected arxml files from the repository. All paths are relative to the configured repository root folder.

Returns:

A remote collection with the currently selected arxml files from the repository

Throws:

java.rmi.RemoteException - remote communication problem

addRepositorySourceFile

void addRepositorySourceFile(java.lang.String path)
                      throws ApiException,
                             java.rmi.RemoteException

Add a source file from the repository. This paths must be relative to the repository root folder.

Parameters:

path - The new path to Add

Throws:

ApiException - In case the added path is invalid or already contained.

java.rmi.RemoteException - remote communication problem

getRepositorySourceFiles

RemoteCollection<java.lang.String> getRepositorySourceFiles()
                                                     throws java.rmi.RemoteException

Get the paths of the currently selected source files from the repository. All paths are relative to the configured repository root folder.

Returns:

A remote collection with the currently selected source files from the repository

Throws:

java.rmi.RemoteException - remote communication problem

addRepositoryIcludeFolder

void addRepositoryIcludeFolder(java.lang.String path)
                        throws java.rmi.RemoteException

Add a path to the list of include folders from the repository. This path may be absolute or relative to the repository root folder.

Parameters:

path - The new path to Add

Throws:

java.rmi.RemoteException - remote communication problem

getRepositoryIncludeFoldersList

RemoteList<java.lang.String> getRepositoryIncludeFoldersList()
                                                      throws java.rmi.RemoteException

Get the currently configured included paths from the repository.

Returns:

A remote list with the currently configured include paths from the repository

Throws:

java.rmi.RemoteException - remote communication problem

refreshRunnables

void refreshRunnables()
               throws java.rmi.RemoteException

Refresh the list of runnables from the arxml with the current settings.

Throws:

java.rmi.RemoteException - remote communication problem

getRunnables

RemoteList<RunnableSchedulingItem> getRunnables()
                                         throws java.rmi.RemoteException

Get the runnables imported from the arxml files.

Returns:

A remote list with the runnables

Throws:

java.rmi.RemoteException - remote communication problem

getCustomInterfaceFilePath

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

Returns:

The configured custom interface file path

Throws:

java.rmi.RemoteException - remote communication problem

setCustomInterfaceFilePath

void setCustomInterfaceFilePath(java.lang.String path)
                         throws java.rmi.RemoteException

Set the custom interface file path.

Parameters:

path - the new custom interface file path

Throws:

java.rmi.RemoteException - remote communication problem

setUseSystemMapping

void setUseSystemMapping(boolean useSystemMapping)
                  throws java.rmi.RemoteException

Enable or disable using a system to use its data mapping for sender-receiver elements. If enabled the system to be used can be set via setSystemForSignalMapping(String).

Parameters:

useSystemMapping - true to enable using a system data mapping, false to disable it

Throws:

java.rmi.RemoteException - remote communication problem

isUseSystemMapping

boolean isUseSystemMapping()
                    throws java.rmi.RemoteException

Returns:

true if using a system data mapping is enabled, false if it is disabled

Throws:

java.rmi.RemoteException - remote communication problem

setSystemForSignalMapping

void setSystemForSignalMapping(java.lang.String systemName)
                        throws java.rmi.RemoteException

Set the name of the system from which the data mapping for sender-receiver elements shall be used. This must be the short name from the arxml.

Parameters:

systemName - the short name of the the AUTOSAR system whose data mapping shall be used for sender-receiver elements

Throws:

java.rmi.RemoteException - remote communication problem

getSystemForSignalMapping

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

Get the name of the system whose data mapping shall be used for sender-receiver elements.

Returns:

the short name of the the AUTOSAR system whose data mapping shall be used for sender-receiver elements

Throws:

java.rmi.RemoteException - remote communication problem

importIO

java.util.List<java.lang.String> importIO(Project.SynchronizationMethod syncMethod)
                                   throws java.rmi.RemoteException

Import the interface based on the current settings (default all)

Parameters:

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

Returns:

A list with warnings that eventually occured, empty list if none occured

Throws:

java.rmi.RemoteException - remote communication problem

generateCode

void generateCode(boolean compile)
           throws java.rmi.RemoteException

Generate the test frame code and optionally compile it.

Parameters:

compile - Immediately compile the code after generation

Throws:

java.rmi.RemoteException - remote communication problem

isCumulateCoverage

boolean isCumulateCoverage()
                    throws java.rmi.RemoteException

Returns:

If the coverage data will be cumulated

Throws:

java.rmi.RemoteException - remote communication problem

setCumulateCoverage

void setCumulateCoverage(boolean cumulate)
                  throws java.rmi.RemoteException

Set if the coverage data will be cumulated

Parameters:

cumulate - If the coverage data will be cumulated

Throws:

java.rmi.RemoteException - remote communication problem

getCoverageSettings

CoverageSettings getCoverageSettings()
                              throws java.rmi.RemoteException,
                                     ApiException

Get the current coverage settings

Returns:

The current coverage settings or null if coverage is disabled

Throws:

java.rmi.RemoteException - remote communication problem

ApiException - If the current coverage type is not supported

setCoverageToCTC

CTCCoverageSettings setCoverageToCTC()
                              throws java.rmi.RemoteException

Enable CTC++ coverage measurement to be used for this platform

Returns:

The CTC++ coverage settings that will be used

Throws:

java.rmi.RemoteException - remote communication problem

setCoverageToGCov

GCovCoverageSettings setCoverageToGCov()
                                throws java.rmi.RemoteException

Enable GNU gcov coverage measurement to be used for this platform

Returns:

The GNU gcov coverage settings that will be used

Throws:

java.rmi.RemoteException - remote communication problem

disableCoverage

void disableCoverage()
              throws java.rmi.RemoteException

Disable any sort of code coverage measurement in this platform

Throws:

java.rmi.RemoteException - remote communication problem