org.vishia.fbcl.readSource

Class DFlow2EvChain

java.lang.Object

org.vishia.fbcl.readSource.DFlow2EvChain

public class DFlow2EvChain
extends java.lang.Object

Algorithm to find event connections from data connections.

• The entry operation is prc(). this does the following:
  • #connectConst(Write_FBlock_FBwr), createConnectCtorEvents(), createConnectInitEvents(): These three operations connects const, ctor and init with a forward algorithm.
  • An evinMdl 'const' is created if FBlocks, especially VarV_OFB are found with inputs without connection.
  • All ctor events are connected which have no data input. The ctorO is marked as event driven, it is important for ctor with data connection.
  • Adequate done for init.
• #prcbackEventChainFromEvoutMdl(): This starts on the evoutMdl and also evUpdoutMdl and tracks back the graphical connected event flow and data flow to create information about the necessary event flow. For data flow the Din_FBcl.bBreakChain is considered, it is set on a 'ofcDataGet' connection, access data from another event chain. Second, connections to VorZ_OFB are not considered. This operation writes connection information to idxEvoutConn sorted by the prepDst Pin_FBcl.nameFBpin() and also the listEvConn which contains each connection as DFlow2EvChain.Evout4Evin unsorted.

     -----------+                             
      FB12  prepO <-----+   Evout4Evin <---------+     idxEvoutCon        +----->prepDst
     -----------+       |      |   prepDst------.|.-------.|.-------------+           |
                        +---}list2EvoutSrc       |      prepDst.nameFBpin() as Key <--+
     -----------+                                +<---List
      FBx   prepO <-----+                        |
     -----------+       |    Evout4Evin <--------+
                        |       |   prepDst
     -----------+       +----}list2EvoutSrc
      FBy   prepO <----------}
     -----------+            
     

  The event connection is stored backward from the evin'prepDst' because this element is found as key, then more as one possible Join-OR event inputs can be given, often only one, as Element in the List idxEvoutConn and also each element of the DFlow2EvChain.Evout4Evin.list2EvoutSrc contains the Join-AND event outputs. all in backward direction. Join-OR means, more as one event triggers the prepDst event. Join-AND means really a Join_OFB FBlock to Join events, all have to be coming. Respectively all evout 'prepO' should be considered in code order for line-code generation.
  This is for all event connections where a data connection exists.
• prcbackFreeEvin() does adequate for all evin of FBlocks which are not reached from the backward event/data tracking from the module's evoutMdl done in #prcbackEventChainFromEvoutMdl(). With this second operation all Evin_FBcl of the module and all FBlocks should found for connection.
• With this two operation the event connections should reach the evinMdl pins by back tracking. In prcfwdRepresentingEvents() now all evout of all FBlocks are marked via Evout_FBcl.setRepresentingEvent(Evout_FBcl) with the corresponding driven events. This is the first action outside only storing event connection data in idxEvoutConn ( DFlow2EvChain.Evout4Evin ), it is necessary for the next both steps.
• searchUnboundEvoutSrc() is called for such evout which are not driven by an evin because they have only data inputs from other event chains, but not only const. (const are considered by createConnectConstEvents() already). These events are not gathered till now because no evin resp. evoutMdl is existing which is tracked back these evout. As solution: The correspond evin is connected to that evout, which's other evin needs the data. See docu on this operation searchUnboundEvoutSrc() for details.
• cleanupDependingEvents(): This is the essential operation to remove unnecessary event connections. Such event connections are detected till now if an FBlock needs data from an FBlock earlier before, but also from an FBlock near before, which is driven from the evout of the earlier FBlock already. Not removing this unnecessary evout would require some Join-AND FBlocks which are have all events if the last occurs anyway, means they are unnecessary. This operation uses the information about Evout_FBcl.idxRepresentingEvents which are written in prcfwdRepresentingEvents().
• connectEvents() can now really connect the necessary events using the listEvConn and the information about event connection in DFlow2EvChain.Evout4Evin.
  • Whereas also update events are connected due to correspond prepare events. The evUpdinMdl events are stored in DFlow2EvChain.Evout4Evin.evUpdinMdlXXX. For each FBlock which has a correspond evUpdin to the processed evin, and has no data to the evUpdin (presumed), the connection from the evUpdinMdl to the evUpdin of the FBlock can be done.
  • The connection from the evUpdout of FBlocks to the module's evUpdout are already found because the back tracking from any of the evUpdoutMdl through combinatoric FBlocks to the evUpdout of a FBlock are found by this backtracking already.
