Module_FBcl

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

Direct Known Subclasses:

ModuleAlgorithm_FBcl
```
public class Module_FBcl
extends java.lang.Object
```
This class describes the inner functionality of a FBtype_FBcl build with FBcl connections. It means it contains FBlocks with connections to fulfill its functionality. It is completely described with FBcl.

The base (super) class {FBlock_FBcl} presents the module pins to inner: The pins of the module needs a reference to its associated FBlock_FBcl, this is the module itself.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Module_FBcl.Create
Helper class to create an FBlock_FBcl and its properties.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Module_FBcl.Create` Helper class to create an `FBlock_FBcl` and its properties.

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) static DoutMdl_FBcl[]`	`doutPortEmpty`
`(package private) DType_FBcl[]`	`dtypes`
`private java.util.List<EccState_FBcl>`	`eccStates`
`java.util.List<Evchain_FBcl>`	`evChains` All detected chains of simple connected operations (evin to evout of some FBs).
`protected EvtreeNode_FBcl`	`evTree_const` This three nodes for const, ctor, init play a special role for code generation.
`protected FBexpr_FBcl[]`	`exprEv` Array of all existing 'exprEv' associated to the condition bits.
`FBlock_FBcl`	`fbp` Reference to the inner pins of the module.
`protected java.util.Map<java.lang.String,FBlock_FBcl>`	`idxFBlock` All FBlocks inside the module sorted by name Note: The inport and outport are accessible via `FBlock_FBcl.din` and `FBlock_FBcl.dout` sorted by port index.
`protected java.util.Map<java.lang.String,FBlock_FBcl>`	`idxFBlockTEST` All FBlocks inside the module sorted by name with type name starting with "TEST" Note: The inport and outport are accessible via `FBlock_FBcl.din` and `FBlock_FBcl.dout` sorted by port index.
`protected java.util.Map<java.lang.String,FBtype_FBcl>`	`idxFBlockType` Types which are defined locally in this module.
`protected java.util.Map<java.lang.String,java.lang.String>`	`idxImport` Import files for code generation (Header, Java import).
`protected java.util.Map<java.lang.String,Dout_FBcl>`	`idxVariables` All variables which are outputs of expressions, accessible by name used in K1999-Inputs of other expressions and appears in code as variables.
`java.util.Map<java.lang.String,OdgXref>`	`idxXrefByName` The Xref has a extra meaning, because they are also aliases for data connection which should be regard to build the expressions.
`FBtype_FBcl`	`ifcFB` The Type FBlock to this module.
`protected java.util.List<EccAction_FBcl>`	`listAction`
`protected java.util.List<EvtreeNode_FBcl>`	`listEvTreeRoot` root nodes of all evTree.
`private java.util.Map<java.lang.String,Algorithm_FBcl>`	`mapAlgorithm`
`java.lang.String`	`name`
`Network_FBcl[]`	`networks` Networks in the order of representation.
`private Algorithm_FBcl`	`simpleFBalgm` It is null if the FBlock is not a Simple FB.
`java.lang.String`	`sLibFile`
`static java.lang.String`	`sVersion` Version, history and license.

Constructor Summary

Constructors
Constructor and Description
`Module_FBcl(java.lang.String name, Prj_FBCLrd prj)` Creates a Module which is a `FBlock_FBcl` and creates also the associated `FBtype_FBcl` which is adequate to the inner pins of the module, with the `FBtype_FBcl._kindFBt` = `FBlock_FBcl.Blocktype.TheModule`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`adjustFBexrFnDtypes()` Adjust the type designations in `FBexpr_FBcl.sFn` for all expressions due to the propagated pin data types.
`java.lang.Iterable<EccAction_FBcl>`	`allOperations()`
`EccAction_FBcl`	`allOperations(int ix)`
`FBexpr_FBcl[]`	`exprEv()`
`DType_FBcl[]`	`getDataTypes()`
`Dout_FBcl[]`	`getdinPortToInnerMdl()` Gets the inner connection, output of the module
`DoutMdl_FBcl[]`	`getdoutPortFromInnerMdl()` Gets the inner connection, output of the module
`Evout_FBcl`	`getEvinMdlforChain(Pin_FBcl pin)`
`FBlock_FBcl`	`getFBlock(java.lang.String name)`
`java.util.Map<java.lang.String,FBlock_FBcl>`	`getFBlocks()`
`FBlock_FBcl`	`getFBlockTest(java.lang.String name)` Returns !
`FBtype_FBcl`	`getFBlockType(java.lang.String name)`
`FBtype_FBcl`	`getIfcFB()`
`Dout_FBcl`	`getVariable(java.lang.String name)` Gets a variable in the module.
`boolean`	`isSimpleFB()`
`java.lang.Iterable<java.util.Map.Entry<java.lang.String,Algorithm_FBcl>>`	`iterAlgorithm()`
`java.lang.Iterable<EvtreeNode_FBcl>`	`iterEvtreeRoot()`
`java.lang.Iterable<FBlock_FBcl>`	`iterFBlock()`
`java.lang.Iterable<FBtype_FBcl>`	`iterFBtype()`
`java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.String>>`	`iterImport()`
`java.lang.Iterable<EccState_FBcl>`	`iterStates()`
`java.lang.String`	`name()` Returns the name of the module.
`int`	`nrofFBlockType()`
`int`	`nrofStates()`
`Algorithm_FBcl`	`simpleAlgorithm()`
`java.lang.String`	`toString()`

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:
    - 2023-10-23 inherits from FBlock_FBcl used for the pins of modules. It is not a complicated change.
    - 2019-06-19 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
