FBlock_FBcl

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

Direct Known Subclasses:

Attribute, Comment, FBaccess_FBcl, FBexpr_FBcl, FBjoin_FBcl, OdgXref, Requirement
```
public class FBlock_FBcl
extends java.lang.Object
```
Instances of this presents the FBlock instances of an FBlock diagram.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`FBlock_FBcl.Blocktype` This enum describes the general FBlock usage.
`static class`	`FBlock_FBcl.WriteFB` Helper class to create an `FBlock_FBcl` and its properties.

Field Summary

Fields
Modifier and Type	Field and Description
`Din_FBcl[]`	`din` Array of all connections to other Block_Mdl in the same module for inputs of this.
`Dout_FBcl[]`	`dout` Array of all connections to other Block_Mdl in the same module for outputs of this.
`(package private) static Dout_FBcl[]`	`doutempty`
`protected DType_FBcl[][]`	`dTypes` Array of all variant data types or null if not given.
`Evin_FBcl[]`	`evin`
`Evout_FBcl[]`	`evout`
`PinFbDst_FBcl`	`fbPinDst`
`PinFbSrc_FBcl`	`fbPinSrc` It is a pin for connections from this FB to other FBs or Pins.
`protected FBtype_FBcl`	`fbt` All blocks in a model should refer the type.
`XY_FBcl`	`graphicPos` The graphic position of the first occurence of this FBlock in the graphic.
`protected java.util.Map<java.lang.String,Pin_FBcl>`	`idxPins`
`protected java.lang.String`	`name` Name of the instance of the block.
`PinPort_FBcl[]`	`port`
`PinRef_FBcl[]`	`reference`
`protected int[]`	`sizeArrayIxSlice` If not null, then this FBlock was drawn as GBlock as sliced or as array.
`java.lang.String[]`	`sOperators` Deprecated.
`(package private) SteptimeRef_FBcl`	`steptime` Deprecated.
`static java.lang.String`	`sVersion` Version, history and license.

Constructor Summary

Constructors
Constructor and Description
`FBlock_FBcl(FBtype_FBcl typeFb, java.lang.String name, Module_FBcl parentModule, XY_FBcl graphicPos)` Create an FBlock yet without dout, din because the number of din may depend on wiring in the module.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Pin_FBcl[]`	`din()` Returns the originally value of `din` as getter access.
`Din_FBcl[]`	`dinForeach()` Returns never null, able to use in a for-loop.
`Dout_FBcl[]`	`dout()` Returns the originally value of `dout` as getter access.
`Dout_FBcl[]`	`doutForeach()` Returns never null, able to use in a for-loop.
`DType_FBcl[][]`	`dtypes()`
`Evin_FBcl[]`	`evin()` Returns the originally value of `evin` as getter access.
`Evin_FBcl`	`evin(int ix)`
`Evout_FBcl[]`	`evout()` Returns the originally value of `evout` as getter access.
`Evout_FBcl`	`evout(int ix)`
`FBtype_FBcl`	`fbt()`
`PinFbSrc_FBcl`	`getFbPinSrc()` Creates if not given the PinInstance for a connection from the FBlock_FBcl itself, not from a dedicated pin.
`int`	`getNrofConnin(Pin_FBcl.XXXXXEKind kind)`
`int`	`getNrofConnout(Pin_FBcl.XXXXXEKind kind)`
`int`	`getNrofDin()`
`int`	`getNrofDout()`
`int`	`getNrofEvin()`
`int`	`getNrofEvout()`
`DoutType_FBcl.EProps`	`getOut1Properties()` Returns the output property of conout[0] as representer of the function blocks property.
`Pin_FBcl`	`getPin(java.lang.String name)`
`Pin_FBcl`	`getPinEvInByName(java.lang.String name)`
`Pin_FBcl`	`getPinEvOutByName(java.lang.String name)`
`Din_FBcl`	`getPinInByName(java.lang.String name)` Deprecated. it is faulty because yet the pins can have different names in type and obj
`Dout_FBcl`	`getPinOutByName(java.lang.String name)`
`SteptimeRef_FBcl`	`getSteptime()`
`java.lang.String`	`getSteptimeStr()`
`FBtype_FBcl`	`getTypeFB()`
`boolean`	`isKind(java.lang.String cKinds)` Check whether the `FBtype_FBcl` of this has one of the given kind.
`java.lang.Iterable<Evout_FBcl>`	`iterEvout(Evin_FBcl evin)`
`java.lang.Iterable<Evout_FBcl>`	`iterEvout(Evin_FBcl evin, boolean bCreate)` Iterator over all associated evout to a evin (usual one) using the `#listEvout`.
`java.lang.Iterable<Pin_FBcl>`	`iterPins()`
`int`	`ixSlice()` Returns the information about the index of the FBlock in a sliced GBlock, also important for connection data types
`FBlock_FBcl.Blocktype`	`kind()` Returns the kind of the FBlock which is determined by the kind of the `FBtype_FBcl.kind()` Hint: The kind should be taken from `fbt`.
`boolean`	`kindWhatis(java.lang.String cKinds)` Check whether the `FBtype_FBcl` of this is one of the given kind.
`java.lang.String`	`name()`
`java.lang.String`	`setDtype(int ix, DType_FBcl dtype)` Checks and sets the changeable data type and adjusts all depending data types.
`void`	`setName(java.lang.String name)`
`boolean`	`setSizeArray(int[] sizeArray)` This operation is called if a dout of array Dtype is connected to a din of a FBlock which is scalar respectively has a lesser array dimension.
`boolean`	`setSliceIndex(int ixSlice, org.vishia.msgDispatch.LogMessage log)` Sets the one dimensional index of the number in the slice if the FBlock is part of a sliced GBlock.
`int[]`	`sizeArray()` Returns the information about the array properties of this FBlock
`int[]`	`sizeArrayIxSlice()` See `sizeArrayIxSlice`
`java.lang.String`	`toString()`
`java.lang.String`	`typeName()` Returns a proper typename for FBCL
`Pin_FBcl`	`XXXgetConnin(Pin_FBcl.XXXXXEKind what, int ixPin)`
`Pin_FBcl`	`XXXgetConnout(Pin_FBcl.XXXXXEKind what, int ixPin)`

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

