org.vishia.fbcl.readOdg

Class OdgMdlStates

java.lang.Object

org.vishia.fbcl.readOdg.OdgMdlStates

public class OdgMdlStates
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	OdgMdlStates.ProcessStateTransCreateAndConnect This is a helper class for data during processStateTransCreateAndConnect(OdgGBlock)

Field Summary

Fields

Modifier and Type	Field and Description
CreateModuleStateM_FBcl	crStm
(package private) OdgModule	gMdl
java.util.Map<java.lang.Integer,OdgGState>	idxGState Index of all graphic GBlocks which presents FBlock_FBcl or FBtype_FBcl, sorted by graphic position or posNr do get reproducible output.
java.util.TreeMap<java.lang.String,OdgGState>	idxGStateByName Index of all graphic FBlocks sorted by the name designation in graphic
java.util.Map<java.lang.Integer,OdgGBlock>	idxGStateTransCond Index of all graphic FBlocks sorted by graphic position or posNr do get reproducible output
java.util.Map<java.lang.String,OdgGBlock>	idxGStateTransCondByName Index of all graphic FBlocks sorted by name only used to ensure unique names
Write_Module_FBwr	mdlw The real module.
(package private) Prj_FBcl	prj The project used for the translation session.

Constructor Summary

Constructors

Constructor and Description
OdgMdlStates(OdgModule gMdl)

Method Summary

Modifier and Type	Method and Description
private void	checkCreateStateDirectConn(OdgGState gState)
private void	completeParentWithDefaultTrans() Completes the OdgGBlock.sName of all states from idxGState with the name of the parent state due to an incoming OdgConnection.ECkind.stateTransDefault connection.
private void	createExprFromText(OdgGBlock gExpr, java.lang.String text, java.lang.String sDefaultOperator) This is (TODO should be ) a common possibility to create DinExpr_FBcl due to the given expression.
private void	createFBclState(OdgGState gState)
private OdgGBlock	createStateTrans(OdgGBlock stateSrc, OdgGBlock stateDst, java.lang.String text, OdgConnection gConOrig)
private void	createTextualConnectionsInStateTrans(OdgGBlock trans, java.lang.String text)
private java.util.List<OdgGState>	detectStatesConnectedViaStateTransInSameLevel(OdgGState gStateSrc) Builds a List of all immediately reached states by OdgConnection.ECkind.stateTrans either as direct connection or as connection over one Transition.
private void	joinStateSameLevel() This operation checks all OdgGState in idxGState and follows the transition of kind OdgConnection.ECkind.stateTrans.
(package private) void	prepareStates() Prepare all states: _A_: First the situation of enclosing and parent states is clarified.
private void	processStateConnections(OdgGBlock gState) This seems to be the older contribution, todo cleanup. care about 'gcon.kind() ... case eventflow:'
private void	processStateTransCreateAndConnect(OdgGBlock gStateTrans) Processes the raw given StateTrans GBlock from graphic.
private void	replaceNameFreeStates() Some States are only drawn because access to outputs.
private int	searchParentNamePos(java.lang.String sName) Searches the first occurrence of "-" or "||" in sName
private int	searchParticularNameEnd(java.lang.String sName) Searches the first occurrence of "-" or "||" in sName
private void	setStateFBclSameLevel(OdgGState gState) Sets the information of states of same level in the FBcl state.
private void	setStateParentAndChildren(CreateFBstate_FBcl wState)
private void	setUniqueParentInSameStatelevel(java.util.Map<OdgGState,OdgGState> statesSameLevel, int idSamelevel) Sets the same properties of all states of the same nested and parallel level.
private void	supplementEnclosingStates(OdgGBlock gState, java.util.TreeMap<java.lang.String,java.lang.String> idxStateAndParent)
private void	toso()

Methods inherited from class java.lang.Object

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

Field Detail

idxGState

public final java.util.Map<java.lang.Integer,OdgGState> idxGState

Index of all graphic GBlocks which presents FBlock_FBcl or FBtype_FBcl, sorted by graphic position or posNr do get reproducible output. The GBlocks are also contained in #idxAllGBlockByGpos for complete report.

idxGStateByName

public final java.util.TreeMap<java.lang.String,OdgGState> idxGStateByName

Index of all graphic FBlocks sorted by the name designation in graphic

idxGStateTransCond

public final java.util.Map<java.lang.Integer,OdgGBlock> idxGStateTransCond

