FBlock_JgenMdl

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

Direct Known Subclasses:: Callmodule_FBlock_JgenMdl, FBlock_Const_JgenMdl, FBlock_Gain_JgenMdl, FBlock_NumOperation_JgenMdl, FBlock_Port_JgenMdl, FBlock_Sfunction_JgenMdl, FBlock_SimpleFn_JgenMdl, FBlock_UnitDelay_JgenMdl, FBlock_VectorIter_JgenMdl, Module_FBlock_JgenMdl, Operation_FBlock_JgenMdl

public class FBlock_JgenMdl
extends FBlock_FBcl

The block is one small function with connections (wires) from and to other Block_Mdl in the module. It builds a functional-net. It may come from a graphical program.
Instances of this class build the core data of a module. The module is present with Module_JgenMdl
The block contains (see attributes):

maybe a name (TODO yet from slxBlock), not relevant for code generation, but maybe relevant for report.
A textual definition of the function sFunction and maybe addtional operators FBlock_FBcl.sOperators
Reference to StatementData_JgenMdl filled with Java code generation process

A block in a connection structure
Connection between 2 Block_Mdl instances in a module

   Block_Mdl                                                                            Block_Mdl
      |--outConnections---*>OutConnection                 InConnection<*----inConnections--|
      |                    -ixPort                        -ixPort                          |
      |                    -nameConnection                -nameConnection                  |
      |                        |                              |                            |
      |<1------itsBlock-----<*>|------connectToBlock--------*>|<*>--itsBlock-------------1>|
                               |                              |
                               |<1-------connectFromBlock-----|

The connection between the modules is done via instances of ConnOut_FBcl, output of the module, and ConnIn_FBcl, input of the other module.

