PinConnect

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

public class PinConnect_FBcl
extends java.lang.Object

This class describes a connection between pins. Beside the source and destination pin, the element access and a variant is stored here.

 --Pin_FBcl--------+      +--PinConnect_FBcl--+        +-----Pin_FBcl-----
          connectDst----->| -sElemSrc         |<-------connectSrc
                   |<-----pinSrc         pinDst------->|
                   |      |        -sElemDst  |        |
  -----------------+      |    -sVariant      |        +-------------------
                          +-------------------+

Both, a source pin and a destination pin of a logical connection refers an instance of this. The pins can have more connections between, but with different functionality. For example, in C-code:

   dst.y[5] = src.x.re;
   dst.y[6] = src.x.im;

and on another place und another condition (in another branch of the processing software): dst.y[5] = srcOther.value[3];

 In all these examples only the pin 'y' is connected as destination, but with 3 connections,
 and also from the source 'x' two connections are existing, which are related to parts of the pin
 which presents embedded data (Here a complex value with '.re' and '.im').

Field Summary

Fields
Modifier and Type	Field and Description
`static java.util.List<PinConnect_FBcl>`	`conn1Empty` Empty List with only one empty entry.
`static java.util.List<PinConnect_FBcl>`	`connEmpty` Empty List without entry.
`private java.util.List<FBlock_FBcl>`	`fbSrc` null or one or more FBlocks where the (textual given) connection goes to inside of this module presented by the FBlocks.
`int`	`ixMux` If >=0, then it is the selection of a connection from more as one `Pin_FBcl.connectSrc` due to the given index of a array FBlock.
`Pin_FBcl`	`pinDst` The pin on the connection side.
`Pin_FBcl`	`pinSrc` The pin on the connection side.
`java.lang.String`	`sElemDst` Maybe null, describes if the connection delivers a value only for a part of the destination pin.
`java.lang.String`	`sElemSrc` maybe null, set with the access String if an element of the data, which is representing by the `pinSrc`, should be accessed.
`static java.lang.String`	`version` Version, history and license.

Constructor Summary

Constructors
Constructor and Description
`PinConnect_FBcl(java.util.List<FBlock_FBcl> fbSrc, Pin_FBcl pinSrc, Pin_FBcl pinDst, int ixMux, java.lang.String sElemSrc, java.lang.String sElemDst)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getKeyDst()` Returns a key for the back connection from the source to the destination.
`java.lang.String`	`getKeySrc()` Returns a key for the connection from the destination to the source used for `Pin_FBcl.connectSrc` as key.
`java.lang.Iterable<FBlock_FBcl>`	`iterFBsrc()` null or one or more FBlocks where the (textual given) connection via `pinSrc` goes to inside of this module presented by the FBlocks.
`java.lang.String`	`toString()`

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: getKeySrc() and getKeyDst() to build the proper key from the connection used for the container Pin_FBcl.connectSrc and Pin_FBcl.connectDst.
    - 2024-12-13: Creation, necessary because the element access cannot be part of the pin itself if it is not an expression input.
    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
  - connEmpty
```
public static java.util.List<PinConnect_FBcl> connEmpty
```
    Empty List without entry. This is used to return in iteratable which has no members if Pin_FBcl.connSrc() is null.
  - conn1Empty
```
public static java.util.List<PinConnect_FBcl> conn1Empty
```
    Empty List with only one empty entry. This is used if a Din_FBcl contains a Din_FBcl.sConstant only to get an output on
  - pinSrc
```
public final Pin_FBcl pinSrc
```
    The pin on the connection side.
  - pinDst
```
public final Pin_FBcl pinDst
```
    The pin on the connection side.
  - fbSrc
```
private final java.util.List<FBlock_FBcl> fbSrc
```
    null or one or more FBlocks where the (textual given) connection goes to inside of this module presented by the FBlocks. A connection to inside of a module, not via a modules pin, may be especially for test values. Usual this element is null.
  - ixMux
