org.vishia.states

Class PrepareTransition

java.lang.Object

org.vishia.states.PrepareTransition

class PrepareTransition
extends java.lang.Object

An instance of this class is created only temporary to build the transition path, set the #exitStates and #entryStates.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.util.ArrayList<StateSimple>	dstStates The destination states filled with buildDstStates() with the length of #dst.
(package private) StateSimple[]	exitStates
(package private) int[]	ixInStatePath The current indices in dstStates.
(package private) StateSimple	state
(package private) StateSimple.Trans	trans
static java.lang.String	version Version, history and license.

Constructor Summary

Constructors

Constructor and Description
PrepareTransition(StateSimple state, StateSimple.Trans trans, StateSimple[] exitStates) Current index to write Trans#entryStatesOld.

Method Summary

Modifier and Type	Method and Description
private void	buildDstStates()
private void	buildEntryStates() Builds the Trans#entryStates with given found common state and given Trans#dstStates and their StateSimple.statePath.
private void	buildExitPath()
private void	checkDefaultAddDstState(StateSimple dstState, int recurs) Checks the given state whether it is a CompositeStateFlat or ParallelState and stores the leaf (only StateSimple) state in dstStates.
private void	createJoinTransitionInTheFirstJoinState() Completes a join transition with the found in a StateParallel with all necessary exit states from all join source states and enters the instance of a join transition in all join source state's StateSimple#transJoins.
(package private) void	execute()
private void	searchOrCreateTimerEvent() Gets the timeout event from the top state or the StateParallel or creates that event.
private void	searchStateCommon() Searches the common state between all dstStates and the source state.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

version

public static final java.lang.String version

Version, history and license.

• 2015-12-20 Hartmut chg: buildDstStates() regards a non-leaf state, uses the stateDefault.
• 2012-09-17 Hartmut improved.
• 2015-03-01 Hartmut created from StateSimple.

Copyright/Copyleft: For this source the LGPL Lesser General Public License, published by the Free Software Foundation is valid. It means:

1. You can use this source without any restriction for any desired purpose.
2. You can redistribute copies of this source to everybody.
3. Every user of this source, also the user of redistribute copies with or without payment, must accept this license for further using.
4. But the LPGL is not appropriate for a whole software product, if this source is only a part of them. It means, the user must publish this part of source, but don't need to publish the whole source of the own product.
5. You can study and modify (improve) this source for own using or for redistribution, but you have to license the modified sources likewise under this LGPL Lesser General Public License. You mustn't delete this Copyright/Copyleft inscription in this source file.

If you are intent to use this sources without publishing its usage, you can get a second license subscribing a special contract with the author.

See Also:

Constant Field Values

trans

final StateSimple.Trans trans

state

final StateSimple state

dstStates

final java.util.ArrayList<StateSimple> dstStates

The destination states filled with buildDstStates() with the length of #dst. Left null if no dst states are given, especially on existing Trans#choice.

exitStates

final StateSimple[] exitStates

ixInStatePath

int[] ixInStatePath

The current indices in dstStates.StateSimple.statePath while evaluating the entry path.

Constructor Detail

PrepareTransition

PrepareTransition(StateSimple state,
                  StateSimple.Trans trans,
                  StateSimple[] exitStates)

Current index to write Trans#entryStatesOld. Pre-increment.

Method Detail

execute

void execute()

buildDstStates

private void buildDstStates()

checkDefaultAddDstState

private void checkDefaultAddDstState(StateSimple dstState,
                                     int recurs)

Checks the given state whether it is a CompositeStateFlat or ParallelState and stores the leaf (only StateSimple) state in dstStates. On a StateCompositeFlat its StateCompositeFlat.stateDefault will be used as destination. On a StateParallel all StateParallel.aParallelstates where checked and taken as destination. If a destination state is not a leaf state, this routine is invoked recursively.

Parameters:

dstState - given destination state of a transition.

recurs - Counter for recursive call. It prevents faulty deep recursion. Aborted on 100 with an IllegalArgumentException.

searchStateCommon

private void searchStateCommon()

Searches the common state between all dstStates and the source state. All states till the common state should be exited. All states from the common state should be entered. As result the ixInStatePath is set with the index after the found stateCommon

buildExitPath

private void buildExitPath()

createJoinTransitionInTheFirstJoinState

private void createJoinTransitionInTheFirstJoinState()

Completes a join transition with the found in a StateParallel with all necessary exit states from all join source states and enters the instance of a join transition in all join source state's StateSimple#transJoins. Before this operation was called, the Trans#exitStates contains only that exit states from that state which defines the TransJoin. But the exit states form all source states are necessary.

Parameters:

trans - The found join transition in a parallel state.

buildEntryStates

private void buildEntryStates()

Builds the Trans#entryStates with given found common state and given Trans#dstStates and their StateSimple.statePath. The first entry state is the StateSimple.statePath[ixInStatePath[0]], the first entry state of the first fork-branch. Then the ixInStatePath[..] is incremented for all fork-branches. All states are written in Trans#entryStates parallel for all branches but states there are the same in the branches are not written twice. Example see Trans#entryStates.

searchOrCreateTimerEvent

private void searchOrCreateTimerEvent()

Gets the timeout event from the top state or the StateParallel or creates that event. All non-parallel states need only one timeout event instance because only one of them is used.