org.vishia.fbcl.fblock

Class Evout_FBcl

java.lang.Object

org.vishia.fbcl.fblock.Pin_FBcl

org.vishia.fbcl.fblock.Evinout_FBcl

org.vishia.fbcl.fblock.Evout_FBcl

All Implemented Interfaces:

org.vishia.util.ToStringBuilder

public class Evout_FBcl
extends Evinout_FBcl

Nested Class Summary

Nested classes/interfaces inherited from class org.vishia.fbcl.fblock.Pin_FBcl

Pin_FBcl.XXXXXEKind

Field Summary

Fields

Modifier and Type	Field and Description
int	idEventParallel It is an id to distinguish parallel event chains.
protected java.util.Map<Evout_FBcl,Evout_FBcl>	idxRepresentingEvents Used while build the event chain.
static int[]	isevinDriven
static java.util.Map<Evout_FBcl,Evout_FBcl>	null_idxRepresentingEvents
static Evout_FBcl[]	nullArray

Fields inherited from class org.vishia.fbcl.fblock.Evinout_FBcl

condBits, idEvent, idEventCt, mEvinClusterEnd, mEvoutClusterStart, nrEventInChain

Fields inherited from class org.vishia.fbcl.fblock.Pin_FBcl

connectDst, connectSrc, fb, name, pint, version, xy

Constructor Summary

Constructors

Constructor and Description
Evout_FBcl(PinType_FBcl pint, FBlock_FBcl fb, XY_FBcl xy) Ctor constructs an evout instance with the same name as stored in the type.
Evout_FBcl(PinType_FBcl pint, java.lang.String name, FBlock_FBcl fb, XY_FBcl xy) Ctor constructs an evout instance with a given specific name, may be another than the name in the type.

Method Summary

