Pin_FBcl

java.lang.Object
- org.vishia.fbcl.fblock.Pin_FBcl

All Implemented Interfaces:

org.vishia.util.ToStringBuilder

Direct Known Subclasses:

Dinout_FBcl, Evinout_FBcl, PinFbDst_FBcl, PinFbSrc_FBcl
```
public abstract class Pin_FBcl
extends java.lang.Object
implements org.vishia.util.ToStringBuilder
```
A Pin is any connector on a Function Block, either for event or data, either in or output. This is the base class for all.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Pin_FBcl.XXXXXEKind

Nested Classes
Modifier and Type	Class and Description
`static class`	`Pin_FBcl.XXXXXEKind`

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.Map<java.lang.String,PinConnect_FBcl>`	`connectDst`
`protected java.util.Map<java.lang.String,PinConnect_FBcl>`	`connectSrc` Opposite pin(s) for connection.
`FBlock_FBcl`	`fb` The block which this connection is member of.
`private long`	`mEvMdlChain` Association of the pin on a FBlock instance or the module's evinMdl for one or more event chains from the module's evin.
`private long`	`mEvoutMdlChain` Association of the pin on a FBlock instance or the module's evoutMdl for one or more event chains from the module's evout It is a `Evin_FBcl`).
`java.lang.String`	`name` The name is the same as `pint`: `PinType_FBcl.nameType` or it is the name of a multiple pin instance, then the name in PinType should end of "0999" or "1999"
`PinType_FBcl`	`pint`
`private java.lang.String`	`spec` This is a free usable 'specification' or 'special' String.
`static java.lang.String`	`version` Version, history and license.
`private java.util.List<Evchain_FBcl.Wr>`	`XXXevChainShow` Note whether this pin is a member of a event chain.
`private long`	`xxxmEvChains` Up to 64 evChain can tangent this pin. 1 bit per chain.
`private long`	`xxxmEvChainsDep` Up to 64 evChain which's data and outputs are depending from this pin.
`XY_FBcl`	`xy`

Constructor Summary

Constructors
Constructor and Description
`Pin_FBcl(PinType_FBcl pint, FBlock_FBcl fb, XY_FBcl xy)` If not null then it contains the generation rule to execute the data access operation.
`Pin_FBcl(PinType_FBcl pint, java.lang.String name, FBlock_FBcl fb, XY_FBcl xy)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addEvchain(Evchain_FBcl.Wr evchain)` Returns the connection info as String without the information about `fb` info.
`void`	`addEvchainDepending(int ixEvChainInMdl)`
`java.lang.Iterable<PinConnect_FBcl>`	`connDst()`
`boolean`	`connectFrom(Pin_FBcl fromPin)` Sets the connection between this and any destination, it is an in pin of any other `FBlock_FBcl` If the same toPin is already connected, nothing is done.
`boolean`	`connectFrom(Pin_FBcl fromPin, java.lang.String sElemSrc, java.lang.String sElemDst, java.lang.String sVariant)`
`private boolean`	`connectFrom(Pin_FBcl fromPinArg, java.lang.String sElemSrc, java.lang.String sElemDst, java.lang.String sVariant, int recursion)` The recursive callable implementation of `connectFrom(Pin_FBcl)`
`java.lang.Iterable<PinConnect_FBcl>`	`connSrc()`
`boolean`	`containsEvchain(Evchain_FBcl evchain)`
`boolean`	`containsOtherEvchain(Evchain_FBcl evchain)`
`DinType_FBcl`	`dinType()` Gets the din from the Type of the given FBlock.
`DoutType_FBcl`	`doutType()` Gets the dout from the Type of the given FBlock.
`java.lang.String`	`evChainHex()`
`EvinType_FBcl`	`evinType()` Gets the evin from the Type of the given FBlock.
`EvoutType_FBcl`	`evoutType()` Gets the evout from the Type of the given FBlock.
`java.lang.String`	`fbtypeName()` Returns the name of the type as it can be used for code generation.
`Pin_FBcl`	`getFirstConnDst()` If the connection has at least one partner, returns the first or only one.
`Pin_FBcl`	`getFirstConnSrc()` If the connection has at least one partner, returns the first or only one.
`long`	`getMaskEvinMdlChainDriven()`
`long`	`getMaskEvoutMdlBackChainDriven()`
`Pin_FBcl`	`getOneConnSrc()` If the ev input has exactly one source, returns it.
`PinConnect_FBcl`	`getOneConnSrc(long[] condBits)`
`boolean`	`isEventBackChainDriven()` Checks whether this pin is included in any event chain.
`boolean`	`isEventBackChainDriven(Evin_FBcl evoutMdl)` Checks whether this pin is driven by the propagated event chain from the module's evin.
`boolean`	`isEventChainDriven()` Checks whether this pin is included in any event chain.
`boolean`	`isEventChainDriven(Evout_FBcl evinMdl)` Checks whether this pin is driven by the propagated event chain from the module's evin.
`boolean`	`isEventChainDriven(long maskEvout)`
`boolean`	`isEventChainDriven(PinType_FBcl evinMdl)`
`boolean`	`isKind(java.lang.String kindChars)` Simple operation to quest whether the pin has the `PinType_FBcl.kind` adequate one of the given characters see `PinKind_FBcl`.
`boolean`	`isNotKind(java.lang.String kindChars)` Simple operation to quest whether the pin has not the `PinType_FBcl.kind` adequate one of the given characters see `PinKind_FBcl`.
`boolean`	`isUpdatePin()` True if this pin is one of the update pins, read from `pint` and `PinType_FBcl.kind` `PinKind_FBcl.evUpdin`, `PinKind_FBcl.evUpdout`, `PinKind_FBcl.EvUpdinMdl`, `PinKind_FBcl.EvUpdoutMdl` but also `PinKind_FBcl.ZoutMdl` and `PinKind_FBcl.zout` for data pins
`java.lang.Iterable<PinConnect_FBcl>`	`iterConnDst()`
`java.lang.Iterable<PinConnect_FBcl>`	`iterConnSrc()`
`java.lang.Iterable<Evchain_FBcl>`	`iterEvchainDep(Module_FBcl mdl)`
`java.lang.Iterable<Evchain_FBcl.Wr>`	`iterEvchainShow()`
`java.lang.String`	`nameFBpin()` Gets a String with the FBLock name and the pin name.
`java.lang.String`	`nameFBpin(char sep)` Gets a String with the FBLock name and the pin name maybe as identifier.
`int`	`nrofConnDst()`
`int`	`nrofConnSrc()`
`PinType_FBcl`	`pinType()` Gets the evin from the Type of the given FBlock.
`boolean`	`removeConnectDst(PinConnect_FBcl conn)`
`boolean`	`removeConnectSrc(Pin_FBcl pinSrc)`
`void`	`removeConnSrcAll()` Removes all connections from this pin.
`boolean`	`removePinSimpleInConnDst(Pin_FBcl pin)` Remove only the pin in the connection.
`long`	`setEventBackChainDriven(Evin_FBcl evoutMdl)` Set the fact that this pin is driven by the propagated event chain from the module's evin.
`long`	`setEventChainDriven(Evout_FBcl evinMdl)` Set the fact that this pin is driven by the propagated event chain from the module's evin.
`java.lang.String`	`spec()` See `spec`
`void`	`spec(java.lang.String spec)` See `spec`
`protected void`	`throwError(java.lang.String txt, DinoutType_FBcl src)`
`java.lang.String`	`toString()`
`java.lang.StringBuilder`	`toString(java.lang.StringBuilder app, java.lang.String... cond)`
`boolean`	`XXXremoveConnectSrc(java.util.Iterator<Pin_FBcl> iterConnSrc, Pin_FBcl pinSrc)`
`boolean`	`XXXremoveConnSrc(Pin_FBcl pin)` Remove the connection and its opposite

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - version
```
public static final java.lang.String version
```
    Version, history and license.
    - 2024-12-31 Because on Pin_FBcl can have more connections to the same other pin via different PinConnect_FBcl (for example same src pin to different elements of destination array pin, the key in connectSrc and connectDst should not the other nameFBpin(), it should be the combination of the other pin and its connection conditions, mean what's contained also in PinConnect_FBcl.
      For that, the opeations PinConnect_FBcl.getKeySrc() and PinConnect_FBcl.getKeySrc() were created and used here as key inside connectFrom(Pin_FBcl, String, String, String, int).
    - 2024-12-13 introduce PinConnect_FBcl as element in connectSrc and connectDst
    - ...many changes on small class
    - 2019-09-04 created as Connections_FBcl in Archiv
    - 2019-04-24 first archived as InConnection_JgenMdl from 2018 stuff
    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
  - name
```
public final java.lang.String name
```
    The name is the same as pint: PinType_FBcl.nameType or it is the name of a multiple pin instance, then the name in PinType should end of "0999" or "1999"
  - spec
```
private java.lang.String spec
```
    This is a free usable 'specification' or 'special' String. It is determined by the right side of the textual pin specification after a "?spec" and can be used for code generation in a specific kind. For the aggregation in a FBoper_FBcl it describes which source event from the aggregated FBlock_FBcl should be used.
  - XXXevChainShow
```
private java.util.List<Evchain_FBcl.Wr> XXXevChainShow
```
    Note whether this pin is a member of a event chain. It is yet only for check, not used for generation. Do not remove it, use later.
  - xxxmEvChains
```
private long xxxmEvChains
```
    Up to 64 evChain can tangent this pin. 1 bit per chain. If more as 64 evChain are part of the module, then this element should be enhanced with an array.
  - xxxmEvChainsDep
```
private long xxxmEvChainsDep
```
    Up to 64 evChain which's data and outputs are depending from this pin. The doutPin should be virtual for the own evChain. If more as 64 evChain are part of the module, then this element should be enhanced with an array.
  - mEvMdlChain
```
private long mEvMdlChain
```
    Association of the pin on a FBlock instance or the module's evinMdl for one or more event chains from the module's evin. This is used during org.vishia.fbcl.readSource.Dataflow2Eventchain_FBrd propagation.. If the proper bit is set, the Pin is driven in the event chain already. currently used 2024-07
  - mEvoutMdlChain
```
private long mEvoutMdlChain
```
    Association of the pin on a FBlock instance or the module's evoutMdl for one or more event chains from the module's evout It is a Evin_FBcl). This is used during DataFlow2EvChainBackward_FBrd propagation.. If the proper bit is set, the Pin is captured in the back propagation already. currently used 2024-11
  - xy
```
public final XY_FBcl xy
```
  - fb
```
public final FBlock_FBcl fb
```
    The block which this connection is member of. Never null.
  - pint
```
public PinType_FBcl pint
```
  - connectSrc
```
protected final java.util.Map<java.lang.String,PinConnect_FBcl> connectSrc
```
    Opposite pin(s) for connection. This is both a forward connection from output to possible more as one inputs or a backward connection from input to its output. For data connection this is obviously. For reference connection FBlock_FBcl.fbPinDst may be referred.
  - connectDst
```
protected final java.util.Map<java.lang.String,PinConnect_FBcl> connectDst
```
- Constructor Detail
  - Pin_FBcl
```
public Pin_FBcl(PinType_FBcl pint,
                FBlock_FBcl fb,
                XY_FBcl xy)
