Package com.piketec.tpt.api.steplist

Interface ImportSignalStep

All Superinterfaces:

IdentifiableRemote, java.rmi.Remote, Step, TptRemote

public interface ImportSignalStep
extends Step

This Step provides the possibility to import several signals into several declarations.

Field Summary

Fields inherited from interface com.piketec.tpt.api.steplist.Step

CALL_FUNCTION, CHANNEL, COMPARE, DOCUMENTATION, ELSE, ELSE_IF_EXPRESSION, ELSE_IF_VALUE, EMBEDDED_SIGNAL, END, IF_EXPRESSION, IF_VALUE, IMPORT_SIGNAL, MESSAGE_BOX, PARALLEL, PARAMETER, RAMP, RESET_ALL_PARAMETERS, RESET_PARAMETER, RESET_TARGET, TABLE, TESTLET, WAIT, WAIT_EXPRESSION, WAIT_FOR_VALUE, WHILE_EXPRESSION

Method Summary

Modifier and Type	Method	Description
java.util.List<Pair<java.lang.String,java.lang.String>>	getDeclarationAssignment()
java.lang.String	getExcelSheet()
java.lang.String	getFile()
java.lang.String	getTimeAxisName()
java.lang.String	getTimeShift()
boolean	isLinearInterpolation()
void	setDeclarationAssignment(java.util.List<Pair<java.lang.String,java.lang.String>> assignment)	Sets the assignment of declarations to signals in the data file (List of Pair<Declaration Name, Signal Name in File>).
void	setExcelSheet(java.lang.String excelSheet)	Sets the Excel sheet name.
void	setFile(java.lang.String file)	Sets the data file path.
void	setLinearInterpolation(boolean on)	Set to true if linear interpolation mode is enabled, false if last value mode is enabled.
void	setTimeAxisName(java.lang.String name)	Sets an (optional) time axis name.
void	setTimeShift(java.lang.String shift)	Sets the time shift.

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

getIdentifier

Methods inherited from interface com.piketec.tpt.api.steplist.Step

getDocumentation, getProperties, getStepList, getType, isActive, setActive, setDocumentation, setProperties

Method Detail

setDeclarationAssignment

void setDeclarationAssignment(java.util.List<Pair<java.lang.String,java.lang.String>> assignment)
                       throws java.rmi.RemoteException

Sets the assignment of declarations to signals in the data file (List of Pair<Declaration Name, Signal Name in File>). The method will ensure that always at least one declaration-assignment row exits. When assignment is an empty list one row with empty fields will be added.

Parameters:

assignment - all assignments to be imported

Throws:

java.rmi.RemoteException - remote communication problem

getDeclarationAssignment

java.util.List<Pair<java.lang.String,java.lang.String>> getDeclarationAssignment()
                                                                                throws java.rmi.RemoteException

Returns:

a (List of Pair<Declaration Name, Signal Name in File>) with an assignment of imported declarations and their name in the data file.

Throws:

java.rmi.RemoteException - remote communication problem

getFile

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

Returns:

the data file path.

Throws:

java.rmi.RemoteException - remote communication problem

setFile

void setFile(java.lang.String file)
      throws java.rmi.RemoteException,
             ApiException

Sets the data file path.

Parameters:

file - the file path to use for import

Throws:

java.rmi.RemoteException - remote communication problem

ApiException - if file is null or contains a line break

getExcelSheet

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

Returns:

the name of the Excel sheet to be used in case of an Excel import.

Throws:

java.rmi.RemoteException - remote communication problem

setExcelSheet

void setExcelSheet(java.lang.String excelSheet)
            throws java.rmi.RemoteException,
                   ApiException

Sets the Excel sheet name.

Parameters:

excelSheet - the name of the Excel sheet to be used in case of an Excel import

Throws:

java.rmi.RemoteException - remote communication problem

ApiException - if excelSheet is null

getTimeAxisName

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

Returns:

an (optional) time axis name.

Throws:

java.rmi.RemoteException - remote communication problem

setTimeAxisName

void setTimeAxisName(java.lang.String name)
              throws java.rmi.RemoteException,
                     ApiException

Sets an (optional) time axis name.

Parameters:

name - time axis name (optional)

Throws:

java.rmi.RemoteException - remote communication problem

ApiException - if name is null or contains a line break

getTimeShift

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

Returns:

the time shift.

Throws:

java.rmi.RemoteException - remote communication problem

setTimeShift

void setTimeShift(java.lang.String shift)
           throws java.rmi.RemoteException,
                  ApiException

Sets the time shift.

Parameters:

shift - expression for time shift

Throws:

java.rmi.RemoteException - remote communication problem

ApiException - if shift is null or contains a line break

isLinearInterpolation

boolean isLinearInterpolation()
                       throws java.rmi.RemoteException

Returns:

true if the linear interpolation mode is enabled, false if last value mode is enabled.

Throws:

java.rmi.RemoteException - remote communication problem

setLinearInterpolation

void setLinearInterpolation(boolean on)
                     throws java.rmi.RemoteException

Set to true if linear interpolation mode is enabled, false if last value mode is enabled.

Parameters:

on - turn on/off linear interpolation

Throws:

java.rmi.RemoteException - remote communication problem