Index of all graphic FBlocks sorted by graphic position or posNr do get reproducible output

idxGStateTransCondByName

public final java.util.Map<java.lang.String,OdgGBlock> idxGStateTransCondByName

Index of all graphic FBlocks sorted by name only used to ensure unique names

gMdl

final OdgModule gMdl

prj

final Prj_FBcl prj

The project used for the translation session.

mdlw

public final Write_Module_FBwr mdlw

The real module.

crStm

public final CreateModuleStateM_FBcl crStm

Constructor Detail

OdgMdlStates

OdgMdlStates(OdgModule gMdl)

Method Detail

prepareStates

void prepareStates()

Prepare all states:

• _A_: First the situation of enclosing and parent states is clarified. This is done calling completeParentWithDefaultTrans(), supplementEnclosingStates(OdgGBlock, TreeMap), joinStateSameLevel().
• _B_:As result of this, all states have their names till the top level state. Then the OdgGBlock.sName of the states is replaced, '||' and '-' replaced by '_' to ensure, it is an identifier.
• _C_: For direct connected states with event and condition in the transition, the necessary OdgGBlock as transition is created and filled with the given textual inputs.
• _D_: Create the Write_FBlock_FBwr for all states, register in OdgGBlock.fbw and store it in Write_Module_FBwr#idxStateOFB. This is done calling Write_Module_FBwr#getCreateState(String, String, org.vishia.fbcl.fblock.XY_FBcl, String). Now the states are known in the FBcl oriented Module.
• _E_: For all Write_Module_FBwr#idxStateOFB #setStateParentAndChildren(Write_FBlock_FBwr)

completeParentWithDefaultTrans

private void completeParentWithDefaultTrans()

Completes the OdgGBlock.sName of all states from idxGState with the name of the parent state due to an incoming OdgConnection.ECkind.stateTransDefault connection. This is one of the graphical alternative instead assembly the state in its enclosing parent state.

If the default transition goes to a nested state, the parent situation is already clarified. Then the state is marked as default state only.

If this transition do not come from the immediately enclosing state, an error message is shown.

supplementEnclosingStates

private void supplementEnclosingStates(OdgGBlock gState,
                                       java.util.TreeMap<java.lang.String,java.lang.String> idxStateAndParent)

joinStateSameLevel

private void joinStateSameLevel()

This operation checks all OdgGState in idxGState and follows the transition of kind OdgConnection.ECkind.stateTrans. This transitions should connect only states of the same nested or parallel level.

• A list of immediately connected states via OdgConnection.ECkind.stateTrans check is created by detectStatesConnectedViaStateTransInSameLevel(OdgGState). Here internally it is the variable 'statesDst'.
• The HashMap 'statesProcessed' is used to ensure that each state is processed only once. This is because the same state will be found also in 'stateDst'.
• If one state from idxGState is found to process (not stored already in HashMap 'statesProcessed'), then is assumes, it is a not processed level.
• The HashMap 'statesSameLevel' is created to gather all states of the same level, this 'gState' is the first member.
• Then in a do-while from this first 'gState' as 'gStateToPrc' for all found states in this level:
  • the connected states of the same level are found and stored in a local list 'statesDst', calling detectStatesConnectedViaStateTransInSameLevel(OdgGState). They are then stored in 'statesSameLevel', as well as all states in the given graphical enclosing state. Note that states of the same level connected with OdgConnection.ECkind.stateTrans can be arranged in different enclosing states.
  • From these 'statesSameLevel', meanwhile completed with more states, the states are checked whether they are not in HashMap 'statesProcessed'. The first found not processed state from this 'statesSameLevel' is now processed furthermore in this loop.
  • This loop for all 'statesSameLevel' is finished if all states in this HashMap are processed (all found in HashMap 'statesProcessed').
• Now we have a HashMap 'statesSameLevel'. This HashMap is copied to a simple LinkedList 'listStatesSameLevel'. This is done in the operation setUniqueParentInSameStatelevel(Map, int). It stores this list in OdgGState.listStatesSameLevel.
• Hence the evaluation of the GState can recognize which states are in the same level in graphic. With the graphic information for each OdgGState processed in createFBclState(OdgGState) this information is then stored last in State_FBcl.listStateSameLevel for the whole graphic (all pages).

As result,

• all OdgGBlock.sName are completed possible till the root parent,
• OdgGState.listStatesSameLevel is set with the same list in all states from the same level.
• OdgGState.idSameLevel is set.
• No more necessary: and the mask Din_FBcl pin is set with the same value.

