Din_FBcl

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

Direct Known Subclasses:

DinExpr_FBcl, DinExprK_FBcl, DinSetElem_FBcl, DoutMdl_FBcl, PinRef_FBcl
```
public class Din_FBcl
extends Dinout_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
`protected boolean`	`bBreakChain` An input which breaks the chain of events because of an special internal wiring condition from the source of the graphical module, `OdgConnection.ECkind.dataGet` it is set if the connection comes from a VarZ_OFB or from a connection style ofcDataGet.
`private boolean`	`bCastDType` True then {@link #setDTypeCastInp(DType_FBcl.DtIxmdl) was called or the propagated DType is not the same as the own.
`protected boolean`	`bNonFBarray` If true, then this pin is connected for all FBlock array elements with the same signal.
`protected DType_FBcl.DtIxmdl`	`dTypeCastInp` A possible specific data type for the pin as cast from the input.
`private DType_FBcl`	`dTypeConst` Detected Data Type of a `sConstant` used for adaption of the given constant value.
`private DType_FBcl.DtIxmdl`	`dTypePropg` The data type which comes from the input wiring, set in `DTypePropgPrc_FBcl` via `#setDTypePropg(DType_FBcl.DtIxmdl)`.
`protected int[]`	`ixArrayAccess` If not "", then it describes the access to an element in the connected doutSrc array as textual information written in an din.
`long`	`mEvCluster` Association of the din on a FBlock instance or the module's dout to one or more evCluster
`static Din_FBcl[]`	`nullArray`
`private java.lang.String`	`sConstant` If not null then it is a constant given as String on this input.

Fields inherited from class org.vishia.fbcl.fblock.Dinout_FBcl
steptime, zVectorDim

Fields inherited from class org.vishia.fbcl.fblock.Pin_FBcl
connectDst, connectSrc, fb, name, version, xy

Constructor Summary

Constructors
Constructor and Description
`Din_FBcl(DinType_FBcl pint, FBlock_FBcl fb, XY_FBcl xy)`
`Din_FBcl(DinType_FBcl pint, java.lang.String name, FBlock_FBcl fb, XY_FBcl xy)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`bCastDType()` Returns true if a numeric cast (also maybe with bit shift) in target code generation should be done.
`boolean`	`breakEventChain()`
`DType_FBcl.DtIxmdl`	`dTypeCastInp()` Returns null or the DType set with `setDTypeCastInp(org.vishia.fbcl.fblock.DType_FBcl.DtIxmdl)`.
`DType_FBcl`	`dTypeConst()`
`DType_FBcl`	`dTypeDecl()` Returns the DType for the din pin as declared, not the cast type.
`DType_FBcl.DtIxmdl`	`dTypePropg()` Returns null or the already forward propagated DType set with `setDTypePropg(org.vishia.fbcl.fblock.DType_FBcl.DtIxmdl, boolean)`.
`Dout_FBcl`	`getConnSrc()` Gets the source of this pin.
`java.lang.String`	`getConstant()`
`java.lang.String`	`getConstant(int ix)` Gets a part from the `sConstant` which should contain more as one parts separated with comma.
`DinType_FBcl`	`getDintype()`
`(package private) DType_FBcl.DtIxmdl`	`getDTypeIxMdl()` Gets a possible DType with ixMdl as stored in specific pins.
`Evin_FBcl`	`getOnlyoneAssocEvin()`
`java.lang.Iterable<PinConnect_FBcl>`	`iterConnSrcConditional(long[] condBits, long mEvinMdlMask, java.lang.String sVariant, int ixFBlock)` Iterator for all connections to use.
`java.lang.Iterable<Evin_FBcl>`	`iterEvin()`
`boolean`	`nonFBarray()` If true, then this pin is connected for all FBlock array elements with the same signal.
`java.lang.Iterable<EccAction_FBcl>`	`operationsType()` Returns the appropriate Operation-List of the type to this pin.
`static java.lang.String`	`replaceAliasConst(java.lang.String src, java.util.Map<java.lang.String,java.lang.String> idxAlias)`
`void`	`setBreakEventChain()`
`void`	`setConstant(java.lang.String val, java.util.Map<java.lang.String,java.lang.String> idxAlias)` Sets the `sConstant` and sets also a detected type of the const to `dTypeConst()`.
`void`	`setConstantDirect(java.lang.String val)` Called only for String constants, especially for expr term.
`java.lang.String`	`setDType(DType_FBcl.DtIxmdl dtixSrc, LogMessage log)` Overridden form for `Dinout_FBcl#setDType(DType_FBcl)`: If `dTypeCastInp` is set, this is determining.
`boolean`	`setDTypeCastInp(DType_FBcl.DtIxmdl dtix)` Sets initial the `dTypeCastInp`.
`boolean`	`setDTypeConst(DType_FBcl dt)` Sets initial the `dTypeConst`.
`boolean`	`setDTypePropg(DType_FBcl.DtIxmdl dtix, boolean bCast)` Sets initial the `dTypePropg`.
`void`	`setNonFBarray(boolean set)` If true, then this pin is connected for all FBlock array elements with the same signal.
`java.lang.StringBuilder`	`toString(java.lang.StringBuilder app, java.lang.String... cond)`
`java.lang.Iterable<Dout_FBcl>`	`XXXconnectSrc()`