• propgfwdConditions() is the last action based on all existing event connections. The conditions to events are given in specific evout, then stored in the following evout in the chain stored in Evinout_FBcl.condBits.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	DFlow2EvChain.Evout4Evin Instances of this class are a proxy for the yet not done event connection build during back data tracking for event queue.
protected static class	DFlow2EvChain.EvPrepUpdInQueue Internal structure to store the prepare and update event together in a queue also with the start events of the chain.

Field Summary

Fields

Modifier and Type	Field and Description
private int	ctConnectedEvents Counter of connected events.
protected Evout_FBcl	evinMdl_ctor
protected Evout_FBcl	evinMdl_init
protected int	idEventParallel
private java.util.Map<java.lang.String,java.util.List<DFlow2EvChain.Evout4Evin>>	idxEvinConn
private java.util.Map<java.lang.String,java.util.List<DFlow2EvChain.Evout4Evin>>	idxEvoutConn Contains all raw event connections before it is established in the really connection of the event pins.
private java.util.Map<Evin_FBcl,Evin_FBcl>	idxNotConnectedCtorInitEventsWithData This container stores all non default connected init or ctor evin.
private int	ixChain Index 0...63 or more (TODO) for chains which starts from evin, also from evoutMdl.
(package private) short	ixEvCluster This index marks events which builds a cluster (events of one chain).
(package private) static short	ixEvClusterConst
(package private) static short	ixEvClusterCtor
(package private) static short	ixEvClusterInit
private java.util.List<DFlow2EvChain.Evout4Evin>	listEvConn List of all instances of DFlow2EvChain.Evout4Evin, used for execution of connection.
private java.util.List<FBexpr_FBcl>	listExprEv The order in this list is the bit position in Evinout_FBcl.condBits.
private java.util.List<DFlow2EvChain.Evout4Evin>	listUnboundEvin
protected LogMessage	log
private java.util.TreeMap<java.lang.Long,DFlow2EvChain.EvPrepUpdInQueue>	mapEvPrepUpdInQueue Map to regain the existing instances of the events as bundle of DFlow2EvChain.EvPrepUpdInQueue The key to find is the Evinout_FBcl.idEvent for all for events used with 16 bits (max. 65536 event instances possible) which is assembled to a long value.
protected long	mBitEvinMdlCtor Bits corresponding to Evinout_FBcl.mEvoutClusterStart for the init and the ctor Evout_FBcl of the module's inner interface in Write_Module_FBwr.fbtwMdl in Write_FBtype_FBwr.listEvout That masks are used to detect whether a chain is driven by "init" or "ctor..." event.
protected long	mBitEvinMdlInit Bits corresponding to Evinout_FBcl.mEvoutClusterStart for the init and the ctor Evout_FBcl of the module's inner interface in Write_Module_FBwr.fbtwMdl in Write_FBtype_FBwr.listEvout That masks are used to detect whether a chain is driven by "init" or "ctor..." event.
protected Write_Module_FBwr	mdlWr Set in #prc(Module_FBcl), the only one public routine of this class.
protected Prj_FBcl	prj
(package private) static java.lang.String	sNlIndent
static java.lang.String	version Version, history and license.
private java.util.List<Evin_FBcl>	XXXlistEvUpdin

Constructor Summary

Constructors

Constructor and Description
DFlow2EvChain(Prj_FBcl prj, Write_Module_FBwr mdlwr, LogMessage log)

Method Summary

