Package com.piketec.tpt.api.cplatform

Interface SourceInterface

All Superinterfaces:

IdentifiableRemote, java.rmi.Remote, TptRemote

public interface SourceInterface
extends IdentifiableRemote

This class represents the imported sources interface of a single source file, the "unresolved references" or the wrapper code

Author:

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

Method Summary

Modifier and Type	Method	Description
ImportedClassInstanceSettings	getClassInstance(java.lang.String name)	Get the class instance with the given name
java.util.List<java.lang.String>	getClassInstances()	Get the class instances contained in the associated file
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)	Determine the ConnectionType of the function
java.util.List<java.lang.String>	getFunctions()	Get the functions contained in the associated source file
java.util.List<java.lang.String>	getInternalVariables(java.lang.String functionName)	Get a list of the internal variables of a function in this file
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
SourceFileItem	getSourceFileItem()
java.util.List<java.lang.String>	getVariables()	Get the variables in this source file.
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)	Check if a variable will be connected to TPT
void	setFunctionConnectionType(java.lang.String functionName, FunctionConnectionType connectionType)	Set the way the function will be 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)	Should the variable be connected to TPT

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

getIdentifier

Method Detail

getSourceFileItem

SourceFileItem getSourceFileItem()
                          throws java.rmi.RemoteException

Returns:

The source file associated with this imported sources, null if this SourceInterface is based on wrapper code or on "unresolved references" and variables

Throws:

java.rmi.RemoteException - remote communication problem

isVariableConnected

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

Check if a variable will be connected to TPT

Parameters:

variableName - Name of the variable

Returns:

If the variable will be connected to TPT

Throws:

java.rmi.RemoteException - remote communication problem

setVariableConnected

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

Should the variable be connected to TPT

Parameters:

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

Determine the ConnectionType of the function

Parameters:

functionName - The name of the function

Returns:

The FunctionConnectionType 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 the function will be connected to TPT

Parameters:

functionName - The name of the function

connectionType - The desired FunctionConnectionType

Throws:

java.rmi.RemoteException - remote communication problem

getVariables

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

Get the variables in this source file.

Returns:

The names of the variables in this source file.

Throws:

java.rmi.RemoteException - remote communication problem

getClassInstances

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

Get the class instances contained in the associated file

Returns:

The names of the class instances contained in the associated file.

Throws:

java.rmi.RemoteException - remote communication problem

getFunctions

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

Get the functions contained in the associated source file

Returns:

The names of the functions contained in the associated file.

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

getClassInstance

ImportedClassInstanceSettings getClassInstance(java.lang.String name)
                                        throws java.rmi.RemoteException

Get the class instance with the given name

Parameters:

name - The name of the class instance

Returns:

The class instance with the given name null if no such class exists

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 this file

Parameters:

functionName - The name of the function

Returns:

A list 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