Package com.piketec.tpt.api.diagram

Interface TransitionSpec

All Superinterfaces:

IdentifiableRemote, NamedObject, java.rmi.Remote, TptRemote, TransitionSpecOrGroup

public interface TransitionSpec
extends TransitionSpecOrGroup

A transition specification defines, when a transition is able to fire (getCondition()) and which actions/stimulations have to be performed if the transition fires (getActions()).

Method Summary

Modifier and Type	Method	Description
java.lang.String	getActions()	Returns the actions to be executed when a transition fires.
java.lang.String	getCompileError()	Returns null if transition specification can be compiled without errors, the compile error message otherwise.
java.lang.String	getCondition()	Returns the precondition that has to be satisfied for the transition to fire.
void	setActions(java.lang.String actions)	Set the actions to be executed when a transition is executed.For a Syntax reference refer to the TPT User Guide, Section "Set a Transition Action"
void	setCondition(java.lang.String condition)	Set the formal precondition to be satisfied for the transition to fire.

Methods inherited from interface com.piketec.tpt.api.IdentifiableRemote

getIdentifier

Methods inherited from interface com.piketec.tpt.api.NamedObject

getName, setName

Methods inherited from interface com.piketec.tpt.api.diagram.TransitionSpecOrGroup

getGroup, getTransition, isGroup, move

Method Detail

getCondition

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

Returns the precondition that has to be satisfied for the transition to fire.

Returns:

The formal precondition as String

Throws:

java.rmi.RemoteException - remote communication problem

setCondition

void setCondition(java.lang.String condition)
           throws java.rmi.RemoteException

Set the formal precondition to be satisfied for the transition to fire. For a syntax reference refer to the TPT User Guide, Section "Set a Transition Action"

Parameters:

condition - The formal condition as String. Null will be reduced to an empty string.

Throws:

java.rmi.RemoteException - remote communication problem

getActions

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

Returns the actions to be executed when a transition fires.

Returns:

The description of the actions as String

Throws:

java.rmi.RemoteException - remote communication problem

setActions

void setActions(java.lang.String actions)
         throws java.rmi.RemoteException

Set the actions to be executed when a transition is executed.For a Syntax reference refer to the TPT User Guide, Section "Set a Transition Action"

Parameters:

actions - The actions as String. Null will be reduced to an empty string.

Throws:

java.rmi.RemoteException - remote communication problem

getCompileError

java.lang.String getCompileError()
                          throws java.rmi.RemoteException,
                                 ApiException

Returns null if transition specification can be compiled without errors, the compile error message otherwise.

Returns:

The compile error message or null

Throws:

ApiException - If transition specification is not part of a project anymore or compiler is inactive for the project.

java.rmi.RemoteException - remote communication problem