Connection from 1 Block_Mdl which is the interface block to a sub module

                                           Block_Mdl (a module block)
                                              |
                                              |--module-->Module_Mdl--blocks---*>Block_Mdl
                                              |                      (all blocks of the module)
                                              |
 InConnection<*----------------inConnections--|--outConnections-----------------*>OutConnection 
 -ixPort                                      |                                  -ixPort       
 -nameConnection                              |                                  -nameConnectio
     |                                        |                                            |          
     |<*>--itsBlock-------------------------1>|<1----------------itsBlock---------------<*>|          
     |                                                                                     |          
     |                                                                                     |          
     |-inportInModule-->|                                              |<--outportInModule-|
     |            Block_Mdl (an Inport)             (an Outport) Block_Mdl          
                 -ixPort                                         -ixPort                 
                 -nameConnection                                 -nameConnection            
                        |                                              |                    
                        |             OutConnection                    |                    
                        |--outConnections--*>|                         |                    
                                             |                         |                    
                                             |--connectToBlock---*>    |                    
                                          (to Blocks in the Module)    |                    
                                                                       |                    
                                                                       |                    
                                                InConnection           |                    
                                                   |<1--inConnections--|                    
                           <1---connectFromBlock---|                     
                          (from Blocks in the Module

The module Block_Mdl refers a Module_JgenMdl which contains the Block_Mdl of the sub module.
The module Block_Mdl has #conin and #conout. The special case is: The ConnIn_FBcl#inportInModule and the ConnOut_FBcl#inportInModule are used. They refer to the Block_Mdl which are the Inport and the Outport of the sub module. An Inport has any number of #conout (maybe 0, more as 1) to the blocks inside the module, the Outport has exact 1 #conin from a Block inside the module. That is the submodule's blocks.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`FBlock_JgenMdl.ClusterInfo`
`static class`	`FBlock_JgenMdl.MaskParam_Mdl`
`(package private) static interface`	`FBlock_JgenMdl.XXXInitBlock`

Nested classes/interfaces inherited from class org.vishia.fbcl.fblock.FBlock_FBcl
FBlock_FBcl.Blocktype, FBlock_FBcl.WriteFB

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) Module_FBlock_JgenMdl`	`_moduleBlock` The superior block only used for `Callmodule_FBlock_JgenMdl` or `Module_FBlock_JgenMdl`.
`private FBlock_FBcl`	`_templateFb` The block which this block is copied from.
`(package private) boolean`	`bAddForTypePropagation`
`(package private) boolean`	`bAddInCluster`
`FBlock_JgenMdl.ClusterInfo`	`clusterInfo`
`(package private) int`	`conSliced` The number of slicing instances due to connections.
`(package private) DataTypePropagation_JgenMdl.State`	`dataTypesPropagated` 0 not propagated. 3 full propagated.
`(package private) int`	`dbgOrder` It is only for debug.
`(package private) java.lang.String`	`dbgStringType`
`FBlock_JgenMdl`	`dstFbExcl` The only one destination FBlock. null if the block has more as one destination @since 2019-04-30
`java.util.List<FBlock_JgenMdl>`	`dstFbMultiple` All destination FBlock if more as one.
`EvOutput_FBcl`	`eventOut` The associated event for calculation order.
`private EvOperation_FBcl`	`evOperation`
`private java.util.List<EvOperation_FBcl>`	`evOperations`
`(package private) java.util.Map<java.lang.String,FBlock_JgenMdl.MaskParam_Mdl>`	`maskParam` True if code was generated.
`(package private) Operation_FBlock_JgenMdl`	`opClusterBlock` The Block is member of a cluster inside the module.
`(package private) java.lang.String`	`sClassName` Name of the class where this operation is part of.
`java.lang.String`	`sFunction` The operation routine, function which is executed with this block.
`(package private) java.lang.String`	`sImport` package of the class where this FBlock's class is member of.
`(package private) java.lang.String`	`sInstanceName` If not null, then usage of this FBlock forces an composite instance in the module.
`SlxData.Block_SlxData`	`slxBlock` Reference to the simulink block.
`static java.lang.String[]`	`sOperators3Arg`
`FBlock_JgenMdl`	`srcFbExcl` Sources which refers this in dstExcl.
`java.util.List<FBlock_JgenMdl>`	`srcFbMultiple` Sources which refers this in dstMultiple.
`StatementData_JgenMdl`	`stm` If not null then this block is a end block in a generated statement.

Fields inherited from class org.vishia.fbcl.fblock.FBlock_FBcl
_itsModule, din, dout, evin, evout, name, sOperators, typeFB

Constructor Summary

Constructors
Constructor and Description
`FBlock_JgenMdl(FBlock_FBcl.Blocktype type, Module_FBlock_JgenMdl inModule)` Constructs the block from Simulink blocks.
`FBlock_JgenMdl(FBlock_FBcl.Blocktype etype, java.lang.String name, java.lang.String sImport, java.lang.String sOperation, java.lang.String sInOutDesign)` Creates a template block from a given String designation
`FBlock_JgenMdl(FBlock_JgenMdl tplFb, FBlock_FBcl.Blocktype type, Module_FBlock_JgenMdl inModule)` Constructs the block from Simulink blocks.
`FBlock_JgenMdl(FBlock_JgenMdl src, Module_FBlock_JgenMdl inModule)` Creates a FBlock from a given template block.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`calcSliced()`
`(package private) void`	`cleanupAfterJavaCode()`
`(package private) void`	`cleanupAfterTypePropagation()`
`protected void`	`copyBlockPropertiesFrom(FBlock_JgenMdl src, Module_FBlock_JgenMdl inModule)`
`FBlock_JgenMdl`	`createBlockInstance(Module_FBlock_JgenMdl inModule)` Creates a FBlock_Mdl from this template or type Block.
`void`	`determine_zVectorStm()` Sets the `StatementData_JgenMdl.ixOutconRet` with the first `#conout` which is a scalar.
`java.lang.Iterable<EvOperation_FBcl>`	`evOperations()` Returns an iterator over more as one Event operation or null if the Inpin is used for only one operation.
`void`	`fillMaskParam(java.util.List<SlxData.MaskParam_Slx> srcMask)` Transfer mask parameter from input data.
`void`	`findOutconRet()` Sets the `StatementData_JgenMdl.ixOutconRet` with the first `#conout` which is a scalar.
`(package private) FBlock_JgenMdl.MaskParam_Mdl`	`getMaskParam(java.lang.String name)`
`ConnOut_FBcl`	`getOut(int ixPort)`
`java.lang.String`	`globalName()` Returns the global name in the top model starting with "%."
`void`	`globalName(java.lang.StringBuilder sb)` Returns the global name in the top model starting with "%."
`boolean`	`isTypesAllEqual()` Return true for block types which has the same type on all incon and outcon.
`(package private) java.lang.String`	`nameCon()` Returns the name of the first relevant connection.
`EvOperation_FBcl`	`oneEvOper()` Returns the only one Event operation or null if the Inpin is used for more as one operations.
`ConnOut_FBcl`	`outconFirst()` Return the first outConnection of this.
`void`	`prepare()` Prepare the block after fill the input.
`(package private) void`	`registerSrcExcl(FBlock_JgenMdl src)`
`(package private) void`	`registerSrcMultiple(FBlock_JgenMdl src)`
`java.lang.String`	`sClassName()`
`void`	`setName(java.lang.String name)`
`private DataType_FBcl`	`setPortType(DataType_FBcl dtypePrev, int zVectorDimPrev, Connection_FBcl con, StringPartScan sp, boolean bIncon, java.util.Map<java.lang.String,DataType_FBcl> mapdtypes)`
`java.lang.String`	`sImport()`
`FBlock_FBcl`	`templateFb()`
`void`	`templateFb(FBlock_FBcl src)`
`void`	`terminateOpenIncons()`
`java.lang.String`	`toString()`
`(package private) void`	`writeDbginfo(StringFormatter sf)`

