Package com.piketec.tpt.api.cplatform

Interface CCodePlatformConfiguration

All Superinterfaces:

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

public interface CCodePlatformConfiguration
extends PlatformConfiguration

The TPT API representation of the C\C++ platform in TPT

Author:

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

Field Summary

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

ADTF_PLATFORM_TYPE, ASCET_AT_FUSION_PLATFORM_TYPE, ASCET_PLATFORM_TYPE, ASSESSMENT_PLATFORM_TYPE, AUTOSAR_PLATFORM_TYPE, BOSCH_FUSION_PLATFORM_TYPE, C_PLATFORM_TYPE, CANOE_AT_FUSION_PLATFORM_TYPE, CANOE_PLATFORM_TYPE, CARMAKER_FMU_FUSION_PLATFORM_TYPE, CONCURRENT_HIL_PLATFORM_TYPE, CTB_PLATFORM_TYPE, DSPACE_HIL_AT_FUSION_PLATFORM_TYPE, DSPACE_HIL_PLATFORM_TYPE, EXE_PLATFORM_TYPE, FEP, FUSION_PLATFORM_TYPE, LABCAR_PLATFORM_TYPE, MATLAB_SIMULINK_PLATFORM_TYPE, RADARCAN_PLATFORM_TYPE, SILVER_PLATFORM_TYPE, SIMULINK_REAL_TIME_PLATFORM_TYPE, STAND_ALONE_PLATFORM_TYPE, VERISTAND_AT_FUSION_PLATFORM_TYPE, VERISTAND_PLATFORM_TYPE, VW_AUDI_PLATFORM_TYPE, XIL_AT_FUSION_PLATFORM_TYPE

Method Summary

Modifier and Type	Method	Description
IncludeFolder	addIncludeFolder(java.lang.String path)	Add a new include folder
java.util.List<java.lang.String>	analyzeSources()	The interface of the currently set c files is refreshed based on the sources.
SourceFileItem	createSourceFileItem(java.lang.String path)	Add a new source file with default settings to this configuration
java.util.List<java.lang.String>	generateCode(boolean compile)	Generate the code to connect your c-code to TPT.
java.lang.String	getCompiler()
java.lang.String	getCompilerOptions()	Get the compiler options used when linking the test frame
SourceInterface	getImportedCCodeBySource(SourceFileItem sourceFile)
RemoteList<IncludeFolder>	getIncludeFolders()
java.lang.String	getLinkerOptions()	Get the linker options used when linking the test frame
java.lang.String	getOutputFolderPath()	Get the path to the output folder.
java.lang.String	getProjectRootFolderPath()	Get the path to the project root folder.
RemoteList<FunctionSchedulingItem>	getSchedulingItems()	Get the list of scheduled functions
RemoteList<SourceFileItem>	getSourceFileItems()	Get the sources currently contained in this platform
java.util.List<SourceInterface>	getSourcesInterface()
TasmoCCodeInstrumentationLevel	getTasmoInstrumentationLevel()	Get the TASMO instrumentation level
SourceInterface	getUnresolvedReferences()
java.lang.String	getWrapperCode()	Get the additional wrapper code
java.lang.String	getWrapperExtraCompilerOptions()
SourceInterface	getWrapperInterface()
boolean	getWrappperIsCpp()
java.util.List<java.lang.String>	importIO(Project.SynchronizationMethod syncMethod)	Import the interface based on the current source interface settings (default all).
boolean	is64Bit()
void	set64Bit(boolean is64Bit)	Configure if the test frame should be compiled in 64 bit
void	setCompiler(java.lang.String name)	Set the name of the compiler to be used
void	setCompilerOptions(java.lang.String compilerOptions)	Set the compiler options used when linking the test frame
void	setLinkerOptions(java.lang.String linkerOptions)	Set the linker options used when linking the test frame
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	setTasmoInstrumentationLevel(TasmoCCodeInstrumentationLevel instrumenationLevel)	Set the TASMO instrumentation level
void	setWrapperCode(java.lang.String wrapperCode)	Set the additional wrapper code
void	setWrapperExtraCompilerOptions(java.lang.String extraOptions)
void	setWrappperIsCpp(boolean wrapperIsCpp)
void	syncSchedulingItems()	Synchronize the scheduling table with the current source interface settings.

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

getSourceFileItems

RemoteList<SourceFileItem> getSourceFileItems()
                                       throws java.rmi.RemoteException

Get the sources currently contained in this platform

Returns:

The list of the currently set source files

Throws:

java.rmi.RemoteException - remote communication problem

createSourceFileItem

SourceFileItem createSourceFileItem(java.lang.String path)
                             throws java.rmi.RemoteException

Add a new source file with default settings to this configuration

Parameters:

path - The path of this source file relative to the TPT project

Returns:

The new created source file

Throws:

java.rmi.RemoteException - remote communication problem

setWrapperCode

void setWrapperCode(java.lang.String wrapperCode)
             throws java.rmi.RemoteException

Set the additional wrapper code

Parameters:

wrapperCode - The additional wrapper code

Throws:

java.rmi.RemoteException - remote communication problem

getWrapperCode

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

Get the additional wrapper code

Returns:

The additional wrapper code, may be empty

Throws:

java.rmi.RemoteException - remote communication problem

setWrappperIsCpp

void setWrappperIsCpp(boolean wrapperIsCpp)
               throws java.rmi.RemoteException

Parameters:

wrapperIsCpp - Set to true if the wrapper code is to be treated as C++. Set to false if the wrapper code is to be treated as C.

Throws:

java.rmi.RemoteException - remote communication problem

getWrappperIsCpp

boolean getWrappperIsCpp()
                  throws java.rmi.RemoteException

Returns:

True if the wrapper code is set to be treated as C++. False if the wrapper code is set to be treated as C.

Throws:

java.rmi.RemoteException - remote communication problem

setWrapperExtraCompilerOptions

void setWrapperExtraCompilerOptions(java.lang.String extraOptions)
                             throws java.rmi.RemoteException

Parameters:

extraOptions - Set the extra compiler options for parsing or compiling the wrapper code.

Throws:

java.rmi.RemoteException - remote communication problem

getWrapperExtraCompilerOptions

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

Returns:

The extra compiler options for parsing or compiling the wrapper code.

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 currenty 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

setTasmoInstrumentationLevel

void setTasmoInstrumentationLevel(TasmoCCodeInstrumentationLevel instrumenationLevel)
                           throws java.rmi.RemoteException

Set the TASMO instrumentation level

Parameters:

instrumenationLevel - The TASMO instrumentation level

Throws:

java.rmi.RemoteException - remote communication problem

getTasmoInstrumentationLevel

TasmoCCodeInstrumentationLevel getTasmoInstrumentationLevel()
                                                     throws java.rmi.RemoteException

Get the TASMO instrumentation level

Returns:

The TASMO instrumentation level

Throws:

java.rmi.RemoteException - remote communication problem

generateCode

java.util.List<java.lang.String> generateCode(boolean compile)
                                       throws java.rmi.RemoteException

Generate the code to connect your c-code to TPT.

Parameters:

compile - Immediately compile the code after generation

Returns:

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

Throws:

java.rmi.RemoteException - remote communication problem

getIncludeFolders

RemoteList<IncludeFolder> getIncludeFolders()
                                     throws java.rmi.RemoteException

Returns:

The list of the include folders

Throws:

java.rmi.RemoteException - remote communication problem

addIncludeFolder

IncludeFolder addIncludeFolder(java.lang.String path)
                        throws java.rmi.RemoteException

Add a new include folder

Parameters:

path - The path of the new include folder

Returns:

The new include folder

Throws:

java.rmi.RemoteException - remote communication problem

getSchedulingItems

RemoteList<FunctionSchedulingItem> getSchedulingItems()
                                               throws java.rmi.RemoteException

Get the list of scheduled functions

Returns:

The functions to be scheduled

Throws:

java.rmi.RemoteException - remote communication problem

analyzeSources

java.util.List<java.lang.String> analyzeSources()
                                         throws java.rmi.RemoteException

The interface of the currently set c files is refreshed based on the sources. To access the imported interface afterwards use getSourcesInterface().

Returns:

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

Throws:

java.rmi.RemoteException - remote communication problem

getSourcesInterface

java.util.List<SourceInterface> getSourcesInterface()
                                             throws java.rmi.RemoteException

Returns:

The list of imported sources interfaces, without the wrapper and the unresolved references. To update the interface based on the current sources use analyzeSources()

Throws:

java.rmi.RemoteException - remote communication problem

getImportedCCodeBySource

SourceInterface getImportedCCodeBySource(SourceFileItem sourceFile)
                                  throws java.rmi.RemoteException

Parameters:

sourceFile - The relevant source file object

Returns:

The imported settings for the given source file, null if no SourceInterface matching this SourceFileItem could be found.

Throws:

java.rmi.RemoteException - remote communication problem

getUnresolvedReferences

SourceInterface getUnresolvedReferences()
                                 throws java.rmi.RemoteException

Returns:

The settings to connect unresolved references

Throws:

java.rmi.RemoteException - remote communication problem

getWrapperInterface

SourceInterface getWrapperInterface()
                             throws java.rmi.RemoteException

Returns:

The settings to connect the objects in the wrapper code

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 source interface settings (default all). Note: The scheduling table will not be updated here. See syncSchedulingItems() for that purpose.

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

syncSchedulingItems

void syncSchedulingItems()
                  throws java.rmi.RemoteException

Synchronize the scheduling table with the current source interface settings. Functions where the FunctionConnectionType is set to FunctionConnectionType.SCHEDULE will be added to the scheduling table. Functions where the FunctionConnectionType is set to anything else will be removed from the table. Use getSchedulingItems() to access and edit the scheduling setting for the individual functions afterwards.

Throws:

java.rmi.RemoteException - remote communication problem

See Also:

SourceInterface.setFunctionConnectionType(String, FunctionConnectionType)

setLinkerOptions

void setLinkerOptions(java.lang.String linkerOptions)
               throws java.rmi.RemoteException

Set the linker options used when linking the test frame

Parameters:

linkerOptions - The new options for the linker

Throws:

java.rmi.RemoteException - remote communication problem

getLinkerOptions

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

Get the linker options used when linking the test frame

Returns:

The current linker options

Throws:

java.rmi.RemoteException - remote communication problem

setCompilerOptions

void setCompilerOptions(java.lang.String compilerOptions)
                 throws java.rmi.RemoteException

Set the compiler options used when linking the test frame

Parameters:

compilerOptions - The new arguments for the compiler

Throws:

java.rmi.RemoteException - remote communication problem

getCompilerOptions

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

Get the compiler options used when linking the test frame

Returns:

The current compiler options

Throws:

java.rmi.RemoteException - remote communication problem