```
    If not null then it contains the generation rule to execute the data access operation. For primitive expression flow it is the expression using the inputs.
  - Pin_FBcl
```
public Pin_FBcl(PinType_FBcl pint,
                java.lang.String name,
                FBlock_FBcl fb,
                XY_FBcl xy)
```
- Method Detail
  - spec
```
public java.lang.String spec()
```
    See spec
  - spec
```
public void spec(java.lang.String spec)
```
    See spec
  - connectFrom
```
public boolean connectFrom(Pin_FBcl fromPin)
```
    Sets the connection between this and any destination, it is an in pin of any other FBlock_FBcl If the same toPin is already connected, nothing is done. Twice trying connection is allowed. It is asserted if the same toPin is not connected , this is not connected in toPin too. It is called in preparation process.
    It is possible that the connection in the graphic comes from any other input Pin_FBcl ( PinKind_FBcl.bOutput == false) instead of the correct output pin. The problem is solved here: Either the real source is found in the immediately connected Din_FBcl by the existing source connection, or the source connection is caught up if the connection from the real source is processed. Then all indirect connections are resolved.
    
    Parameters:
    
    fromPin - the partner, there the connection is added too.
    
    Returns:
    
    true if added, false if already was added before.
  - connectFrom
```
public boolean connectFrom(Pin_FBcl fromPin,
                           java.lang.String sElemSrc,
                           java.lang.String sElemDst,
                           java.lang.String sVariant)