Modifier and Type	Method and Description
private void	addEvConn(DFlow2EvChain.Evout4Evin evout4Evin)
private void	addNewBackEvin2Queue(Evout_FBcl evoutSrc, Write_FBlock_FBwr fbwSrc, int ixChain, java.util.List<Evin_FBcl> queueEvin) Adds the next entry for further back tracking of evinDst in the queue for back tracking.
private void	addNewEvoutSrc2Evout4Evin(Evin_FBcl XXXevinDst, int XXXixChain, java.util.Map<java.lang.String,java.util.List<Evout_FBcl>> elementListEvoutSrc, DFlow2EvChain.Evout4Evin evout4EvinDin) Adds new evout to DFlow2EvChain.Evout4Evin.list2EvoutSrc.
private void	checkAllNotConnectedCtorInitEventsWithData() Checks all evin in idxNotConnectedCtorInitEventsWithData and writes a log error.
private void	cleanupDependingEvents() This operation tracks the event chain with connection stored in idxEvoutConn and DFlow2EvChain.Evout4Evin forward, uses the Evout_FBcl.isDrivenInChainBy(Evout_FBcl) respectively Evout_FBcl.idxRepresentingEvents and removes evout from DFlow2EvChain.Evout4Evin.list2EvoutSrc which are contained in another event in the same list already, means drives this event and is anyway present.
private void	completeUpdateEvents() Completes the relation between evUpdinMdl and evUpdoutMdl and also from evUpdoutMdl to the evinMdl.
private void	connectConst(Write_FBlock_FBwr fbw, int ixChain) This is used in createConnectConstEvents() for both FBexpr_FBcl and FBaccess_FBcl
private void	connectEvents() Connect the events only due to the listEvConn of the internal event connection instances of type DFlow2EvChain.Evout4Evin.
private void	connectEvin(DFlow2EvChain.Evout4Evin evout4evin) Connects the evin from any FBlock and also from the evoutMdl from its source(s) as described in the DFlow2EvChain.Evout4Evin argument.
private void	createConnectConstEvents() Should be a first const event exist?
private void	createConnectCtorEvent(Write_FBlock_FBwr fbw, PinType_FBcl pintCtor, Evout_FBcl evCtorMdl)
private void	createConnectCtorEvents() Checks whether all FBlocks have their ctor evin.
private void	createConnectInitEvents() Connect the a con graphic connected init event of each FBlock with the module's evinMdl 'init'.
private void	createExprEvCondBits(Write_FBlock_FBwr fbw, Evout_FBcl evinMdl, long[][] condBefore, java.util.List<Evout_FBcl> evqu) Creates condition bits for a given ExprEv on evoutSrc.
private void	createJoinCondBits(Write_FBlock_FBwr fbw, Evout_FBcl evinMdl, java.util.List<Evout_FBcl> evqu)
java.util.List<FBexpr_FBcl>	listExprEv()
void	prc()
private boolean	prcbackDin4Evin(Evin_FBcl evinDst, short ixEvCluster, java.util.List<Evin_FBcl> queueEvin, int ixChainArg, boolean bUpdateChain) Process all DinDst to a given EvinDst ------+ evout-----+ +-------------- ------+ +---->>evin +--->din ------+ | din dout-------+ +---------------
private void	prcbackEvin(Evin_FBcl evinDst, java.util.List<Evin_FBcl> queueEvinArg, int ixChain, boolean bUpdateChain, int causeCall) Tracks back from given evinDst, which is either an evoutMdl or an independent evin on any FBlock, especially States.
private boolean	prcbackEvoutSrcFromDin(Din_FBcl dinDst, Evin_FBcl evinDst, DFlow2EvChain.Evout4Evin evout4EvinDin, short ixEvCluster, java.util.List<Evin_FBcl> queueEvin, int ixChain, boolean bUpdateChain) Checks all dout for given dinDst and fills listEvoutSrc with the necessary source events, and adds following evin to the queue to process evin backward.
private boolean	prcbackEvoutSrcFromEvin(Evin_FBcl evinDst, DFlow2EvChain.Evout4Evin evout4EvinDin, short ixEvCluster, java.util.List<Evin_FBcl> queueEvin, int ixChain) Track the event connection backward for given graphic connection.
private void	prcbackFbwEvin(Write_FBlock_FBwr fbw, java.util.List<Evin_FBcl> queueEvin, int ixChainArg, int causeCall) follow backward all evin from the 'fbw' FBlock instance.
private void	prcbackFreeEvin() Iterates over all existing FBlocks and looks for not used evin.
private void	prcfwdRepresentingEvents() This is the first time where the found event connection by back propagation are used.
private void	prcfwdRepresentingEvents(Evout_FBcl evinMdl, Evout_FBcl evUpdinMdl, Evout_FBcl evoutSrc, java.util.List<Evout_FBcl> evqu)
private void	propgfwdConditions()
private void	propgfwdEvinChainBit() Sets the Pin_FBcl.mEvMdlChain bits for Dout_FBcl with the event chain which drives the dout.
private void	searchUnboundEvoutSrc() This is a specific operation to detect evin of FBlocks without event driven connection.
private void	XXXconnectUpdateEvents()
private void	XXXXXprcbackEventChainFromEvoutMdl() Operation for back tracking event chain starting from the module's evoutMdl.

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.

• 2024-12-01 Hartmut new creation. Before a forward track algorithm was used, but with more and more difficulties. This is a new approach, but follows the approach from ~2018 used for FBcl code generation from Simulink Modules.

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 ist 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

sNlIndent

static java.lang.String sNlIndent

log

protected final LogMessage log

prj

protected final Prj_FBcl prj

mdlWr

protected final Write_Module_FBwr mdlWr

Set in #prc(Module_FBcl), the only one public routine of this class.

evinMdl_init

protected Evout_FBcl evinMdl_init

evinMdl_ctor

protected Evout_FBcl evinMdl_ctor

mBitEvinMdlInit

protected final long mBitEvinMdlInit

Bits corresponding to Evinout_FBcl.mEvoutClusterStart for the init and the ctor Evout_FBcl of the module's inner interface in Write_Module_FBwr.fbtwMdl in Write_FBtype_FBwr.listEvout That masks are used to detect whether a chain is driven by "init" or "ctor..." event.