detectStatesConnectedViaStateTransInSameLevel

private java.util.List<OdgGState> detectStatesConnectedViaStateTransInSameLevel(OdgGState gStateSrc)

Builds a List of all immediately reached states by OdgConnection.ECkind.stateTrans either as direct connection or as connection over one Transition.

Parameters:

gStateSrc -

Returns:

List of all neighbor states of the same level.

setUniqueParentInSameStatelevel

private void setUniqueParentInSameStatelevel(java.util.Map<OdgGState,OdgGState> statesSameLevel,
                                             int idSamelevel)

Sets the same properties of all states of the same nested and parallel level. It is only called from joinStateSameLevel().

• _A_: All states of 'statesSameLevel' are checked for the name. At least one should have the complete name. The length of the parent part of the name, after the first '-' or '||' is checked. The longest Name is stored in 'sNameParent'. All shorter names are checked, whether the 'sNameParent' starts with this name. Note that the root of parents is right side.
• If one name does not match, the "ERROR The name of all states of the same level should have the same parent name:" is logged.

Parameters:

statesSameLevel - Map contains all states.

replaceNameFreeStates

private void replaceNameFreeStates()

Some States are only drawn because access to outputs. They may not have the full qualified parent name. Try to assert it.

• First from idxGState all top states are extracted, stored internally in 'idxNameTopStates'. This is often exact one top state, but sometimes more as one if the module has more as one independent state machine. If a top state does not exist, "StM" is set as name of the top state, and 'bNoTopState' = true.
• Then from idxGState all states are examined whether they ends with "-<&TopState>" whereby <&TopState> is one of the given top states.
  • States ending with "-<&TopState>" are stored in the internal NavigableMap 'idxNames'.
  • States not ending with "-<&TopState>" are stored internally in 'statesWithoutTop'.
• Then, this 'statesWithoutTop' are searched in 'idxNames' via NavigableMap.ceilingKey(Object) with its OdgGBlock.sName as key. They should be found by the first hit, because anywhere other the same state should be existing in the graphic with this name, which has the information about the parents and the root, and starts with the same name. This name is taken.
• If the name is not found in the internal 'idxNames' but a top state is not existing ('bNoTopState' == true) then "-StM" is appended. This is for maybe all states, excluded states determined with "Name-StM".
• If the name is not found in the internal 'idxNames' then the name is faulty, and the error message
  "ERROR Graphic: StateParent not able to find for the free state: ..." is output.

First a NavigableMap with all

checkCreateStateDirectConn

private void checkCreateStateDirectConn(OdgGState gState)

createStateTrans

private OdgGBlock createStateTrans(OdgGBlock stateSrc,
                                   OdgGBlock stateDst,
                                   java.lang.String text,
                                   OdgConnection gConOrig)

createFBclState

private void createFBclState(OdgGState gState)

setStateFBclSameLevel

private void setStateFBclSameLevel(OdgGState gState)

Sets the information of states of same level in the FBcl state.

Parameters:

wState -

setStateParentAndChildren

private void setStateParentAndChildren(CreateFBstate_FBcl wState)

processStateTransCreateAndConnect

private void processStateTransCreateAndConnect(OdgGBlock gStateTrans)

Processes the raw given StateTrans GBlock from graphic. State is:

• StateTransConn which are created due to text on state transitions from state to state are already created. This is done in #checkCreateStateDirectConn(OdgGBlock) called before.
• Texts inside a StateTransConn for textual events and connections are not evaluated. This is done here. #processFBlockPinGraphicConnectionTextual(OdgGPin)
• Texts on transitions to StateTransCond are not evaluated, also done here.

Analyzes the special connections in OdgGBlock.fbPinSrc and OdgGBlock.fbPinDst for the given state transition OdgGBlock with its pins OdgGBlock.idxPin from graphic and builds the real necessary either OdgGPin and OdgConnection for further standard processing to FBcl-data or builds immediately the FBcl level pins and connections, though it is before execution of OdgModule.createFBPins_duetoGBlockPins() and OdgModule.createFBclConnectionsFromGraphic().