```
  - connectFrom
```
private boolean connectFrom(Pin_FBcl fromPinArg,
                            java.lang.String sElemSrc,
                            java.lang.String sElemDst,
                            java.lang.String sVariant,
                            int recursion)
```
    The recursive callable implementation of connectFrom(Pin_FBcl)
    
    Parameters:
    
    fromPin -
    
    recursion - Used if a given input->input2 connection will be resolved to the fromPin ->input2 because fromPin is the real output.
    
    Returns:
  - connSrc
```
public java.lang.Iterable<PinConnect_FBcl> connSrc()
```
  - connDst
```
public java.lang.Iterable<PinConnect_FBcl> connDst()
```
  - nrofConnSrc
```
public int nrofConnSrc()
```
  - nrofConnDst
```
public int nrofConnDst()
```
  - getOneConnSrc
```
public PinConnect_FBcl getOneConnSrc(long[] condBits)
```
  - getOneConnSrc
```
public Pin_FBcl getOneConnSrc()
```
    If the ev input has exactly one source, returns it. If the input has no source or more as one source (or-Event), this operation returns null. Use #getMultipleSrcEv() to check all event sources if this operation returns null.
  - getFirstConnSrc
```
public Pin_FBcl getFirstConnSrc()
```
    If the connection has at least one partner, returns the first or only one. If the input has no source this operation returns null.
  - getFirstConnDst
```
public Pin_FBcl getFirstConnDst()
```
    If the connection has at least one partner, returns the first or only one. If the input has no source this operation returns null.
  - removeConnectSrc
```
public boolean removeConnectSrc(Pin_FBcl pinSrc)
```
  - XXXremoveConnectSrc
```
public boolean XXXremoveConnectSrc(java.util.Iterator<Pin_FBcl> iterConnSrc,
                                   Pin_FBcl pinSrc)