- Field Detail
  - sVersion
```
public static java.lang.String sVersion
```
    Version, history and license. Changes:
    - 2019-06-22 creation
    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 ist 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.
  - name
```
protected java.lang.String name
```
    Name of the instance of the block. Note: The _ prefix is used to sort in eclipse variable view. Additional the _ is a signature for a private or protected element.
  - sizeArrayIxSlice
```
protected int[] sizeArrayIxSlice
```
    If not null, then this FBlock was drawn as GBlock as sliced or as array. If the index value is negative, it is defined as array with this size. This may be only for the first value(s). If the following or all indeces are positive, then it is the index of this FBlock in a sliced graphic. If a vector or multi dimensional data pin is connected to a single pin, then this is the access index.
  - graphicPos
```
public final XY_FBcl graphicPos
```
    The graphic position of the first occurence of this FBlock in the graphic. All graphic positions may be stored also, but needs a list here. (TODO)
  - fbt
```
protected FBtype_FBcl fbt
```
    All blocks in a model should refer the type.
  - sOperators
```
@Deprecated
public java.lang.String[] sOperators
```
    Deprecated.
    
    Used in ProcessSlxBlocks_Slx for Gain etc. but this should use an Expression.and hence the Expression Pins .
  - fbPinSrc
```
public PinFbSrc_FBcl fbPinSrc
```
    It is a pin for connections from this FB to other FBs or Pins. For example for inheritance, dependencies, requirements and end points of association etc as class Type.
  - fbPinDst
```
public PinFbDst_FBcl fbPinDst
```
  - din
```
public Din_FBcl[] din
```
    Array of all connections to other Block_Mdl in the same module for inputs of this.
  - dout
```
public Dout_FBcl[] dout
```
    Array of all connections to other Block_Mdl in the same module for outputs of this.
  - doutempty
```
static Dout_FBcl[] doutempty
```
  - dTypes
```
protected DType_FBcl[][] dTypes
```
    Array of all variant data types or null if not given. From this data types DType_FBcl.dtBase is changed if the data type will be more specified.
  - steptime
```
@Deprecated
SteptimeRef_FBcl steptime
```
    Deprecated.
    
    If null then the FBlock has more as one Steptimes. If not null all Connections refer to the same one.
  - evin
```
public Evin_FBcl[] evin
```
  - evout
```
public Evout_FBcl[] evout
```
  - reference
```
public PinRef_FBcl[] reference
```
  - port
```
public PinPort_FBcl[] port
```
  - idxPins
```
protected final java.util.Map<java.lang.String,Pin_FBcl> idxPins
```
- Constructor Detail
  - FBlock_FBcl
```
public FBlock_FBcl(FBtype_FBcl typeFb,
                   java.lang.String name,
                   Module_FBcl parentModule,
                   XY_FBcl graphicPos)
```
    Create an FBlock yet without dout, din because the number of din may depend on wiring in the module. This ctor is only used in FBlock_FBcl.WriteFB
    
    Parameters:
    
    typeFb -
    
    name -
    
    graphicPos - if null then creates internally an empty one, for secondary FBlocks not found in graphic.
    
    parentModule -