• _A_: First textual given connections inside 'gStateTrans' OdgNameTypeArray.descr are processed. That are events and conditions for the transition from other GBlocks. it is done on Odg level (not for FBcl blocks) because the appropriate FBcl level blocks and pins may not existing till now. let's create and wire later for FBcl level.
• _B_: Then the StateTransCond (derived from FBexpr_FBcl and the appropriated Write_FBlock_FBwr for it is created. Note that creation of the necessary Write_FBlock_FBwr instances is also done for other OdgGBlock. The reference to it is stored in 'gStateTrans': OdgGBlock.fbw, and also the type in OdgGBlock.fbt. The type for the 'gStateTrans' is StdLibFBlocks_FBcl.fbtStateTrans_OFB or 'ExprEv_OFB', which has the necessary 'true' output in the type.
• _evoutTrue_: Creates the evout 'true' on the FBcl instance, any time necessary, for connection here later.
• _prepSrc_: Check all incoming transitions to 'fbPinDst' whether either it is an event connection, then getCreate the odgGPin 'prep' and moves the connection from 'fbPinDst' to the event pin (removes on 'fbPinDst').
• _fbPinsrc_: It is expected, but here tested whether outgoing connections from the OdgGBlock are given, stored in the OdgGBlock.fbPinSrc. It checks all connections:
  • _stateDst_: If the connection is of kind OdgConnection.ECkind.stateTrans or 'stateTransChg' or also 'stateTransDefault', then it is a graphic connection to the destination state. It means OdgConnection.piDst and its OdgGPin.fbg as 'gStateDst' should be instance of OdgGState. Then the appropriate CreateFBstate_FBcl 'crStateDst' is gotten from its OdgGBlock.fbw.
  • This 'crStateDst' is stored in the list 'listCrStateDst'.
  • The name of the transition FBexpr_FBcl is completed left side with the stateDst name.
  • _transDstText_: It is tested whether the transition have a text in graphic. If yes, then Then createTextualConnectionsInStateTrans(OdgGBlock, String) is called. The transition can especially have an event to switch the state also on the outgoing connection. This is often sensible for Join-transitions as information for the whole transition. The event should be recognize before the following step:
  • _prepDst_: If the connection Kind is OdgConnection.ECkind.eventflow, then an event flow is drawn from the transition to any evin pin. This is the transition event operation. Then the event flow is changed from the fbPinSrc pin to the true event pin.
• _fbPinDst_: It is expected, but here tested whether outgoing connections from the OdgGBlock are given, stored in the OdgGBlock.fbPinDst. It checks all connections:
  • _stateSrc_: Incoming connections of kind OdgConnection.ECkind.stateTrans or 'stateTransChg' or also 'stateTransDefault' have the OdgGBlock 'gStateSrc' as source, it is the only one or more source states for the transition.
  • 'crStateSrc' is gotten from OdgGBlock.fbw.
  • _crStateParent_: via #searchCrStateParent(CreateFBstate_FBcl, List) the parent state
  • _evinSetStateDst_: The outgoing transition connection to a state should set this state via its evin 'set'. For that on the CreateFBstate_FBcl 'crStateDst' this evin 'set' in is
• ??Adds the StateTrans as Expression to Write_Module_FBwr.idxAllFBlock and Write_Module_FBwr.idxFBexpr
• ??Adds the StateTrans as Expression to Module_FBcl.idxFBlock
• removes the found connection on both sides
• Create a new OdgConnection to connect the source event now with the new 'prep' pin.

Parameters:

gStateTrans -

processStateConnections

private void processStateConnections(OdgGBlock gState)

This seems to be the older contribution, todo cleanup. care about 'gcon.kind() ... case eventflow:'

Parameters:

gState -

toso

private void toso()

createTextualConnectionsInStateTrans

private void createTextualConnectionsInStateTrans(OdgGBlock trans,
                                                  java.lang.String text)

createExprFromText

private void createExprFromText(OdgGBlock gExpr,
                                java.lang.String text,
                                java.lang.String sDefaultOperator)

This is (TODO should be ) a common possibility to create DinExpr_FBcl due to the given expression.

Parameters:

text -

searchParticularNameEnd

private int searchParticularNameEnd(java.lang.String sName)

Searches the first occurrence of "-" or "||" in sName

Parameters:

sName -

Returns:

length of the particular name before '-' or '||', length of sName if separator chars are not found.

searchParentNamePos

private int searchParentNamePos(java.lang.String sName)

Searches the first occurrence of "-" or "||" in sName

Parameters:

sName -

Returns:

length of the particular name before '-' or '||', length of sName if separator chars are not found.