Package com.piketec.tpt.api.cplatform

Interface ImportedClassInstanceSettings

All Superinterfaces:

IdentifiableRemote, java.rmi.Remote, TptRemote

public interface ImportedClassInstanceSettings
extends IdentifiableRemote

The imported settings of a class instance file in the C\C++ platform in TPT

Author:

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

Method Summary

Modifier and Type	Method	Description
java.lang.String	getFunctionArgumentName(java.lang.String functionName, int argumentIndex)	Determines the name of a function argument in the imported source code
FunctionConnectionType	getFunctionConnectionType(java.lang.String functionName)	Get the way a function is connected to TPT
java.util.List<java.lang.String>	getFunctions()	Get the public functions of the class of this object
java.util.List<java.lang.String>	getInternalVariables(java.lang.String functionName)	Get a list of the internal variables of a function in the class of this object
int	getNumOfFunctionArguments(java.lang.String functionName)	Determines the number of function arguments
java.lang.String	getScheduledFunctionArgumentChannelName(java.lang.String functionName, int argumentIndex)	Determines the channel name of a function argument that will be imported to TPT
java.util.List<java.lang.String>	getVariables()	Get the names of the public variables contained in the class of this object
boolean	isInternalVariableConnected(java.lang.String functionName, java.lang.String internalVariableName)	Set if the internal variable will be connected to TPT
boolean	isVariableConnected(java.lang.String variableName)	Will the variable be connected to TPT in the current settings
void	setFunctionConnectionType(java.lang.String functionName, FunctionConnectionType connectionType)	Set the way a function is connected to TPT
void	setInternalVariableConnected(java.lang.String functionName, java.lang.String internalVariableName, boolean connect)	Will the internal variable be connected in the current settings
void	setScheduledFunctionArgumentChannelName(java.lang.String functionName, int argumentIndex, java.lang.String channelName)	Sets the channel name of a function argument that will be imported to TPT
void	setVariableConnected(java.lang.String variableName, boolean isConnected)	Set if the variable will be connected to TPT

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

getIdentifier

Method Detail

isVariableConnected

boolean isVariableConnected(java.lang.String variableName)
                     throws java.rmi.RemoteException

Will the variable be connected to TPT in the current settings

Parameters:

variableName - The name of the variable

Returns:

Will the variable be connected to TPT in the current settings.

Throws:

java.rmi.RemoteException - remote communication problem

setVariableConnected

void setVariableConnected(java.lang.String variableName,
                          boolean isConnected)
                   throws java.rmi.RemoteException

Set if the variable will be connected to TPT

Parameters:

variableName - The name of the variable

isConnected - Will the variable be connected to TPT

Throws:

java.rmi.RemoteException - remote communication problem

getFunctionConnectionType

FunctionConnectionType getFunctionConnectionType(java.lang.String functionName)
                                          throws java.rmi.RemoteException

Get the way a function is connected to TPT

Parameters:

functionName - The name of the function

Returns:

The connection type of the function, null if the function does not exist within the class of this object

Throws:

java.rmi.RemoteException - remote communication problem

setFunctionConnectionType

void setFunctionConnectionType(java.lang.String functionName,
                               FunctionConnectionType connectionType)
                        throws java.rmi.RemoteException

Set the way a function is connected to TPT

Parameters:

functionName - The name of the function

connectionType - The desired FunctionConnectionType of the function

Throws:

java.rmi.RemoteException - remote communication problem

getNumOfFunctionArguments

int getNumOfFunctionArguments(java.lang.String functionName)
                       throws java.rmi.RemoteException

Determines the number of function arguments

Parameters:

functionName - The name of the function

Returns:

The number of arguments in the function declaration

Throws:

java.rmi.RemoteException - remote communication problem

getFunctionArgumentName

java.lang.String getFunctionArgumentName(java.lang.String functionName,
                                         int argumentIndex)
                                  throws java.rmi.RemoteException

Determines the name of a function argument in the imported source code

Parameters:

functionName - The name of the function

argumentIndex - The index of the relevant argument

Returns:

The name of the function argument

Throws:

java.rmi.RemoteException - remote communication problem

getScheduledFunctionArgumentChannelName

java.lang.String getScheduledFunctionArgumentChannelName(java.lang.String functionName,
                                                         int argumentIndex)
                                                  throws java.rmi.RemoteException

Determines the channel name of a function argument that will be imported to TPT

Parameters:

functionName - The name of the function

argumentIndex - The index of the relevant argument

Returns:

The name of the channel that will be used for the function argument in TPT

Throws:

java.rmi.RemoteException - remote communication problem

setScheduledFunctionArgumentChannelName

void setScheduledFunctionArgumentChannelName(java.lang.String functionName,
                                             int argumentIndex,
                                             java.lang.String channelName)
                                      throws java.rmi.RemoteException

Sets the channel name of a function argument that will be imported to TPT

Parameters:

functionName - The name of the function

argumentIndex - The index of the relevant argument

channelName - The name used to import the function argument to a channel in TPT

Throws:

java.rmi.RemoteException - remote communication problem

getVariables

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

Get the names of the public variables contained in the class of this object

Returns:

A list of the names of the variables contained in this object

Throws:

java.rmi.RemoteException - remote communication problem

getFunctions

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

Get the public functions of the class of this object

Returns:

A list of the names of the functions contained in this object

Throws:

java.rmi.RemoteException - remote communication problem

getInternalVariables

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

Get a list of the internal variables of a function in the class of this object

Parameters:

functionName - The name of the function

Returns:

A list of the names of the internal variables of a function contained in this object

Throws:

java.rmi.RemoteException - remote communication problem

setInternalVariableConnected

void setInternalVariableConnected(java.lang.String functionName,
                                  java.lang.String internalVariableName,
                                  boolean connect)
                           throws java.rmi.RemoteException

Will the internal variable be connected in the current settings

Parameters:

functionName - The name of the function

internalVariableName - The name of the internal variable

connect - If the variable should be connected to TPT

Throws:

java.rmi.RemoteException - remote communication problem

isInternalVariableConnected

boolean isInternalVariableConnected(java.lang.String functionName,
                                    java.lang.String internalVariableName)
                             throws java.rmi.RemoteException

Set if the internal variable will be connected to TPT

Parameters:

functionName - The name of the function

internalVariableName - The name of the internal variable

Returns:

If the internal variable will be connected to TPT

Throws:

java.rmi.RemoteException - remote communication problem