Modifier and Type	Method and Description
boolean	addConditionBit(int nrBit) Adds one bit with given number to each element of the second dimension of Evinout_FBcl.condBits.
boolean	andConditionBits(long[][] mask) If a Join_OFB is on input of a FBlock, all conditions of this events should be merged to AND and OR conditions for the Join event output.
java.lang.Iterable<Evin_FBcl>	connectDst()
long[]	getConditionMaskMdl()
boolean	getEvMdlGuardBecauseInit(java.util.List<Evout_FBcl> listEvMdlGuard, boolean bDstInit) Searches in all sources of the eventchain (in idxRepresentingEvents events from the modules inputs.
int	getLastCondBit() Returns the bit number of the last set bit in Evinout_FBcl.condBits
boolean	isDrivenByInit(Evout_FBcl evoutSrc)
boolean	isDrivenInChainBy(Evout_FBcl evoutSrc)
boolean	isDrivenInChainByAnyEvent()
boolean	isPropagated() Check whether this evout is already regarded in the event propagation from data flow.
org.vishia.util.IterableIterator<Dout_FBcl>	iterDout()
org.vishia.util.IterableIterator<Dout_FBcl>	iterDout(boolean bCreate) Iterator over all associated dout pins for this evout.
org.vishia.util.IterableIterator<Evin_FBcl>	iterEvin()
org.vishia.util.IterableIterator<Evin_FBcl>	iterEvin(boolean bCreate) Iterator over all evin which are immediately corresponding to the given evout (for simple state machine Basic FBlocks) Often it is only one evin.
org.vishia.util.IterableIterator<PinPort_FBcl>	iterPort()
java.lang.Iterable<Evout_FBcl>	iterRepresentingEvents()
void	orConditionBits(long[][] mask, long[] allBitsArg) Sets the condition if Evinout_FBcl.condBits ==null or adds an OR condition to the given condBits.
EvoutType_FBcl	pintype() Returns the type event. accesses Pin_FBcl.pint and cast it to the expected EvoutType_FBcl.
void	setRepresentingEvent(Evout_FBcl evoutRepresenting) Mark the event with all evoutSrc in the event chain before.
java.lang.StringBuilder	toString(java.lang.StringBuilder app, java.lang.String... cond)
java.lang.String	varName() Returns a variable name proper to the Dout and FBlock.

Methods inherited from class org.vishia.fbcl.fblock.Evinout_FBcl

getConditionBits, set_orNewConditionBits

Methods inherited from class org.vishia.fbcl.fblock.Pin_FBcl

addEvchain, addEvchainDepending, connDst, connectFrom, connectFrom, connSrc, containsEvchain, containsOtherEvchain, dinType, doutType, evChainHex, evinType, evoutType, fbtypeName, getFirstConnDst, getFirstConnSrc, getMaskEvinMdlChainDriven, getMaskEvoutMdlBackChainDriven, getOneConnSrc, getOneConnSrc, isEventBackChainDriven, isEventBackChainDriven, isEventChainDriven, isEventChainDriven, isEventChainDriven, isEventChainDriven, isKind, isNotKind, isUpdatePin, iterConnDst, iterConnSrc, iterEvchainDep, iterEvchainShow, nameFBpin, nameFBpin, nrofConnDst, nrofConnSrc, pinType, removeConnectDst, removeConnectSrc, removeConnSrcAll, removePinSimpleInConnDst, setEventBackChainDriven, setEventChainDriven, spec, spec, throwError, toString, XXXremoveConnectSrc, XXXremoveConnSrc

Methods inherited from class java.lang.Object

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

Field Detail

nullArray

public static Evout_FBcl[] nullArray

null_idxRepresentingEvents

public static java.util.Map<Evout_FBcl,Evout_FBcl> null_idxRepresentingEvents

isevinDriven

public static int[] isevinDriven

idEventParallel

public transient int idEventParallel

It is an id to distinguish parallel event chains. If this evout has branched connections, the both branches becomes different numbers, stored in this field of the next evout.

idxRepresentingEvents

protected transient java.util.Map<Evout_FBcl,Evout_FBcl> idxRepresentingEvents

Used while build the event chain. This container contains all events which play a role in a chain to drive this event. They are all event outputs in the chain. It is important to detect that an event is also contained as driver, then it does not need a Join block.

Constructor Detail

Evout_FBcl

public Evout_FBcl(PinType_FBcl pint,
                  FBlock_FBcl fb,
                  XY_FBcl xy)

Ctor constructs an evout instance with the same name as stored in the type.

Parameters:

pint - the given type definition of this event.

fb - associated FBlock

Evout_FBcl

public Evout_FBcl(PinType_FBcl pint,
                  java.lang.String name,
                  FBlock_FBcl fb,
                  XY_FBcl xy)

Ctor constructs an evout instance with a given specific name, may be another than the name in the type.

Parameters:

pint - the given type definition of this event.

name - the desired name.

fb - associated FBlock

Method Detail

varName

public java.lang.String varName()

Returns a variable name proper to the Dout and FBlock.

• If the FBlock has only this dout and has not instance data, the variable has the name of the FBlock.
• If the FBlock is a input port, then it has NAME_in.
• If the FBlock has more pins or has instance data, it is NAME_NAMEFBLOCK
  The variable name is used for all code generation languages.

Returns:

pintype

public EvoutType_FBcl pintype()

Returns the type event. accesses Pin_FBcl.pint and cast it to the expected EvoutType_FBcl.

Returns:

type pin

connectDst

public java.lang.Iterable<Evin_FBcl> connectDst()

iterDout

public org.vishia.util.IterableIterator<Dout_FBcl> iterDout(boolean bCreate)

Iterator over all associated dout pins for this evout.

Returns:

Iterator or Iterable, never null .next() returns null if no event is corresponding

iterDout

public org.vishia.util.IterableIterator<Dout_FBcl> iterDout()

iterPort

public org.vishia.util.IterableIterator<PinPort_FBcl> iterPort()

iterEvin

public org.vishia.util.IterableIterator<Evin_FBcl> iterEvin(boolean bCreate)

Iterator over all evin which are immediately corresponding to the given evout (for simple state machine Basic FBlocks) Often it is only one evin.

Returns:

Iterator or Iterable, never null .next() returns null if no event is corresponding

iterEvin

public org.vishia.util.IterableIterator<Evin_FBcl> iterEvin()

setRepresentingEvent

public void setRepresentingEvent(Evout_FBcl evoutRepresenting)

Mark the event with all evoutSrc in the event chain before. This is necessary to detect whether an evoutSrc is already contained in a list of driving events which drives also this event. Hence it can be removed. Same is if this event drives an event already used, then this event does not need used as source. See isDrivenInChainBy(Evout_FBcl), See org.vishia.fbcl.readSource.Dataflow2Eventchain_FBrd#checkDinOtherAndConnectEv(org.vishia.fbcl.readSource.Dataflow2Eventchain_FBrd.EvPrepUpdInQueue, org.vishia.fbcl.fblockwr.Write_FBlock_FBwr, Evin_FBcl, java.util.List, java.util.List, java.util.List, int)

Parameters:

evoutSrc - an event which drives this event in the event chain. null possible, then the own event is entered only in idxRepresentingEvents

iterRepresentingEvents

public java.lang.Iterable<Evout_FBcl> iterRepresentingEvents()

isDrivenInChainBy

public boolean isDrivenInChainBy(Evout_FBcl evoutSrc)

isDrivenInChainByAnyEvent

public boolean isDrivenInChainByAnyEvent()

isDrivenByInit

public boolean isDrivenByInit(Evout_FBcl evoutSrc)

getEvMdlGuardBecauseInit

public boolean getEvMdlGuardBecauseInit(java.util.List<Evout_FBcl> listEvMdlGuard,
                                        boolean bDstInit)

Searches in all sources of the eventchain (in idxRepresentingEvents events from the modules inputs. It one of the module input event is named "init" all other found events are stored in the return list. Then the init eventchain should be garded with the module's init (the FB with init should only processed on module init), and a not init event chain should be garded with all events (OR) from this list. It should not be processed if init comes. If the modules input does not contain "init" then null is returned because no extra action is required.

Parameters:

bDrivenByInit - [0] = true if this evDst of a chain is forced by the module's init event input.

Returns:

null if either init alone or no init.

isPropagated

public boolean isPropagated()

Check whether this evout is already regarded in the event propagation from data flow. It is propagated if idxRepresentingEvents is set.

Returns:

true it is propagated.

addConditionBit

public boolean addConditionBit(int nrBit)

Adds one bit with given number to each element of the second dimension of Evinout_FBcl.condBits. This is an AND relation for the given condition bits. This is used for a primary condition in an 'ExprEv' FBlock or from a State FBlock. This is also used for a module's evin (Type Evout_FBcl) to notice, which conditions are used. The second dimension is not used. It means condBits.length ==1 for the second dimension. this is tested by assertion.

Parameters:

nrBit - which bit is to set. If the nrBit is >=64, the first dimension is expanded if necessary.

Returns:

true if any is changed in #condBits. false if this bit is already set.

orConditionBits

public void orConditionBits(long[][] mask,
                            long[] allBitsArg)

Sets the condition if Evinout_FBcl.condBits ==null or adds an OR condition to the given condBits.

Parameters:

mask - null for uncondtional, or a new condition from any other Evinout_FBcl.getConditionBits() which should be ORed. The condition vector itself is copied (original should not be changed). It can be null for 'unconditional'.

allBitsArg - All condition bits from this event chain. If all these bits are set because of OR, the Evinout_FBcl.condBits get be unconditionally.

andConditionBits

public boolean andConditionBits(long[][] mask)

If a Join_OFB is on input of a FBlock, all conditions of this events should be merged to AND and OR conditions for the Join event output. It calls Bitfield.mergeWords(long[][], long[][]), see examples there.

Parameters:

log -

getLastCondBit

public int getLastCondBit()

Returns the bit number of the last set bit in Evinout_FBcl.condBits

Returns:

-1 if empty. 0 if the mask is 0x00000001

getConditionMaskMdl

public long[] getConditionMaskMdl()

toString

public java.lang.StringBuilder toString(java.lang.StringBuilder app,
                                        java.lang.String... cond)

Specified by:

toString in interface org.vishia.util.ToStringBuilder

Overrides:

toString in class Evinout_FBcl