org.vishia.fbcl.fblock

Class PinConnect_FBcl

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----->| -sElementSrc      |<-------connectSrc
                   |<-----pinSrc         pinDst------->|
                   |      |     -sElementDst  |        |
  -----------------+      |    -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
Pin_FBcl	pinDst The pin on the connection side.
Pin_FBcl	pinSrc The pin on the connection side.
java.lang.String	sElementDst Maybe null, describes if the connection delivers a value only for a part of the destination pin.
java.lang.String	sElementSrc maybe null, set with the access String if an element of the data, which is representing by the pinSrc, should be accessed.
java.lang.String	sVariant Maybe null, describes a connection valid only for a specific situation with a specific event.
static java.lang.String	version Version, history and license.

Constructor Summary

Constructors

Constructor and Description
PinConnect_FBcl(Pin_FBcl pinSrc, Pin_FBcl pinDst, java.lang.String sElemSrc, java.lang.String sElemDst, java.lang.String sVariant)

Method Summary

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.

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

pinSrc

public final Pin_FBcl pinSrc

The pin on the connection side.

pinDst

public final Pin_FBcl pinDst

The pin on the connection side.

sElementSrc

public final java.lang.String sElementSrc

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.

sElementDst

public final java.lang.String sElementDst

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 sElementSrc. If for example the 5th element of the array representing by the #pinDst should be set, then it should contain the String "[5]".

sVariant

public final java.lang.String sVariant

Maybe null, describes a connection valid only for a specific situation with a specific event. It means this connection is only used for an assignment in a specific operation. The requested variant is stored in associated pin connections. For example if an event connection is responsible to a data flow, and the event connection has this sVariant set, then only the data connections which has also this sVariant set, are used. In the OFB graphic a variant is denoted on any pin in a Graphic block after 'name%variant'. Then the 'variant' is valid for all pins of this GBlock.

Constructor Detail

PinConnect_FBcl

PinConnect_FBcl(Pin_FBcl pinSrc,
                Pin_FBcl pinDst,
                java.lang.String sElemSrc,
                java.lang.String sElemDst,
                java.lang.String 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 sElementDst 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 sElementSrc 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