Methods inherited from class org.vishia.fbcl.fblock.FBlock_FBcl
din, dinForeach, dout, doutForeach, dtypes, evin, evin, evout, evout, getNrofConnin, getNrofConnout, getNrofDin, getNrofDout, getNrofEvin, getNrofEvout, getOut1Properties, getPinEvInByName, getPinEvOutByName, getPinInByName, getPinOutByName, getSteptime, getSteptimeStr, getTypeFB, kind, name, typeName, XXXgetConnin, XXXgetConnout

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

- Field Detail
  - clusterInfo
```
public final FBlock_JgenMdl.ClusterInfo clusterInfo
```
  - srcFbExcl
```
public FBlock_JgenMdl srcFbExcl
```
    Sources which refers this in dstExcl. @since 2019-04-30
  - srcFbMultiple
```
public java.util.List<FBlock_JgenMdl> srcFbMultiple
```
    Sources which refers this in dstMultiple. @since 2019-04-30
  - dstFbExcl
```
public FBlock_JgenMdl dstFbExcl
```
    The only one destination FBlock. null if the block has more as one destination @since 2019-04-30
  - dstFbMultiple
```
public java.util.List<FBlock_JgenMdl> dstFbMultiple
```
    All destination FBlock if more as one. @since 2019-04-30
  - eventOut
```
public EvOutput_FBcl eventOut
```
    The associated event for calculation order.
  - evOperation
```
private EvOperation_FBcl evOperation
```
  - evOperations
```
private java.util.List<EvOperation_FBcl> evOperations
```
  - sOperators3Arg
```
public static java.lang.String[] sOperators3Arg
```
  - dbgOrder
```
int dbgOrder
```
    It is only for debug. The index in GenJava_Class_JgenMdl#blocksInOrder.
  - dbgStringType
```
java.lang.String dbgStringType
```
  - slxBlock
```
public SlxData.Block_SlxData slxBlock
```
    Reference to the simulink block. TODO remove it. The prepared model should not have references to a special source of preparation, to support different tools (not only simulink).
  - _moduleBlock
```
Module_FBlock_JgenMdl _moduleBlock
```
    The superior block only used for Callmodule_FBlock_JgenMdl or Module_FBlock_JgenMdl.
  - opClusterBlock
```
Operation_FBlock_JgenMdl opClusterBlock
```
    The Block is member of a cluster inside the module. A cluster is blocks with immediately relation in the same step time.
  - conSliced
```
int conSliced
```
    The number of slicing instances due to connections. This number will not be adjusted which code generation, in oposite to StatementData_JgenMdl.zVectorStm. It is the static situation of the module. 0 means: no slicing. >0: The number of slices is defined at model level in the module. -1 means: The number of slices depends on the inputs. The number of slices is set via calcSliced()
  - stm
```
public StatementData_JgenMdl stm
```
    If not null then this block is a end block in a generated statement. The aggregation contains the data for the statement.
  - sFunction
```
public java.lang.String sFunction
```
    The operation routine, function which is executed with this block.
  - sInstanceName
```
java.lang.String sInstanceName
```
    If not null, then usage of this FBlock forces an composite instance in the module. The instance operation is called instead a static one. TODO initialize how?
  - sClassName
```
java.lang.String sClassName
```
    Name of the class where this operation is part of.
  - sImport
```
java.lang.String sImport
```
    package of the class where this FBlock's class is member of. If not null forces import.
  - dataTypesPropagated