Methods inherited from class org.vishia.fbcl.fblock.Dinout_FBcl
dtArrayCpp, dType, dType, dTypeChar, dTypeCix, dtypeCpp, dTypeFBpinNonArray, dTypeIxMdl, explainDTypeIx, getSteptime, getSteptimeStr, isComplexDType, namePin, propagateSteptime, sDTypeIx, sDTypeIx, sDTypeIxId, XXXdTypeIxMdl

Methods inherited from class org.vishia.fbcl.fblock.Pin_FBcl
addEvchain, addEvchainDepending, changePinType, connDst, connectFrom, connectFrom, connectFrom, connSrc, containsEvchain, containsOtherEvchain, dinType, doutType, evChainHex, evinType, evoutType, getFirstConnDst, getFirstConnSrc, getMaskEvinMdlChainDriven, getMaskEvoutMdlBackChainDriven, getOneConnSrc, getOneConnSrc, graphicPos, isEventBackChainDriven, isEventBackChainDriven, isEventChainDriven, isEventChainDriven, isEventChainDriven, isEventChainDriven, isKind, isNotKind, isUpdatePin, iterConnDst, iterConnSrc, iterEvchainDep, iterEvchainShow, nameFBpin, nameFBpin, nameIdentifier, nrofConnDst, nrofConnSrc, pinNameFB, pint, pinType, removeConnectDst, removeConnectSrc, removeConnSrcAll, removePinSimpleInConnDst, setEventBackChainDriven, setEventChainDriven, sMaskHexEvinMdlChainDriven, spec, spec, throwError, toString, XXXremoveConnectSrc, XXXremoveConnSrc, XXXsetEventBackChainDriven

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

- Field Detail
  - nullArray
```
public static Din_FBcl[] nullArray
```
  - sConstant
```
private java.lang.String sConstant
```
    If not null then it is a constant given as String on this input. Note: a numeric constant is written "1.234", a String constant is contained with " here ("\"string\""). Note: If given, connectFromBlock is null.
  - dTypePropg
```
private DType_FBcl.DtIxmdl dTypePropg
```
    The data type which comes from the input wiring, set in DTypePropgPrc_FBcl via #setDTypePropg(DType_FBcl.DtIxmdl). It is usable for cast to dTypeCastInp(), if the source type should be known. It is also interesting for report, see Reporter_FBcl. see #setDTypePropg(org.vishia.fbcl.fblock.DType_FBcl.DtIxmdl). see dTypePropg().
  - bCastDType