```
public final java.lang.String name
```
  - ifcFB
```
public final FBtype_FBcl ifcFB
```
    The Type FBlock to this module.
  - fbp
```
public final FBlock_FBcl fbp
```
    Reference to the inner pins of the module. This refers then the FBtype_FBcl representation of the inner module pins, but they are not necessary. The real type is the ifcFB. This FBlock_FBcl of the inner pins and the ifcFB mirrors the pins. A FBlock_FBcl.din is correspond to FBtype_FBcl.doutPin etc. Adequate the FBlock_FBcl#fbtype of this fbp mirrors the pins to ifcFB.
  - sLibFile
```
public java.lang.String sLibFile
```
  - doutPortEmpty
```
static DoutMdl_FBcl[] doutPortEmpty
```
  - networks
```
public Network_FBcl[] networks
```
    Networks in the order of representation.
  - evChains
```
public java.util.List<Evchain_FBcl> evChains
```
    All detected chains of simple connected operations (evin to evout of some FBs). It is an internal view of the event connections used on code generation and for clarify which din, dout and evin, evout are really related together. The last one is contained in the Evchain_FBcl.operation which is referred from the associated EvinType_FBcl from the interface too.
  - simpleFBalgm
```
private Algorithm_FBcl simpleFBalgm
```
    It is null if the FBlock is not a Simple FB. Elsewhere the parsed data of the algorithm are contained here.
  - mapAlgorithm
```
private java.util.Map<java.lang.String,Algorithm_FBcl> mapAlgorithm
```
  - dtypes
```
DType_FBcl[] dtypes
```
  - exprEv
```
protected FBexpr_FBcl[] exprEv
```
    Array of all existing 'exprEv' associated to the condition bits. This exprEv are set with Module_FBcl.Create.addAllExprEv(List) which is called in
  - idxVariables
```
protected java.util.Map<java.lang.String,Dout_FBcl> idxVariables
```
    All variables which are outputs of expressions, accessible by name used in K1999-Inputs of other expressions and appears in code as variables.
  - idxFBlock
```
protected java.util.Map<java.lang.String,FBlock_FBcl> idxFBlock
```
    All FBlocks inside the module sorted by name Note: The inport and outport are accessible via FBlock_FBcl.din and FBlock_FBcl.dout sorted by port index.
  - idxFBlockTEST
```
protected java.util.Map<java.lang.String,FBlock_FBcl> idxFBlockTEST
```
    All FBlocks inside the module sorted by name with type name starting with "TEST" Note: The inport and outport are accessible via FBlock_FBcl.din and FBlock_FBcl.dout sorted by port index.
  - idxFBlockType
```
protected java.util.Map<java.lang.String,FBtype_FBcl> idxFBlockType
```
    Types which are defined locally in this module.
  - idxImport
```
protected java.util.Map<java.lang.String,java.lang.String> idxImport
```
    Import files for code generation (Header, Java import). Note: The separator between path parts should be the slash, as rule for graphic.
  - idxXrefByName
```
public final java.util.Map<java.lang.String,OdgXref> idxXrefByName
```
    The Xref has a extra meaning, because they are also aliases for data connection which should be regard to build the expressions. This idea comes from LibreOffice odg graphic. In Simulink using of parameters are similar but more strong.
  - listEvTreeRoot
```
protected java.util.List<EvtreeNode_FBcl> listEvTreeRoot
```
    root nodes of all evTree.
  - evTree_const
```
protected EvtreeNode_FBcl evTree_const
```
    This three nodes for const, ctor, init play a special role for code generation. Hence stored extra for fast access.
  - listAction
```
protected java.util.List<EccAction_FBcl> listAction
```
  - eccStates
```
private java.util.List<EccState_FBcl> eccStates
```
- Constructor Detail
  - Module_FBcl