```
DataTypePropagation_JgenMdl.State dataTypesPropagated
```
    0 not propagated. 3 full propagated. True if the type propagation for this block was done already. In the preparation phase all types are propagated from input to output. The propagation walks through the whole model. This flag causes stop propagation for a walking path if the paths are walked back surround.
  - bAddForTypePropagation
```
boolean bAddForTypePropagation
```
  - bAddInCluster
```
boolean bAddInCluster
```
  - maskParam
```
java.util.Map<java.lang.String,FBlock_JgenMdl.MaskParam_Mdl> maskParam
```
    True if code was generated.
  - _templateFb
```
private FBlock_FBcl _templateFb
```
    The block which this block is copied from. The template block contains information about types on its #conin and #conout without wiring.
- Constructor Detail
  - FBlock_JgenMdl
```
FBlock_JgenMdl(FBlock_FBcl.Blocktype type,
               Module_FBlock_JgenMdl inModule)
```
    Constructs the block from Simulink blocks. TODO all simulink activities in an own class. Not in SlxData in a new class. The constructor should be independent from simulink things. To support other graphical programming tools too.
    
    Parameters:
    
    slxBlock -
  - FBlock_JgenMdl
```
public FBlock_JgenMdl(FBlock_JgenMdl tplFb,
                      FBlock_FBcl.Blocktype type,
                      Module_FBlock_JgenMdl inModule)
```
    Constructs the block from Simulink blocks. TODO all simulink activities in an own class. Not in SlxData in a new class. The constructor should be independent from simulink things. To support other graphical programming tools too.
    
    Parameters:
    
    slxBlock -
  - FBlock_JgenMdl
```
public FBlock_JgenMdl(FBlock_JgenMdl src,
                      Module_FBlock_JgenMdl inModule)
```
    Creates a FBlock from a given template block. This may be an Operation_FBlock_JgenMdl from a library module or a block inside the PredefFBlocks_old_JgenMdl, especially all standard FBlock.
    
    Parameters:
    
    src - the template
    
    inModule - the superior module where the block is used.
  - FBlock_JgenMdl
