Package com.piketec.tpt.api.steplist

Interface EmbeddedSignalStep

All Superinterfaces:

IdentifiableRemote, java.rmi.Remote, Step, TptRemote

public interface EmbeddedSignalStep
extends Step

This Step provides the possibility to define a channel with given signal data.

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.lang.String	getDeclaration()
java.util.List<Pair<java.lang.Long,java.lang.String>>	getSamplePoints()
boolean	isLinearInterpolation()
void	setDeclaration(java.lang.String name)	Sets the embedded signal.
void	setLinearInterpolation(boolean on)	Set to true if linear interpolation mode is enabled, false if last value mode is enabled.
void	setSamplePoints(java.util.List<Pair<java.lang.Long,java.lang.String>> signalPoints, Type type)	Sets a map with all sample points.

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

getDeclaration

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

Returns:

the embedded signal.

Throws:

java.rmi.RemoteException - remote communication problem

setDeclaration

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

Sets the embedded signal.

Parameters:

name - name of the channel to define

Throws:

java.rmi.RemoteException - remote communication problem

getSamplePoints

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

Returns:

a map with all sample points. Look at setSamplePoints(List, Type) for further information.

Throws:

java.rmi.RemoteException - remote communication problem

setSamplePoints

void setSamplePoints(java.util.List<Pair<java.lang.Long,java.lang.String>> signalPoints,
                     Type type)
              throws java.rmi.RemoteException

Sets a map with all sample points. The Long parameter represents the time in micro seconds and the String the value of the signal at this time point. Values can be primitives or arrays of primitives.

Parameters:

signalPoints - list of all samples

type - data type to use

Throws:

java.rmi.RemoteException - remote communication problem

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 - linear interpolation on/off

Throws:

java.rmi.RemoteException - remote communication problem