```
public Module_FBcl(java.lang.String name,
                   Prj_FBCLrd prj)
```
    Creates a Module which is a FBlock_FBcl and creates also the associated FBtype_FBcl which is adequate to the inner pins of the module, with the FBtype_FBcl._kindFBt = FBlock_FBcl.Blocktype.TheModule. This is not the interface to the module. The Interface of the module in #ifcFB is created as separate FBtype_FBcl. with the FBtype_FBcl._kindFBt = FBlock_FBcl.Blocktype.Libmodule.
    
    Both FBtype_FBcl are mirrored. A FBtype_FBcl.doutPin of the module's inner FBlock_FBcl as input to the inner of the module is represented by a FBtype_FBcl.dinPin as input pin to the interface FBlock of the module and adequate.
    
    Parameters:
    
    name - Name of the module.
- Method Detail
  - exprEv
```
public FBexpr_FBcl[] exprEv()
```
  - name
```
public java.lang.String name()
```
    Returns the name of the module. Note: name() returns "$module" as name of the inner FBlock_FBcl of the module pins
    
    Returns:
  - getFBlock
```
public FBlock_FBcl getFBlock(java.lang.String name)
```
  - getFBlockTest
```
public FBlock_FBcl getFBlockTest(java.lang.String name)
```
    Returns !=null if the FBlock with the given name is a test block.
    
    Parameters:
    
    name -
    
    Returns:
    
    the test Block itself to evaluate it.
  - getFBlocks
```
public java.util.Map<java.lang.String,FBlock_FBcl> getFBlocks()
```
  - iterFBlock
```
public java.lang.Iterable<FBlock_FBcl> iterFBlock()
```
  - getFBlockType
```
public FBtype_FBcl getFBlockType(java.lang.String name)
```
  - iterFBtype
```
public java.lang.Iterable<FBtype_FBcl> iterFBtype()
```
  - iterImport
```
public java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.String>> iterImport()
```
  - iterEvtreeRoot
```
public java.lang.Iterable<EvtreeNode_FBcl> iterEvtreeRoot()
```
  - nrofFBlockType
```
public int nrofFBlockType()
```
  - getVariable
```
public Dout_FBcl getVariable(java.lang.String name)
```
    Gets a variable in the module. That is a variable after expression or also a Xref name referencing a Dout
    
    Parameters:
    
    name - name of the FBlock which contains the output variable. This is the stored name of the Dout_FBcl
    
    Returns:
    
    null if not existing, else the one Dout_FBcl of this FBlock.
  - getIfcFB
```
public FBtype_FBcl getIfcFB()
```
  - isSimpleFB
```
public boolean isSimpleFB()
```
  - allOperations
```
public java.lang.Iterable<EccAction_FBcl> allOperations()
```
  - allOperations
```
public EccAction_FBcl allOperations(int ix)
```
  - iterAlgorithm
```
public java.lang.Iterable<java.util.Map.Entry<java.lang.String,Algorithm_FBcl>> iterAlgorithm()
```
  - nrofStates
```
public int nrofStates()
```
  - iterStates
```
public java.lang.Iterable<EccState_FBcl> iterStates()
```
  - simpleAlgorithm
```
public Algorithm_FBcl simpleAlgorithm()
```
  - getdinPortToInnerMdl
```
public Dout_FBcl[] getdinPortToInnerMdl()
```
    Gets the inner connection, output of the module
  - getdoutPortFromInnerMdl
```
public DoutMdl_FBcl[] getdoutPortFromInnerMdl()
```
    Gets the inner connection, output of the module
  - getDataTypes
```
public DType_FBcl[] getDataTypes()
```
  - getEvinMdlforChain
```
public Evout_FBcl getEvinMdlforChain(Pin_FBcl pin)
```
  - adjustFBexrFnDtypes
```
public void adjustFBexrFnDtypes()
```
    Adjust the type designations in FBexpr_FBcl.sFn for all expressions due to the propagated pin data types.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class Module_FBcl

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

sVersion

name

ifcFB

fbp

sLibFile

doutPortEmpty

networks

evChains

simpleFBalgm

mapAlgorithm

dtypes

exprEv

idxVariables

idxFBlock

idxFBlockTEST

idxFBlockType

idxImport

idxXrefByName

listEvTreeRoot

evTree_const

listAction

eccStates

Constructor Detail

Module_FBcl

Method Detail

exprEv

name

getFBlock

getFBlockTest

getFBlocks

iterFBlock

getFBlockType

iterFBtype

iterImport

iterEvtreeRoot

nrofFBlockType

getVariable

getIfcFB

isSimpleFB

allOperations

allOperations

iterAlgorithm

nrofStates

iterStates

simpleAlgorithm

getdinPortToInnerMdl

getdoutPortFromInnerMdl

getDataTypes

getEvinMdlforChain

adjustFBexrFnDtypes

toString