Package com.piketec.tpt.api.steplist

Interface CompareStep

All Superinterfaces:

IdentifiableRemote, java.rmi.Remote, Step, TptRemote

public interface CompareStep
extends Step

This Step provides the possibility to evaluate a comparison during test execution.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	CompareStep.CompareType	The possible compare types.

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
CompareStep.CompareType	getCompareType()
java.lang.String	getLeftHandSideExpression()
Operator	getOperator()
java.lang.String	getRightHandSideExpression()
java.lang.String	getTolerance()
boolean	isRelativeTolerance()	true iff the tolerance shall be considered as relative tolerance in percent [%].
boolean	isToleranceFromScaling()
void	setCompareType(CompareStep.CompareType cmptype)	Determines when the comparison is evaluated.
void	setLeftHandSideExpression(java.lang.String expr)	Determines the left-hand side term for the comparison.
void	setOperator(Operator operator)	Sets the operator for the comparison.
void	setRelativeTolerance(boolean relativeTolerance)	true iff the tolerance shall be considered as relative tolerance in percent [%].
void	setRightHandSideExpression(java.lang.String expr)	Determines the right-hand side term for the comparison.
void	setTolerance(java.lang.String expr)	Sets the explicit tolerance for this comparison.
void	setToleranceFromScaling(boolean tolfromscaling)	Set to true if a tolerance from scaling is used instead of the explicit 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

getLeftHandSideExpression

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

Returns:

the left-hand side term for the comparison.

Throws:

java.rmi.RemoteException - remote communication problem

setLeftHandSideExpression

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

Determines the left-hand side term for the comparison.

Parameters:

expr - expression for left hand side

Throws:

java.rmi.RemoteException - remote communication problem

getRightHandSideExpression

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

Returns:

the right-hand side term for the comparison.

Throws:

java.rmi.RemoteException - remote communication problem

setRightHandSideExpression

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

Determines the right-hand side term for the comparison.

Parameters:

expr - expression for right hand side

Throws:

java.rmi.RemoteException - remote communication problem

setTolerance

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

Sets the explicit 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 explicit tolerance for this comparison.

Throws:

java.rmi.RemoteException - remote communication problem

setRelativeTolerance

void setRelativeTolerance(boolean relativeTolerance)
                   throws java.rmi.RemoteException

true iff the tolerance shall be considered as relative tolerance in percent [%]. In this case, the tolerance is computed as rhs * tolerance / 100 which means the right hand side expression "rhs" is chosen to specify the actual tolerance.

Parameters:

relativeTolerance - true iff tolerance shall be considered as relative value in percent [%]

Throws:

java.rmi.RemoteException - remote communication problem

isRelativeTolerance

boolean isRelativeTolerance()
                     throws java.rmi.RemoteException

true iff the tolerance shall be considered as relative tolerance in percent [%]. In this case, the tolerance is computed as rhs * tolerance / 100 which means the right hand side expression "rhs" is chosen to specify the actual tolerance.

Returns:

true iff tolerance shall be considered as relative value in percent [%]

Throws:

java.rmi.RemoteException - remote communication problem

setOperator

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

Sets the operator for the comparison.

Parameters:

operator - operator for comparison

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

setCompareType

void setCompareType(CompareStep.CompareType cmptype)
             throws java.rmi.RemoteException

Determines when the comparison is evaluated.

Parameters:

cmptype - type for comparison

Throws:

java.rmi.RemoteException - remote communication problem

getCompareType

CompareStep.CompareType getCompareType()
                                throws java.rmi.RemoteException

Returns:

when the comparison is evaluated.

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 explicit tolerance.

Parameters:

tolfromscaling - true if the tolerance shall 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 explicit tolerance.

Throws:

java.rmi.RemoteException - remote communication problem