mBitEvinMdlCtor

protected final long mBitEvinMdlCtor

Bits corresponding to Evinout_FBcl.mEvoutClusterStart for the init and the ctor Evout_FBcl of the module's inner interface in Write_Module_FBwr.fbtwMdl in Write_FBtype_FBwr.listEvout That masks are used to detect whether a chain is driven by "init" or "ctor..." event.

idEventParallel

protected int idEventParallel

ixEvCluster

short ixEvCluster

This index marks events which builds a cluster (events of one chain). The value 1 is used for constant The value 2 is used for constant Used with pre-increment on new evout instances.

ixEvClusterConst

static final short ixEvClusterConst

See Also:

Constant Field Values

ixEvClusterCtor

static final short ixEvClusterCtor

See Also:

Constant Field Values

ixEvClusterInit

static final short ixEvClusterInit

See Also:

Constant Field Values

listExprEv

private final java.util.List<FBexpr_FBcl> listExprEv

The order in this list is the bit position in Evinout_FBcl.condBits. The list is transferred to the Module_FBcl#exprEv, it can be used in code generation to select the name of the FBexpr by given bits.

idxNotConnectedCtorInitEventsWithData

private java.util.Map<Evin_FBcl,Evin_FBcl> idxNotConnectedCtorInitEventsWithData

This container stores all non default connected init or ctor evin. That are evin which has din associated.

• Either they are connected later due to the data flow, then the are removed from here.
• Or in checkAllNotConnectedCtorInitEventsWithData() it is tested whether the connection goes to now propagated data by ctor. That should be then Zout, because else they would be propagated already to this evin. If it is so, then the default init connection is done also here, and removed from this list.
• If an evin is remained in this list, it is reported as 'ERROR not connected event because data flow is missing:'.

listUnboundEvin

private final java.util.List<DFlow2EvChain.Evout4Evin> listUnboundEvin

XXXlistEvUpdin

private final java.util.List<Evin_FBcl> XXXlistEvUpdin

mapEvPrepUpdInQueue

private java.util.TreeMap<java.lang.Long,DFlow2EvChain.EvPrepUpdInQueue> mapEvPrepUpdInQueue

Map to regain the existing instances of the events as bundle of DFlow2EvChain.EvPrepUpdInQueue The key to find is the Evinout_FBcl.idEvent for all for events used with 16 bits (max. 65536 event instances possible) which is assembled to a long value.

idxEvoutConn

private java.util.Map<java.lang.String,java.util.List<DFlow2EvChain.Evout4Evin>> idxEvoutConn

Contains all raw event connections before it is established in the really connection of the event pins. The key for this index is evout.nameFBpin() from any existing evout, also evinMdl.

 ---------+
   fb.evout--->>Evout4Evin       +-----------
                |     evin----->>evin:fb2
                |                +----------
                |
                Evout4Evin       +-----------
                      evin----->>evin:fb3
                                 +----------
 

The value of this index is a List of DFlow2EvChain.Evout4Evin for more as one destination for the evout. Intrinsically only the DFlow2EvChain.Evout4Evin.evin is necessary for the connection aspect. The DFlow2EvChain.Evout4Evin.list2EvoutSrc contains also the fb.evout which is used as key, but also maybe other event sources for the evin.

idxEvinConn

private java.util.Map<java.lang.String,java.util.List<DFlow2EvChain.Evout4Evin>> idxEvinConn

listEvConn

private java.util.List<DFlow2EvChain.Evout4Evin> listEvConn

List of all instances of DFlow2EvChain.Evout4Evin, used for execution of connection.

ixChain

private int ixChain

Index 0...63 or more (TODO) for chains which starts from evin, also from evoutMdl. The first used value is the next after evoutMdl: PinType_FBcl.ixPin.

ctConnectedEvents

private int ctConnectedEvents

Counter of connected events. This is used to detect whether any progress is given in #propgEvent(EvPrepUpdInQueue, List, List) or #prcEventUpd(Evout_FBcl, List). If a progress is not given more as times of nr of evoutSrc in the queues, then the algorithm should be aborted, because there is not progress to expect. Elsewhere the algorithm hangs. This occurs if event inputs are missing, and they are not fulfilled with the other event propagations. Then the module is not proper, but the generation of files should be finished, Which is not proper, this should be seen in evaluation of the result files.

Constructor Detail

DFlow2EvChain

public DFlow2EvChain(Prj_FBcl prj,
                     Write_Module_FBwr mdlwr,
                     LogMessage log)

Method Detail

prc

public void prc()

listExprEv

public java.util.List<FBexpr_FBcl> listExprEv()

