Package com.piketec.tpt.api.steplist

Interface IfStep

All Superinterfaces:

IdentifiableRemote, java.rmi.Remote, Step, TptRemote

public interface IfStep
extends Step

This Step provides the possibility to use an if-block in a StepListScenario

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.lang.String	getDefinition()
Operator	getOperator()
java.lang.String	getTolerance()
boolean	isAlways()
boolean	isToleranceFromScaling()
void	setAlways(boolean value)	Determines if this step should run "always".
void	setDeclaration(java.lang.String name)	Determines the declaration used for the comparison.
void	setDefinition(java.lang.String def)	Determines definition side term for the comparison.
void	setOperator(Operator op)	Sets the operator for the comparison.
void	setTolerance(java.lang.String name)	Sets the local tolerance for this comparison.
void	setToleranceFromScaling(boolean tolerance)	Set to true if a tolerance from scaling is used instead of the local tolerance.

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 declaration for the comparison.

Throws:

java.rmi.RemoteException - remote communication problem

setDeclaration

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

Determines the declaration used for the comparison.

Parameters:

name - name of the channel/parameter to compare

Throws:

java.rmi.RemoteException - remote communication problem

getDefinition

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

Returns:

the definition side term for the comparison.

Throws:

java.rmi.RemoteException - remote communication problem

setDefinition

void setDefinition(java.lang.String def)
            throws java.rmi.RemoteException

Determines definition side term for the comparison.

Parameters:

def - expression to compare with

Throws:

java.rmi.RemoteException - remote communication problem

getTolerance

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

Returns:

the local tolerance for this comparison.

Throws:

java.rmi.RemoteException - remote communication problem

setTolerance

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

Sets the local tolerance for this comparison.

Parameters:

name - tolerance value

Throws:

java.rmi.RemoteException - remote communication problem

getOperator

Operator getOperator()
              throws java.rmi.RemoteException

Returns:

the operator for the comparison.

Throws:

java.rmi.RemoteException - remote communication problem

setOperator

void setOperator(Operator op)
          throws java.rmi.RemoteException

Sets the operator for the comparison.

Parameters:

op - operator to use for comparison

Throws:

java.rmi.RemoteException - remote communication problem

isToleranceFromScaling

boolean isToleranceFromScaling()
                        throws java.rmi.RemoteException

Returns:

true if a tolerance from scaling is used instead of the local tolerance.

Throws:

java.rmi.RemoteException - remote communication problem

setToleranceFromScaling

void setToleranceFromScaling(boolean tolerance)
                      throws java.rmi.RemoteException

Set to true if a tolerance from scaling is used instead of the local tolerance.

Parameters:

tolerance - turn on to derive tolerance from scaling coeffs

Throws:

java.rmi.RemoteException - remote communication problem

isAlways

boolean isAlways()
          throws java.rmi.RemoteException

Returns:

true if this step should run "always".

Throws:

java.rmi.RemoteException - remote communication problem

setAlways

void setAlways(boolean value)
        throws java.rmi.RemoteException

Determines if this step should run "always".

Parameters:

value - true to use always semantics

Throws:

java.rmi.RemoteException - remote communication problem