```
public FBlock_JgenMdl(FBlock_FBcl.Blocktype etype,
                      java.lang.String name,
                      java.lang.String sImport,
                      java.lang.String sOperation,
                      java.lang.String sInOutDesign)
```
    Creates a template block from a given String designation
    Parameters:
    
    name -
    
    sImport -
    
    sOperation -
    sInOutDesign - description of input and output types:
    
    Any argument is represented with a letter.
    The letter is the character type DFJISBZ for double, float, long, int, short, byte, boolean
    The letter dfjis is the adequate complex type.
    X: unspecified, but any non-complex type. On output: Follow the first input with X
    x: unspecified, but complex
    Y: connection without specified type (TODO yet * ?
    A number before the character type: size of vector.
    A 0before the character type: unspecified vector or scalar.
    A $before the character: a scalar, but a vector operation possible.
    Input and output separated with ,
    no spaces.
    Example "$XI,$X": inConnections[0] may be a vector, inConnections[1] is a Integer scalar. outConnections[0] maybe a vector, following inConnection[0]
- Method Detail
  - sClassName
```
public java.lang.String sClassName()
```
  - sImport
```
public java.lang.String sImport()
```
  - setPortType
```
private DataType_FBcl setPortType(DataType_FBcl dtypePrev,
                                  int zVectorDimPrev,
                                  Connection_FBcl con,
                                  StringPartScan sp,
                                  boolean bIncon,
                                  java.util.Map<java.lang.String,DataType_FBcl> mapdtypes)
                           throws java.text.ParseException
```
    Throws:
    
    java.text.ParseException
  - registerSrcExcl
```
void registerSrcExcl(FBlock_JgenMdl src)
```
  - registerSrcMultiple
```
void registerSrcMultiple(FBlock_JgenMdl src)
```
  - oneEvOper
```
public EvOperation_FBcl oneEvOper()
```
    Returns the only one Event operation or null if the Inpin is used for more as one operations.
    
    Returns:
    
    null if the inpin is used for more as one operation.
  - evOperations
```
public java.lang.Iterable<EvOperation_FBcl> evOperations()
```
    Returns an iterator over more as one Event operation or null if the Inpin is used for only one operation.
    
    Returns:
    
    null if the inpin is used for only one operation.
  - copyBlockPropertiesFrom
```
protected void copyBlockPropertiesFrom(FBlock_JgenMdl src,
                                       Module_FBlock_JgenMdl inModule)
```
  - createBlockInstance
```
public FBlock_JgenMdl createBlockInstance(Module_FBlock_JgenMdl inModule)
```
    Creates a FBlock_Mdl from this template or type Block. This should be member of the TemplateModule.
    
    Parameters:
    
    inModule - The module for aggregation _moduleBlock of the new Block.
    
    Returns:
  - setName
```
public void setName(java.lang.String name)
```
  - globalName
```
public java.lang.String globalName()
```
    Returns the global name in the top model starting with "%."
  - globalName
```
public void globalName(java.lang.StringBuilder sb)
```
    Returns the global name in the top model starting with "%."
  - findOutconRet
```
public void findOutconRet()
```
    Sets the StatementData_JgenMdl.ixOutconRet with the first #conout which is a scalar. This routine is called only in GenJava_Class_JgenMdl.findOutconRet() before the translation starts. therefore stm is expected to null (assertion). It is created here. Note: The first scalar outputs depends on the deterministic ConnOut_FBcl#dataType which is different for different using types of the module.
  - calcSliced
```
public int calcSliced()
```
  - determine_zVectorStm
```
public void determine_zVectorStm()
```
    Sets the StatementData_JgenMdl.ixOutconRet with the first #conout which is a scalar. This routine is called only in GenJava_Class_JgenMdl.findOutconRet() before the translation starts. therefore stm is expected to null (assertion). It is created here. Note: The first scalar outputs depends on the deterministic ConnOut_FBcl#dataType which is different for different using types of the module.
  - getOut
```
public ConnOut_FBcl getOut(int ixPort)
```
  - outconFirst
```
public ConnOut_FBcl outconFirst()
```
    Return the first outConnection of this. If the FBlock has no OutConnections it returns the connected OutConnection to inConnections[0]. It returns null if no OutConnection was found.
    
    Returns:
    
    maybe null, the first relevant OutConnection.
  - nameCon
```
java.lang.String nameCon()
```
    Returns the name of the first relevant connection.
    
    Returns:
  - templateFb
```
public FBlock_FBcl templateFb()
```
  - templateFb
```
public void templateFb(FBlock_FBcl src)
```
  - prepare
```
public void prepare()
```
    Prepare the block after fill the input.
  - terminateOpenIncons
```
public void terminateOpenIncons()
```
  - fillMaskParam
```
public void fillMaskParam(java.util.List<SlxData.MaskParam_Slx> srcMask)
```
    Transfer mask parameter from input data.
    
    Parameters:
    
    srcMask -
  - getMaskParam
```
FBlock_JgenMdl.MaskParam_Mdl getMaskParam(java.lang.String name)
```
  - isTypesAllEqual
```
public boolean isTypesAllEqual()
```
    Return true for block types which has the same type on all incon and outcon. It means that the types are well defined if at least one input is defined. Note: Simulink allows only the same type without cast up on numeric operations. That is used. If Simulink can work with cast up, 2 passes are necessary for such.
    
    Returns:
  - cleanupAfterTypePropagation
```
void cleanupAfterTypePropagation()
```
  - cleanupAfterJavaCode
```
void cleanupAfterJavaCode()
```
  - writeDbginfo
```
void writeDbginfo(StringFormatter sf)
           throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class FBlock_FBcl

Class FBlock_JgenMdl

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

clusterInfo

srcFbExcl

srcFbMultiple

dstFbExcl

dstFbMultiple

eventOut

evOperation

evOperations

sOperators3Arg

dbgOrder

dbgStringType

slxBlock

_moduleBlock

opClusterBlock

conSliced

stm

sFunction

sInstanceName

sClassName

sImport

dataTypesPropagated

bAddForTypePropagation

bAddInCluster

maskParam

_templateFb

Constructor Detail

FBlock_JgenMdl

FBlock_JgenMdl

FBlock_JgenMdl

FBlock_JgenMdl

Method Detail

sClassName

sImport

setPortType

registerSrcExcl

registerSrcMultiple

oneEvOper

evOperations

copyBlockPropertiesFrom

createBlockInstance

setName

globalName

globalName

findOutconRet

calcSliced

determine_zVectorStm

getOut

outconFirst

nameCon

templateFb

templateFb

prepare

terminateOpenIncons

fillMaskParam

getMaskParam

isTypesAllEqual

cleanupAfterTypePropagation

cleanupAfterJavaCode

writeDbginfo

toString