```
  - removeConnectDst
```
public boolean removeConnectDst(PinConnect_FBcl conn)
```
  - removePinSimpleInConnDst
```
public boolean removePinSimpleInConnDst(Pin_FBcl pin)
```
    Remove only the pin in the connection. On the opposite side it is already removed or it should be removed in a specific way. Note: What to do to remove both sides?
    
    Parameters:
    
    pin - The pin is searched in connectDst
    
    Returns:
  - XXXremoveConnSrc
```
public boolean XXXremoveConnSrc(Pin_FBcl pin)
```
    Remove the connection and its opposite
    
    Parameters:
    
    pin -
    
    Returns:
  - removeConnSrcAll
```
public void removeConnSrcAll()
```
    Removes all connections from this pin. If it is a din or evin, the source connection is removed only. If it is a dout or evout, all connections are removed in both directions.
  - iterConnSrc
```
public java.lang.Iterable<PinConnect_FBcl> iterConnSrc()
```
  - iterConnDst
```
public java.lang.Iterable<PinConnect_FBcl> iterConnDst()
```
  - isUpdatePin
```
public boolean isUpdatePin()
```
    True if this pin is one of the update pins, read from pint and PinType_FBcl.kind PinKind_FBcl.evUpdin, PinKind_FBcl.evUpdout, PinKind_FBcl.EvUpdinMdl, PinKind_FBcl.EvUpdoutMdl but also PinKind_FBcl.ZoutMdl and PinKind_FBcl.zout for data pins
    
    Returns:
  - pinType
```
public PinType_FBcl pinType()
```
    Gets the evin from the Type of the given FBlock.
    
    Returns:
    
    Info from the type of this FBlock.
  - evinType
```
public EvinType_FBcl evinType()
```
    Gets the evin from the Type of the given FBlock.
    
    Returns:
    
    Info from the type of this FBlock.
  - evoutType
```
public EvoutType_FBcl evoutType()
```
    Gets the evout from the Type of the given FBlock.
    
    Returns:
    
    Info from the type of this FBlock.
  - dinType
```
public DinType_FBcl dinType()
```
    Gets the din from the Type of the given FBlock.
    
    Returns:
    
    Info from the type of this FBlock.
  - doutType
```
public DoutType_FBcl doutType()
```
    Gets the dout from the Type of the given FBlock.
    
    Returns:
    
    Info from the type of this FBlock.
  - nameFBpin
```
public java.lang.String nameFBpin()
```
    Gets a String with the FBLock name and the pin name. If the FFBlock name starts with "$" ("$module"), only the pin name is output.
    
    Returns:
  - nameFBpin
```
public java.lang.String nameFBpin(char sep)
```
    Gets a String with the FBLock name and the pin name maybe as identifier.
    
    Parameters:
    
    sep - separator character between FBlock name and pin name.
    
    Returns:
  - isKind
```
public boolean isKind(java.lang.String kindChars)
```
    Simple operation to quest whether the pin has the PinType_FBcl.kind adequate one of the given characters see PinKind_FBcl.
    
    Parameters:
    
    kindChars - due to PinKind_FBcl.cKind
    
    Returns:
    
    true if one of the given characters determines the kind of the type pin.
  - isNotKind
```
public boolean isNotKind(java.lang.String kindChars)
```
    Simple operation to quest whether the pin has not the PinType_FBcl.kind adequate one of the given characters see PinKind_FBcl. It means it is just not one of the quest kinds.
    
    Parameters:
    
    kindChars - due to PinKind_FBcl.cKind
    
    Returns:
    
    true if one of the given characters determines the kind of the type pin.
  - addEvchain
```
public void addEvchain(Evchain_FBcl.Wr evchain)
```
    Returns the connection info as String without the information about fb info. It is especially for out connections in the netlist. The FBlock info is written already in the head information.
  - addEvchainDepending
```
public void addEvchainDepending(int ixEvChainInMdl)
```
  - containsEvchain
```
public boolean containsEvchain(Evchain_FBcl evchain)
```
  - containsOtherEvchain
```
public boolean containsOtherEvchain(Evchain_FBcl evchain)
```
  - iterEvchainDep
```
public java.lang.Iterable<Evchain_FBcl> iterEvchainDep(Module_FBcl mdl)
```
  - iterEvchainShow
```
public java.lang.Iterable<Evchain_FBcl.Wr> iterEvchainShow()
```
  - evChainHex
```
public java.lang.String evChainHex()
```
  - setEventChainDriven
```
public long setEventChainDriven(Evout_FBcl evinMdl)
```
    Set the fact that this pin is driven by the propagated event chain from the module's evin. This is used during org.vishia.fbcl.readSource.Dataflow2Eventchain_FBrd propagation.
    
    Parameters:
    
    evinMdl - A modules evin as start of the event chain.
    
    Returns:
    
    the mEvMdlChain only for log/debug
  - isEventChainDriven
```
public boolean isEventChainDriven(Evout_FBcl evinMdl)
```
    Checks whether this pin is driven by the propagated event chain from the module's evin. This is used during org.vishia.fbcl.readSource.Dataflow2Eventchain_FBrd propagation.
    
    Parameters:
    
    evinMdl - A modules evin as start of the event chain.
    
    Returns:
    
    true if already driven.
  - isEventChainDriven
```
public boolean isEventChainDriven()
```
    Checks whether this pin is included in any event chain. This is important for building the event chain.
    
    Returns:
    
    true if #mEvMdlChain has set any bit.
  - isEventChainDriven
```
public boolean isEventChainDriven(PinType_FBcl evinMdl)
```
  - isEventChainDriven
```
public boolean isEventChainDriven(long maskEvout)
```
  - getMaskEvinMdlChainDriven
```
public long getMaskEvinMdlChainDriven()
```
  - setEventBackChainDriven
```
public long setEventBackChainDriven(Evin_FBcl evoutMdl)
```
    Set the fact that this pin is driven by the propagated event chain from the module's evin. This is used during org.vishia.fbcl.readSource.Dataflow2Eventchain_FBrd propagation.
    
    Parameters:
    
    evoutMdl - A modules evout as end of the event chain.
    
    Returns:
    
    the mEvMdlChain only for log/debug
  - isEventBackChainDriven
```
public boolean isEventBackChainDriven(Evin_FBcl evoutMdl)
```
    Checks whether this pin is driven by the propagated event chain from the module's evin. This is used during org.vishia.fbcl.readSource.Dataflow2Eventchain_FBrd propagation.
    
    Parameters:
    
    evinMdl - A modules evin as start of the event chain.
    
    Returns:
    
    true if already driven.
  - isEventBackChainDriven
```
public boolean isEventBackChainDriven()
```
    Checks whether this pin is included in any event chain. This is important for building the event chain.
    
    Returns:
    
    true if #mEvMdlChain has set any bit.
  - getMaskEvoutMdlBackChainDriven
```
public long getMaskEvoutMdlBackChainDriven()
```
  - fbtypeName
```
public java.lang.String fbtypeName()
```
    Returns the name of the type as it can be used for code generation.
  - toString
```
public java.lang.StringBuilder toString(java.lang.StringBuilder app,
                                        java.lang.String... cond)
