Package com.piketec.tpt.api.steplist

Interface WaitValueStep

All Superinterfaces:

IdentifiableRemote, java.rmi.Remote, Step, TptRemote

public interface WaitValueStep
extends Step

This Step provides the possibility to execute steps in a do-while-loop as long as the comparison condition is satisfied.

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	isAssess()
boolean	isJoinWithNext()
boolean	isToleranceFromScaling()
void	setAssess(boolean assess)	Sets if the step is assessed in the report.
void	setDeclaration(java.lang.String declaration)	Determines the declaration for the comparison.
void	setDefinition(java.lang.String value)	Determines the comparative value.
void	setJoinWithNext(boolean value)	Sets if this step is only satisfied if the next step is satisfied, too.
void	setOperator(Operator op)	Sets the operator for the comparison.
void	setTolerance(java.lang.String expr)	Sets the local tolerance for this comparison.
void	setToleranceFromScaling(boolean tolfromscaling)	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 declaration)
             throws java.rmi.RemoteException

Determines the declaration for the comparison.

Parameters:

declaration - left-hand side variable name

Throws:

java.rmi.RemoteException - remote communication problem

getDefinition

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

Returns:

the comparative value.

Throws:

java.rmi.RemoteException - remote communication problem

setDefinition

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

Determines the comparative value.

Parameters:

value - right-hand side expression

Throws:

java.rmi.RemoteException - remote communication problem

setTolerance

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

Sets the local tolerance for this comparison.

Parameters:

expr - tolerance expression

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

setOperator

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

Sets the operator for the comparison.

Parameters:

op - operator

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

setToleranceFromScaling

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

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

Parameters:

tolfromscaling - true if the tolerance value should be derived from scaling coeffs

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

isAssess

boolean isAssess()
          throws java.rmi.RemoteException

Returns:

true if the step is assessed in the report.

Throws:

java.rmi.RemoteException - remote communication problem

setAssess

void setAssess(boolean assess)
        throws java.rmi.RemoteException

Sets if the step is assessed in the report.

Parameters:

assess - true if this steps should be considered in assessment

Throws:

java.rmi.RemoteException - remote communication problem

isJoinWithNext

boolean isJoinWithNext()
                throws java.rmi.RemoteException

Returns:

true if this step is only satisfied if the next step is satisfied, too.

Throws:

java.rmi.RemoteException - remote communication problem

setJoinWithNext

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

Sets if this step is only satisfied if the next step is satisfied, too.

Parameters:

value - true if this step should be combined with the next step of the same type

Throws:

java.rmi.RemoteException - remote communication problem