createConnectConstEvents

private void createConnectConstEvents()

Should be a first const event exist? to calculate all const values? or is it a quest of the expression? This operation sets all outputs of expression which have no input connected to Dout_FBcl.setToConstant(). So it needs no event connection.

connectConst

private void connectConst(Write_FBlock_FBwr fbw,
                          int ixChain)

This is used in createConnectConstEvents() for both FBexpr_FBcl and FBaccess_FBcl

Parameters:

fbw -

createConnectCtorEvents

private void createConnectCtorEvents()

Checks whether all FBlocks have their ctor evin. If not, create it and connect it with the module's ctor evin.

• If the ctor evin has data connections, then connect it after checking the data connections. This is done starting with #prcbackEvoutSrcFromDin(Din_FBcl, Evin_FBcl, Map, short, List, Evin_FBcl) and last connectEvents()
• If the ctor evin has no data or data without connections (should have a Din_FBcl.sConstant, then connect the ctor evin immediately with the ctor pin of the module.
• If a ctorO output exists, it is associated as PinType_FBcl.addAssociatedInOut(PinType_FBcl) with the ctor.

createConnectCtorEvent

private void createConnectCtorEvent(Write_FBlock_FBwr fbw,
                                    PinType_FBcl pintCtor,
                                    Evout_FBcl evCtorMdl)

createConnectInitEvents

private void createConnectInitEvents()

Connect the a con graphic connected init event of each FBlock with the module's evinMdl 'init'. This regards that each FBlock needs its init.

XXXXXprcbackEventChainFromEvoutMdl

private void XXXXXprcbackEventChainFromEvoutMdl()

Operation for back tracking event chain starting from the module's evoutMdl.

prcbackFreeEvin

private void prcbackFreeEvin()

Iterates over all existing FBlocks and looks for not used evin. Whereby, the evin are iterated from the Type of the FBlock, because they may be never drawn in graphic. It is checked whether the evin are contained in any backward chain by checking Evin_FBcl.ixEvCluster, the default value for 'non used' is -1.

• If the evin is not contained in a chain till now, but is has data inputs, then the event is necessary also for a backward chain to connect the event. It is typical for any set operation (events) without output.
• If such an evin is found, #prcbackDin4EvinConnectEvoutSrc(Evin_FBcl, short, List, Evin_FBcl) is started in a queue with all associated Din pins in the same kind as for all evoutMdl pins.
• If no Din are associated or connected to a found free event, a warning message is created for a evin which cannot automatically connect. This is a special case, the event should be connected in the graphic.

prcbackFbwEvin

private void prcbackFbwEvin(Write_FBlock_FBwr fbw,
                            java.util.List<Evin_FBcl> queueEvin,
                            int ixChainArg,
                            int causeCall)

follow backward all evin from the 'fbw' FBlock instance. 'fbw' is first also the modules output: Write_Module_FBwr.fbwMdl.

Parameters:

fbw - The fbw which all evin are checked, whereas the evin are gotten from the FBtype_FBcl

• if an evin is already handled, its Evin_FBcl.ixEvCluster is not -1. Then it is not handled here again.
• NO: evin which are evUpdin are not handled.

queueEvin -

causeCall -

prcbackEvin

private void prcbackEvin(Evin_FBcl evinDst,
                         java.util.List<Evin_FBcl> queueEvinArg,
                         int ixChain,
                         boolean bUpdateChain,
                         int causeCall)

Tracks back from given evinDst, which is either an evoutMdl or an independent evin on any FBlock, especially States.

• Sets Evinout_FBcl.mEvoutClusterStart to mark which cluster is built with the backward events.

Parameters:

evinDst -

queueEvin -

ixChain -

causeCall -

prcbackDin4Evin

private boolean prcbackDin4Evin(Evin_FBcl evinDst,
                                short ixEvCluster,
                                java.util.List<Evin_FBcl> queueEvin,
                                int ixChainArg,
                                boolean bUpdateChain)

Process all DinDst to a given EvinDst

 ------+
   evout-----+      +--------------
 ------+     +---->>evin 
               +--->din
 ------+       |    din 
    dout-------+    +---------------
 

Parameters:

evinDst - can be also the evoutMdl

ixEvCluster -

queueEvin -

ixChainArg -

Returns:

false if associated din to the evin does not exists or are not connected, else true.

addEvConn

private void addEvConn(DFlow2EvChain.Evout4Evin evout4Evin)

prcbackEvoutSrcFromEvin

private boolean prcbackEvoutSrcFromEvin(Evin_FBcl evinDst,
                                        DFlow2EvChain.Evout4Evin evout4EvinDin,
                                        short ixEvCluster,
                                        java.util.List<Evin_FBcl> queueEvin,
                                        int ixChain)

Track the event connection backward for given graphic connection.

• If an event connection will be found, the proper DFlow2EvChain.Evout4Evin for the maybe given variant is searched, and created if not found. Usual first time it is not found, hence always first created.
• The given graphic connection is then stored in DFlow2EvChain.Evout4Evin.list2EvoutSrc, and the given graphic connection is removed. This is necessary because the event connections may be necessary to sort newly. Given connections in graphic are handled in the same manner as automatic found ones. For adding the evoutSrc the operation #addNewEvoutSrc2Evout4Evin(Evin_FBcl, Evin_FBcl, Map, Map) is called with all found connections.
• if a connection is found, #addNewBackEvin2Queue(Evout_FBcl, Write_FBlock_FBwr, short, List) enters the evin of the source for further back tracking.

Parameters:

evinDst - for this evinDst

idxVariantEvout4EvinDin - Container with all possible DFlow2EvChain.Evout4Evin with the proper variant. It may be first empty, (it is empty in calling environment).

ixEvCluster -

queueEvin - queue for further back tracking.

ixChain - Necessary for Evout4Evin#Evout4Evin(Evin_FBcl, Evin_FBcl, PinConnect_FBcl) for its creation.

Returns:

true if at least one connection is found.

prcbackEvoutSrcFromDin

private boolean prcbackEvoutSrcFromDin(Din_FBcl dinDst,
                                       Evin_FBcl evinDst,
                                       DFlow2EvChain.Evout4Evin evout4EvinDin,
                                       short ixEvCluster,
                                       java.util.List<Evin_FBcl> queueEvin,
                                       int ixChain,
                                       boolean bUpdateChain)

Checks all dout for given dinDst and fills listEvoutSrc with the necessary source events, and adds following evin to the queue to process evin backward.

• iterates over all Pin_FBcl.connectSrc to get all doutSrc, maybe more as one on conditional inputs (join-OR).
  • Checks whether the the doutSrc is a VarZ_OFB PinKind_FBcl.zout and evoutMdl is not an evUpdoutMdl, then this evout is not considered.
  • Checks whether Dout is constant, then it is not considered via Dout_FBcl.isConstant(). The property Dout_FBcl#setConstant() is called during connection of const events, see #connectConst(Write_FBlock_FBwr).
  • Checks whether Dout is THIS, for aggregations, it is not considered.
  • All other Dout are considered:
  If the Dout should be considered:
  • The proper DFlow2EvChain.Evout4Evin for the maybe given variant is searched inside 'idxVariantEvout4EvinDin', and created if not found. On first time it is not found, hence hence here created with the necessary variant from the data PinConnect_FBcl#sVariant.
  • gets the evoutSrc (usual one, possible more) for the given doutSrc and adds it to the reference argument listEvoutSrc.
  • gets evinSrc for all evoutSrc, put it in the queueEvin to handle later in the queue-loop, using #addNewBackEvin2Queue(Evout_FBcl, Write_FBlock_FBwr, short, List).

Parameters:

dinDst - The din which in face.

evinDst - the associated evinDst from where dinDst is associated. It is also the argument to create Evout4Evin#Evout4Evin(Evin_FBcl, Evin_FBcl, PinConnect_FBcl) if not found.

idxVariantEvout4EvinDin - Container with all possible DFlow2EvChain.Evout4Evin with the proper variant. It may be first empty, not empty if other connections are found before.

ixEvCluster - The number or index of the event chain cluster

queueEvin - the queue for processing all back events and data. New found evin are added to.

ixChain - Information of the evoutMdl, especially whether it is an evUpdoutMdl or evoutMdl. It is null on calling in prcbackFreeEvin(), but given on calling on #prcbackEventChainFromEvoutMdl(). It is also the argument to create Evout4Evin#Evout4Evin(Evin_FBcl, Evin_FBcl, PinConnect_FBcl)

Returns:

true if at least one connected dout was found.

addNewEvoutSrc2Evout4Evin

private void addNewEvoutSrc2Evout4Evin(Evin_FBcl XXXevinDst,
                                       int XXXixChain,
                                       java.util.Map<java.lang.String,java.util.List<Evout_FBcl>> elementListEvoutSrc,
                                       DFlow2EvChain.Evout4Evin evout4EvinDin)

Adds new evout to DFlow2EvChain.Evout4Evin.list2EvoutSrc. This operation is called only inside #prcbackEvoutSrcFromDin(Din_FBcl, Evin_FBcl, Map, short, List, Evin_FBcl) and #prcbackDin4EvinConnectEvoutSrc(Evin_FBcl, short, List, Evin_FBcl) to store found evout.

• The evout to add are sorted to variants, AND events and OR events. 'idxVariantListEvoutSrc' contains in the first Map variants (key is PinConnect_FBcl#sVariant), in the second Map AND evout lists for more as one element to one tested Din_FBcl and in the third List OR events for more as one connection to the same element of the tested Din_FBcl. The key of the second Map is not important here, the Map is evaluated only by Map.values().
• it means to associated events there are internally three loops:
  • First for variants, it searches the proper DFlow2EvChain.Evout4Evin from 'idxVariantEvout4EvinDin'
  • Second for inputs to different elements to the same Din, which should be AND connected if different Evout are used. This will be force more Inputs for a necessary Join_OFB as JOIN_... FBlock. It means it creates one entry in the 'List>' in DFlow2EvChain.Evout4Evin.list2EvoutSrc for the specific variant with exact this given 'listEvoutSrc'.
  • But before, it tests whether exact the same Evout_FBcl maybe in another order are already contained in the DFlow2EvChain.Evout4Evin.list2EvoutSrc. This is the typical case if more connections comes from the same FBlock as source and their with the same Evout. Then a secondary entry of the 'List' is not done, to save effort also on evaluation.
  • Third for more as one evout to the same evin as OR. Often the third list contains only one element. This third list will be force OR events on one JOIN input.
• If for one variant only "init" from the evinmdl is found, this is set as guard. Further evout connections should regard this guard. This is because init events should not mixed with runtime events.

Parameters:

XXXevinDst -

XXXevoutMdl -

idxVariantListEvoutSrc - found evoutSrc for given variants.

idxVariantEvout4EvinDin - index of DFlow2EvChain.Evout4Evin to add the evout.

addNewBackEvin2Queue

private void addNewBackEvin2Queue(Evout_FBcl evoutSrc,
                                  Write_FBlock_FBwr fbwSrc,
                                  int ixChain,
                                  java.util.List<Evin_FBcl> queueEvin)

Adds the next entry for further back tracking of evinDst in the queue for back tracking.

Parameters:

evoutSrc - from this evoutSrc the correspond evinSrc (may be more as one) will be detected.

fbwSrc -

ixEvCluster -

queueEvin - Queue for back tracking.

prcfwdRepresentingEvents

private void prcfwdRepresentingEvents()

This is the first time where the found event connection by back propagation are used. It starts from the evinMdl pins, uses the idxEvoutConn to search the connection for the evout and continues on the evin. Note that the key of idxEvoutConn is the fb.name of the evout. a log is written which can be studied afterwards whether all connections are met.

prcfwdRepresentingEvents

private void prcfwdRepresentingEvents(Evout_FBcl evinMdl,
                                      Evout_FBcl evUpdinMdl,
                                      Evout_FBcl evoutSrc,
                                      java.util.List<Evout_FBcl> evqu)

searchUnboundEvoutSrc

private void searchUnboundEvoutSrc()

This is a specific operation to detect evin of FBlocks without event driven connection. It occurs if the Din of the evin are only feed with state variables (VarZ_OFB), or also if it is a source not driven by data, but just used (necessary). Then this evin is connected with the same evout of the destination FBlock which needs the data. It means the evin occurs if the dout are necessary. It is on demand.

cleanupDependingEvents

private void cleanupDependingEvents()

This operation tracks the event chain with connection stored in idxEvoutConn and DFlow2EvChain.Evout4Evin forward, uses the Evout_FBcl.isDrivenInChainBy(Evout_FBcl) respectively Evout_FBcl.idxRepresentingEvents and removes evout from DFlow2EvChain.Evout4Evin.list2EvoutSrc which are contained in another event in the same list already, means drives this event and is anyway present.
With this action some unnecessary (stupid) Join of events will be prevented.

 evout1---+------------------------->>this event is unnecessary
          |                      +-->>evoutX contains evout1
          +->>evinX=>>FB=evoutX--+
 

connectEvents

private void connectEvents()

Connect the events only due to the listEvConn of the internal event connection instances of type DFlow2EvChain.Evout4Evin.
This operation does not track through the events, only connect it from list. The listEvConn contains the evin as dst and the evoutSrc in a 2-stage list. See DFlow2EvChain.Evout4Evin. It means the connection is described backward from evin to all evoutSrc. A special handling for 'init' is done, see connectEvin(Evout4Evin).

connectEvin

private void connectEvin(DFlow2EvChain.Evout4Evin evout4evin)

Connects the evin from any FBlock and also from the evoutMdl from its source(s) as described in the DFlow2EvChain.Evout4Evin argument.
Special handling if 'init' is one of the driving events

• the evin is 'init',
• And one of the evoutSrc from DFlow2EvChain.Evout4Evin.list2EvoutSrc is the module's evinMdl 'init', then only this 'init' is connected, stored locally in <:evinMdlInit:> all other evoutSrc are ignored,
• Else, it should be the built guard, JOIN...J is connected, it is build correct with the init.
• If the evin is not 'init', then the immediately evoutSrc 'init' is not connected, if the fbdst of the evin has a pin 'init'.
• the maybe build JOIN is connected, because JOIN is only built if no of the evoutSrc is 'init'
• if the fbdst of the evin has not a pin 'init', then 'initMdl' is connected, because it is especially an expression to built the input for init.
• If the list of driving events DFlow2EvChain.Evout4Evin.list2EvoutSrc has indirect the evinMdl 'init', then the evinDst 'init' needs a guard with the evinMdl 'init'. And the evinDst which is not 'init' needs a guard with all other evoutMdl which are not 'init' (usual one). This guard is built with a JOIN_....

Parameters:

evout4evin -

propgfwdEvinChainBit

private void propgfwdEvinChainBit()

Sets the Pin_FBcl.mEvMdlChain bits for Dout_FBcl with the event chain which drives the dout.

• It runs in a loop starting with Write_FBlock_FBwr.iterEvout() from the inner module's fbw,
• put Evout_FBcl in a queue 'evqu'
• runs in the loop for the evqu:
• dequeues the Evout, track its connected EvinType_FBcl as 'evinDst'
• iterates over all related Evout_FBcl 'evoutNext' to this 'evinDst' via Write_FBlock_FBwr.iterEvout4evin(Evin_FBcl, boolean)
• out the 'evoutNext' in the queue for further dequeuing.
• iterates over all associated Dout_FBcl to this 'evoutNext' using Write_FBlock_FBwr.iterDout4evout(Evout_FBcl, boolean)
• calls Pin_FBcl.setEventChainDriven(Evout_FBcl) 'doutNext' for all dinMdl and for all this dout of FBlocks to mark its association to the several event chains.

This is important for code generation if din have multiple doutSrc and to check the admissibility of the connection.

propgfwdConditions

private void propgfwdConditions()

checkAllNotConnectedCtorInitEventsWithData

private void checkAllNotConnectedCtorInitEventsWithData()

Checks all evin in idxNotConnectedCtorInitEventsWithData and writes a log error.

• It is tested whether the connection goes to now propagated data by ctor. That should be then Zout, because else they would be propagated already to this evin. If it is so, then the default init connection is done also here, and removed from this list.
• If an evin is remained in this list, it is reported as 'ERROR not connected event because data flow is missing:'.

createExprEvCondBits

private void createExprEvCondBits(Write_FBlock_FBwr fbw,
                                  Evout_FBcl evinMdl,
                                  long[][] condBefore,
                                  java.util.List<Evout_FBcl> evqu)

Creates condition bits for a given ExprEv on evoutSrc.

Parameters:

evinMdl - Necessary to register the condition bits calling evinMdl:Evout_FBcl.addConditionBit(int)

evoutSrc - refers in Pin_FBcl.fb the EvExpr FBlock. can have a 'true' and 'false' output, whereby one of this is this conditional output. only this given evoutSrc is marked with the condition bit, the other (may existing) is marked it is used. Note: The FBlock_FBcl is not completed in this phase of execution, the pins are only referenced in the associated Write_FBlock_FBwr.

createJoinCondBits

private void createJoinCondBits(Write_FBlock_FBwr fbw,
                                Evout_FBcl evinMdl,
                                java.util.List<Evout_FBcl> evqu)

completeUpdateEvents

private void completeUpdateEvents()

Completes the relation between evUpdinMdl and evUpdoutMdl and also from evUpdoutMdl to the evinMdl.

• It checks all evinMdl, which have and evUpdinMdl.
• Then gets the evoutMdl, which should be associated via PinType_FBcl.mAssocInOut by the data flow (or manual connection). evinMdl -->> evoutMdl
• Then gets the evUpdoutMdl due to the given evoutMdl, which should be related by positioning in the same GBlock ofbMdlOut, designated by EvinoutType_FBcl.assocEvPrepUpd.
• If it exists, then the evUpdoutMdl is known.
• Not the relation between given evUpdinMdl and evUpdoutmdl can be set via EvinType_FBcl.addAssociatedInOut(EvoutType_FBcl). This is essential to build the 'MASK_upd_updO' in code generation.
• And also the EvinoutType_FBcl.setPrepinEvent(EvinoutType_FBcl) is set between evUpdoutMdl and evinMdl.

This relations are not automatically given. The data to event flow clarifies intrinsically only relation between evin and evout and not between evUpdin and evUpdout.

XXXconnectUpdateEvents

private void XXXconnectUpdateEvents()