```
public final int ixMux
```
    If >=0, then it is the selection of a connection from more as one Pin_FBcl.connectSrc due to the given index of a array FBlock.
  - sElemSrc
```
public final java.lang.String sElemSrc
```
    maybe null, set with the access String if an element of the data, which is representing by the pinSrc, should be accessed. This is an array index or also an element if the DType_FBcl of a Dinout_FBcl presents a structure in the target language. The writing stype of the connection is always:
    - '[2,3]' for an array access, here two-dimensional
    - '.re' for an access to an element of a structure, here access to 're' of a complex value.
    This designations are used independent of the target language. The code generation adapts a divergent writing style, for example '[2][3]' for the array access and '->re' if the structure is referenced by value, or also 'access_Type(pointer)' or pointer->access() if '.access' is given and the type allows only the access via the getter operation.
  - sElemDst
```
public final java.lang.String sElemDst
```
    Maybe null, describes if the connection delivers a value only for a part of the destination pin. Also, related to the destination pin of an expression as variable after expression. Writing style is adequate sElemSrc. If for example the 5th element of the array representing by the #pinDst should be set, then it should contain the String "[5]".
    
    But special meaning: '@12' it is the index or number of the multiple din connection caused from a sliced or multiplexed connection to the scalar pin of an array of FBlocks. The scalar pin gets more connSrc, but that is valid which's FBlock_FBcl index in the FBlock array is equal with then number after @
- Constructor Detail
  - PinConnect_FBcl
```
PinConnect_FBcl(java.util.List<FBlock_FBcl> fbSrc,
                Pin_FBcl pinSrc,
                Pin_FBcl pinDst,
                int ixMux,
                java.lang.String sElemSrc,
                java.lang.String sElemDst)
```
    Parameters:
    
    fbSrc - Only given on textual connections to reference a FBlock inside a contained module.
    
    pinSrc -
    
    pinDst -
    
    ixMux -
    
    sElemSrc -
    
    sElemDst -
    
    sVariant -
- Method Detail
  - getKeySrc
```
public java.lang.String getKeySrc()
```
    Returns a key for the connection from the destination to the source used for Pin_FBcl.connectSrc as key. The key regards that they may be more as one connections between the same pin if different sElemDst are used and/or different #sVariant are given. The key starts with Pin_FBcl.nameFBpin() of the destination pin which is referred from the source by this connection.
    
    Returns:
    
    proper key string
  - getKeyDst
```
public java.lang.String getKeyDst()
```
    Returns a key for the back connection from the source to the destination. used for Pin_FBcl.connectDst as key. The key regards that they may be more as one connections between the same pin if different sElemSrc are used and/or different #sVariant are given. The key starts with Pin_FBcl.nameFBpin() of the source pin which is referred from the destination by this connection.
    
    Returns:
    
    proper key string
  - iterFBsrc
```
public java.lang.Iterable<FBlock_FBcl> iterFBsrc()
```
    null or one or more FBlocks where the (textual given) connection via pinSrc goes to inside of this module presented by the FBlocks. A connection to inside of a module, not via a modules pin, may be especially for test values. Usual this operation returns null. The the connection goes to a pin of the own module. If given, the pinSrc : Pin_FBcl.fb : FBlock_FBcl.mdl : Module_FBcl.fbtMdlifc is the same instance as the last gotten FBlock_FBcl.fbt(). But the Module_FBcl.fbActual is not usable, because this aggregation is only given for code generation of the module, after them invalid. There may be more as one Modules, which contains exact this module.
    
    Returns:
    
    list of FBlock_FBcl which references the last FBlock_FBcl which contains the given pinSrc
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class PinConnect_FBcl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

version

connEmpty

conn1Empty

pinSrc

pinDst

fbSrc

ixMux

sElemSrc

sElemDst

Constructor Detail

PinConnect_FBcl

Method Detail

getKeySrc

getKeyDst

iterFBsrc

toString