- Method Detail
  - name
```
public java.lang.String name()
```
  - setName
```
public void setName(java.lang.String name)
```
  - setSliceIndex
```
public boolean setSliceIndex(int ixSlice,
                             org.vishia.msgDispatch.LogMessage log)
```
    Sets the one dimensional index of the number in the slice if the FBlock is part of a sliced GBlock. Sets sizeArrayIxSlice(). Note that all sliced GBlocks for the same FBlock representation should have the same kind of slicing, elsewhere it is not possible using a unique indexing. If sizeArrayIxSlice is already set with another value, an error message occurs.
    This index is used if a data connection of array data type is given and an din is not an array, or the din is a lesser dimension array of one dimension. Then this index is used to select the element from the dout data.
    
    Parameters:
    
    ixSlice - The number from 0 for the sliced FBlock.
    
    log - for error message.
  - setSizeArray
```
public boolean setSizeArray(int[] sizeArray)
```
    This operation is called if a dout of array Dtype is connected to a din of a FBlock which is scalar respectively has a lesser array dimension. This is admissible. Due to such an data input the FBlock is detected as array organized FBlock (an array of FBlocks of this type).
    
    Parameters:
    
    sizeArray -
    
    Returns:
  - sizeArray
```
public int[] sizeArray()
```
    Returns the information about the array properties of this FBlock
    
    Returns:
    
    null if it is not an array FBlock (maybe sliced). !=null then sizes of dimension.
  - ixSlice
```
public int ixSlice()
```
    Returns the information about the index of the FBlock in a sliced GBlock, also important for connection data types
    
    Returns:
    
    -1 if it is not a sliced FBlock (maybe an array.). >=0 as index of the slice, one dimension.
  - sizeArrayIxSlice
```
public int[] sizeArrayIxSlice()
```
    See sizeArrayIxSlice
    
    Returns:
    
    null then the FBlock is not sliced and not an array. else: Negative values are the sizeArray, positive values are the index for sliced FBlocks.
  - iterPins
```
public java.lang.Iterable<Pin_FBcl> iterPins()
```
  - getPin
```
public Pin_FBcl getPin(java.lang.String name)
```
  - din
```
public Pin_FBcl[] din()
```
    Returns the originally value of din as getter access.
    
    Returns:
    
    null of no data inputs exists.
  - dout
```
public Dout_FBcl[] dout()
```
    Returns the originally value of dout as getter access.
    
    Returns:
    
    null of no data outputs exists.
  - dinForeach
```
public Din_FBcl[] dinForeach()
```
    Returns never null, able to use in a for-loop. If din is null, the DinType_FBcl.nullist is returned, an array with length 0.
    
    Returns:
    
    use-able container in a for-loop
  - doutForeach
```
public Dout_FBcl[] doutForeach()
```
    Returns never null, able to use in a for-loop. If dout is null, the DoutType_FBcl.nullist is returned, an array with length 0.
    
    Returns:
    
    use-able container in a for-loop
  - evin
```
public Evin_FBcl[] evin()
```
    Returns the originally value of evin as getter access.
    
    Returns:
    
    null of no event inputs exists. But in a valid design all FBlocks have event inputs.
  - evin
```
public Evin_FBcl evin(int ix)
```
  - evout
```
public Evout_FBcl[] evout()
```
    Returns the originally value of evout as getter access.
    
    Returns:
    
    null of no event outputs exists. But in a valid design all FBlocks have event outputs.
  - evout
```
public Evout_FBcl evout(int ix)
```
  - XXXgetConnin
```
public Pin_FBcl XXXgetConnin(Pin_FBcl.XXXXXEKind what,
                             int ixPin)
```
  - XXXgetConnout
```
public Pin_FBcl XXXgetConnout(Pin_FBcl.XXXXXEKind what,
                              int ixPin)
```
  - getFbPinSrc
```
public PinFbSrc_FBcl getFbPinSrc()
```
    Creates if not given the PinInstance for a connection from the FBlock_FBcl itself, not from a dedicated pin. The PinObj is stored in fbPinSrc in the FBlock_FBcl or Clazz (via this super class). The returned OdgGPin is stored in idxPinSrcById. If it is existing, the existing is returned and used more as one time for a connection.
    
    Parameters:
    
    fbi - The graphic FBlock_FBcl (with id and posxy)
    
    Returns:
    
    the PinInstance to use for a connection.
  - getNrofConnin
```
public final int getNrofConnin(Pin_FBcl.XXXXXEKind kind)
```
  - getNrofConnout