```
private boolean bCastDType
```
    True then {@link #setDTypeCastInp(DType_FBcl.DtIxmdl) was called or the propagated DType is not the same as the own.
  - dTypeCastInp
```
protected DType_FBcl.DtIxmdl dTypeCastInp
```
    A possible specific data type for the pin as cast from the input. Usual the data types are stored in DinoutType_FBcl.dType as fix dtype in the pin type or in FBlock_FBcl.dTypes as type of maybe some more pins of this Pin_FBcl.fb adequate to the index given in DinoutType_FBcl#ixDtype. But for expressions it is possible that each input has a specific forward propagated data type which may be used for type casting in the generated code etc.
  - dTypeConst
```
private DType_FBcl dTypeConst
```
    Detected Data Type of a sConstant used for adaption of the given constant value. For example 1.01 is detected as double. For C-Code generation cast to float creates "1.01f". Cast to a integer with fractional bits generates for example "(int16)((1L<
  - bNonFBarray
```
protected boolean bNonFBarray
```
    If true, then this pin is connected for all FBlock array elements with the same signal.
  - ixArrayAccess
```
protected int[] ixArrayAccess
```
    If not "", then it describes the access to an element in the connected doutSrc array as textual information written in an din. An element array access is such as "[1]" or "[1,2]" It should not be confused with the "[1]" designation for element assign to the output variable of an expression. This is a really textual access description possibility.
  - bBreakChain
```
protected boolean bBreakChain
```
    An input which breaks the chain of events because of an special internal wiring condition from the source of the graphical module, OdgConnection.ECkind.dataGet it is set if the connection comes from a VarZ_OFB or from a connection style ofcDataGet. It is evaluated in DFlow2EvChain.
  - mEvCluster
```
public long mEvCluster
```
    Association of the din on a FBlock instance or the module's dout to one or more evCluster
- Constructor Detail
  - Din_FBcl
```
public Din_FBcl(DinType_FBcl pint,
                java.lang.String name,
                FBlock_FBcl fb,
                XY_FBcl xy)
```
  - Din_FBcl
```
public Din_FBcl(DinType_FBcl pint,
                FBlock_FBcl fb,
                XY_FBcl xy)
```
- Method Detail
  - setConstant
```
public void setConstant(java.lang.String val,
                        java.util.Map<java.lang.String,java.lang.String> idxAlias)
```
    Sets the sConstant and sets also a detected type of the const to dTypeConst(). First the given 'val' is translated with 'idxAlias' if it is an alias. Then:
    - If the const starts with an apostroph or quotation mark (0x27, 0x22), then the dtype is set as String. It is not tested, whether an end quotation is given.
    - If the const starts with '0x' it is set as 'J' or int64.
    - if the const starts with digits, able to parse as int, then it is tested whether a '.' follows. If yes, it is set as 'D' or double.
    - If a '.' does not follow after int value, it is set as 'J' or int64.
    - if the const is not able to assign in one of them, dTypeCastInp is set to null.
    With this information a conversion can be done in the target language.
    Parameters:
    
    val - given String in the graphic.
    
    idxAlias - possible alias
  - setConstantDirect
```
public void setConstantDirect(java.lang.String val)
```
    Called only for String constants, especially for expr term.
    
    Parameters:
    
    val -
  - replaceAliasConst
```
public static final java.lang.String replaceAliasConst(java.lang.String src,
                                                       java.util.Map<java.lang.String,java.lang.String> idxAlias)
```
  - getConstant
```
public java.lang.String getConstant()
```
  - getConstant
```
public java.lang.String getConstant(int ix)
```
    Gets a part from the sConstant which should contain more as one parts separated with comma. For example "1, 2, 4, 8, 32" or "1.0, 3.16, 10.0"
    
    Parameters:
    
    ix - from 0.., number of the part
    
    Returns:
    
    the string of the part.
  - iterConnSrcConditional
```
public java.lang.Iterable<PinConnect_FBcl> iterConnSrcConditional(long[] condBits,
                                                                  long mEvinMdlMask,
                                                                  java.lang.String sVariant,
                                                                  int ixFBlock)
```
    Iterator for all connections to use. If the pin has a sConstant, then one emtpy connection is delivered. That is only used to enter in the evaluation of this pin (evaluates for connections). Because of PinConnect_FBcl.pinSrc is null, it is not used, instead then the sConstant is tested. The operation is used in otx scripts to evaluate expression inputs.
    
    Parameters:
    
    condBits - if given, then only connections for this conditions are delivered. This is checked with the event Evinout_FBcl.getConditionBits() for conditional event driven outputs which are connected to the same destination.
    
    Returns:
    
    List as Iterable with the connections or with one empty connection if the pin has sConstant.
  - setBreakEventChain
```
public void setBreakEventChain()
```
  - breakEventChain
```
public boolean breakEventChain()
```
  - setDTypeCastInp
```
public boolean setDTypeCastInp(DType_FBcl.DtIxmdl dtix)
```
    Sets initial the dTypeCastInp. It it is set already, it is not changed. It means the first set DType wins. This is used for value casting of the input in generated code.
    
    Parameters:
    
    dt -
    
    Returns:
    
    true if determined or equal, false if not set newly.
  - dTypeCastInp
```
public DType_FBcl.DtIxmdl dTypeCastInp()
```
    Returns null or the DType set with setDTypeCastInp(org.vishia.fbcl.fblock.DType_FBcl.DtIxmdl).
    
    Returns:
  - setDTypePropg
```
public boolean setDTypePropg(DType_FBcl.DtIxmdl dtix,
                             boolean bCast)
```
    Sets initial the dTypePropg. It it is set already, it is not changed. It means the first set DType wins. This is used for value casting of the input in generated code.
    
    Parameters:
    
    dtix - DType to set in propagation
    
    bCast - true then cast should be done in target code generation, because the dtix is another than the given DType of the pin. It is false on application to DinExpr_FBcl, because the expression should work with the forward given DTypes with the expression. But it is set on Din on FBlocks with given DTypes.
    
    Returns:
    
    true if determined or equal, false if not set newly.
  - dTypePropg
```
public DType_FBcl.DtIxmdl dTypePropg()
```
    Returns null or the already forward propagated DType set with setDTypePropg(org.vishia.fbcl.fblock.DType_FBcl.DtIxmdl, boolean).
  - bCastDType
```
public boolean bCastDType()
```
    Returns true if a numeric cast (also maybe with bit shift) in target code generation should be done. See bCastDType. It is set on {@link #setDTypeCastInp(DType_FBcl.DtIxmdl) or on #setDTypePropg(DType_FBcl.DtIxmdl, boolean) but only with argument 'bCast', which is set if the propagation has a different DType in the source of this din.
    
    Returns:
  - setDTypeConst
```
public boolean setDTypeConst(DType_FBcl dt)
```
    Sets initial the dTypeConst. It it is set already, it is not changed. It means the first set DType wins. This is used for value casting of the input in generated code.
    
    Parameters:
    
    dt -
    
    Returns:
    
    true if determined or equal, false if not set newly.
  - dTypeConst
```
public DType_FBcl dTypeConst()
```
  - dTypeDecl
```
public DType_FBcl dTypeDecl()
```
    Returns the DType for the din pin as declared, not the cast type. it calls the Dinout_FBcl#dType() to get the DType from the whole FBlock defined
    
    Overrides:
    
    dTypeDecl in class Dinout_FBcl
    
    Returns:
    
    DType as declared on pin. TODO really necessary? It was for constant values only? Yet it does the same as Dinout_FBcl.dType()
  - getDTypeIxMdl
```
DType_FBcl.DtIxmdl getDTypeIxMdl()
```
    Description copied from class: Dinout_FBcl
    
    Gets a possible DType with ixMdl as stored in specific pins. This operation is overridden for specific pins. This default implementation for ordinary FBlock pins returns null, because a ixMdl is stored in FBlock_FBcl.dTypes. see Din_FBcl
    
    Overrides:
    
    getDTypeIxMdl in class Dinout_FBcl
    
    Returns:
  - setNonFBarray
```
public void setNonFBarray(boolean set)
```
    If true, then this pin is connected for all FBlock array elements with the same signal. see FBlock_FBcl.sizeArrayFB
  - nonFBarray
```
public boolean nonFBarray()
```
    If true, then this pin is connected for all FBlock array elements with the same signal. see FBlock_FBcl.sizeArrayFB
  - setDType
```
public java.lang.String setDType(DType_FBcl.DtIxmdl dtixSrc,
                                 LogMessage log)
```
    Overridden form for Dinout_FBcl#setDType(DType_FBcl): If dTypeCastInp is set, this is determining. It means the given src is ignored. dTypeCastInp is set by graphic text, as value casting, in responsible to the user.
    Else it calls the original Dinout_FBcl#setDType(DType_FBcl, DType_FBcl, org.vishia.msgDispatch.LogMessage).
    
    Overrides:
    
    setDType in class Dinout_FBcl
    
    Parameters:
    
    dtixSrc - any given Data Type.
    
    Returns:
    
    null if ok or an error/warning message String "DType is not able to change: " + Pin_FBcl.nameFBpin().
  - getConnSrc
```
public Dout_FBcl getConnSrc()
```
    Gets the source of this pin. It invokes Pin_FBcl#getOneConnection() because there is either null or only one Connection from the dout.
    
    Returns:
    
    null if dangling or has a getConstant(), elsewhere the source for the pin
  - XXXconnectSrc
```
public java.lang.Iterable<Dout_FBcl> XXXconnectSrc()
```
  - getDintype
```
public DinType_FBcl getDintype()
```
  - operationsType
```
public java.lang.Iterable<EccAction_FBcl> operationsType()
```
    Returns the appropriate Operation-List of the type to this pin.
    
    Returns:
    
    never null, maybe an empty Iterable
  - getOnlyoneAssocEvin
```
public Evin_FBcl getOnlyoneAssocEvin()
```
  - toString
```
public java.lang.StringBuilder toString(java.lang.StringBuilder app,
                                        java.lang.String... cond)
```
    Overrides:
    
    toString in class Pin_FBcl
    
    See Also:
    
    ToStringBuilder#toString(StringBuilder, String...)
  - iterEvin
```
public java.lang.Iterable<Evin_FBcl> iterEvin()
```

Class Din_FBcl

Nested Class Summary

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

Field Summary

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Field Detail

nullArray

sConstant

dTypePropg

bCastDType

dTypeCastInp

dTypeConst

bNonFBarray

ixArrayAccess

bBreakChain

mEvCluster

Constructor Detail

Din_FBcl

Din_FBcl

Method Detail

setConstant

setConstantDirect

replaceAliasConst

getConstant

getConstant

iterConnSrcConditional

setBreakEventChain

breakEventChain

setDTypeCastInp

dTypeCastInp

setDTypePropg

dTypePropg

bCastDType

setDTypeConst

dTypeConst

dTypeDecl

getDTypeIxMdl

setNonFBarray

nonFBarray

setDType

getConnSrc

XXXconnectSrc

getDintype

operationsType

getOnlyoneAssocEvin

toString

iterEvin