Package com.piketec.tpt.api.steplist
Interface RampStep
-
- All Superinterfaces:
IdentifiableRemote
,java.rmi.Remote
,Step
,TptRemote
public interface RampStep extends Step
A step which provides the possibility to ramp the value of a channel.
-
-
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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getDeclaration()
java.lang.String
getGradient()
java.lang.String
getTarget()
void
setDeclaration(java.lang.String declaration)
Sets the declaration to be ramped.void
setGradient(java.lang.String grad)
Sets the gradient per second.void
setTarget(java.lang.String value)
Sets the target value.-
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 to be ramped.
- Throws:
java.rmi.RemoteException
- remote communication problem
-
setDeclaration
void setDeclaration(java.lang.String declaration) throws java.rmi.RemoteException
Sets the declaration to be ramped.- Parameters:
declaration
- channel/paramter to ramp- Throws:
java.rmi.RemoteException
- remote communication problem
-
getTarget
java.lang.String getTarget() throws java.rmi.RemoteException
- Returns:
- the target value.
- Throws:
java.rmi.RemoteException
- remote communication problem
-
setTarget
void setTarget(java.lang.String value) throws java.rmi.RemoteException
Sets the target value.- Parameters:
value
- target value- Throws:
java.rmi.RemoteException
- remote communication problem
-
getGradient
java.lang.String getGradient() throws java.rmi.RemoteException
- Returns:
- the gradient per second.
- Throws:
java.rmi.RemoteException
- remote communication problem
-
setGradient
void setGradient(java.lang.String grad) throws java.rmi.RemoteException
Sets the gradient per second.- Parameters:
grad
- gradient- Throws:
java.rmi.RemoteException
- remote communication problem
-
-