```
public final int getNrofConnout(Pin_FBcl.XXXXXEKind kind)
```
  - getNrofEvin
```
public final int getNrofEvin()
```
  - getNrofEvout
```
public final int getNrofEvout()
```
  - getNrofDin
```
public final int getNrofDin()
```
  - getNrofDout
```
public final int getNrofDout()
```
  - getPinEvInByName
```
public Pin_FBcl getPinEvInByName(java.lang.String name)
```
  - getPinEvOutByName
```
public Pin_FBcl getPinEvOutByName(java.lang.String name)
```
  - getPinOutByName
```
public Dout_FBcl getPinOutByName(java.lang.String name)
```
  - getPinInByName
```
public Din_FBcl getPinInByName(java.lang.String name)
```
    Deprecated. it is faulty because yet the pins can have different names in type and obj
    
    Parameters:
    
    name -
    
    Returns:
  - getSteptime
```
public SteptimeRef_FBcl getSteptime()
```
  - getSteptimeStr
```
public java.lang.String getSteptimeStr()
```
  - getOut1Properties
```
public DoutType_FBcl.EProps getOut1Properties()
```
    Returns the output property of conout[0] as representer of the function blocks property.
    
    Returns:
  - getTypeFB
```
public FBtype_FBcl getTypeFB()
```
  - fbt
```
public FBtype_FBcl fbt()
```
  - kind
```
public FBlock_FBcl.Blocktype kind()
```
    Returns the kind of the FBlock which is determined by the kind of the FBtype_FBcl.kind() Hint: The kind should be taken from fbt. FBtype_FBcl.kind()
    
    Returns:
  - kindWhatis
```
public boolean kindWhatis(java.lang.String cKinds)
```
    Check whether the FBtype_FBcl of this is one of the given kind.
    
    Parameters:
    
    cKinds - Possible characters for FBlock_FBcl.Blocktype.whatis
    
    Returns:
    
    true if descr is one of them.
  - isKind
```
public boolean isKind(java.lang.String cKinds)
```
    Check whether the FBtype_FBcl of this has one of the given kind.
    
    Parameters:
    
    cKinds - Possible characters for FBlock_FBcl.Blocktype.descr
    
    Returns:
    
    true if descr is one of them.
  - typeName
```
public java.lang.String typeName()
```
    Returns a proper typename for FBCL
    
    Since:
    
    2019-06
  - dtypes
```
public DType_FBcl[][] dtypes()
```
  - iterEvout
```
public java.lang.Iterable<Evout_FBcl> iterEvout(Evin_FBcl evin,
                                                boolean bCreate)
```
    Iterator over all associated evout to a evin (usual one) using the #listEvout.
    
    Parameters:
    
    evin - Any evin of this FBlock
    
    Returns:
    
    iterator to the associated evout if possible, often exact one.
  - iterEvout
```
public java.lang.Iterable<Evout_FBcl> iterEvout(Evin_FBcl evin)
```
  - setDtype
```
public java.lang.String setDtype(int ix,
                                 DType_FBcl dtype)
```
    Checks and sets the changeable data type and adjusts all depending data types.
    This operation checks the given DType_FBcl on this position in dTypes for compatibility. It is not compatible then returns the error message. If compatible or null is stored yet, then sets the given dtype argument to this position and adjusts all depending dTypes in the FBlock. in the dTypes array.
    
    Parameters:
    
    ix - the index in dTypes gotten form DinoutType_FBcl.ixDtype from the type pin.
    
    dtype - any given Data Type from argument or forward / backward propagation..
    
    Returns:
    
    null if ok or an error/warning message String "DType [<&ix>] is not able to change in FBlock: " + name.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class FBlock_FBcl

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

sVersion

name

sizeArrayIxSlice

graphicPos

fbt

sOperators

fbPinSrc

fbPinDst

din

dout

doutempty

dTypes

steptime

evin

evout

reference

port

idxPins

Constructor Detail

FBlock_FBcl

Method Detail

name

setName

setSliceIndex

setSizeArray

sizeArray

ixSlice

sizeArrayIxSlice

iterPins

getPin

din

dout

dinForeach

doutForeach

evin

evin

evout

evout

XXXgetConnin

XXXgetConnout

getFbPinSrc

getNrofConnin

getNrofConnout

getNrofEvin

getNrofEvout

getNrofDin

getNrofDout

getPinEvInByName

getPinEvOutByName

getPinOutByName

getPinInByName

getSteptime

getSteptimeStr

getOut1Properties

getTypeFB

fbt

kind

kindWhatis

isKind

typeName

dtypes

iterEvout

iterEvout

setDtype

toString