```
    Specified by:
    
    toString in interface org.vishia.util.ToStringBuilder
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - throwError
```
protected void throwError(java.lang.String txt,
                          DinoutType_FBcl src)
```

Class Pin_FBcl

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

version

name

spec

XXXevChainShow

xxxmEvChains

xxxmEvChainsDep

mEvMdlChain

mEvoutMdlChain

xy

fb

pint

connectSrc

connectDst

Constructor Detail

Pin_FBcl

Pin_FBcl

Method Detail

spec

spec

connectFrom

connectFrom

connectFrom

connSrc

connDst

nrofConnSrc

nrofConnDst

getOneConnSrc

getOneConnSrc

getFirstConnSrc

getFirstConnDst

removeConnectSrc

XXXremoveConnectSrc

removeConnectDst

removePinSimpleInConnDst

XXXremoveConnSrc

removeConnSrcAll

iterConnSrc

iterConnDst

isUpdatePin

pinType

evinType

evoutType

dinType

doutType

nameFBpin

nameFBpin

isKind

isNotKind

addEvchain

addEvchainDepending

containsEvchain

containsOtherEvchain

iterEvchainDep

iterEvchainShow

evChainHex

setEventChainDriven

isEventChainDriven

isEventChainDriven

isEventChainDriven

isEventChainDriven

getMaskEvinMdlChainDriven

setEventBackChainDriven

isEventBackChainDriven

isEventBackChainDriven

getMaskEvoutMdlBackChainDriven

fbtypeName

toString

toString

throwError