Write_Module

java.lang.Object
- org.vishia.fbcl.fblock.Module_FBcl.Create
- - org.vishia.fbcl.fblockwr.Write_Module_FBwr

public class Write_Module_FBwr
extends Module_FBcl.Create

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`bCombinatoricDout` TODO a port may be combinatoric.
`private java.util.List<Dout_FBcl>`	`dinPortList`
`private java.util.List<Portdout_FBcl.Wr>`	`doutPortList`
`private java.util.List<Evchain_FBcl.Wr>`	`evChains`
`private java.util.List<Evout_FBcl>`	`evinPortList`
`private java.util.List<Evin_FBcl>`	`evoutPortList`
`private java.util.Map<java.lang.String,Write_FBlock_FBwr>`	`fblockIdx` It is only for internal processing.
`private java.util.List<Write_FBlock_FBwr>`	`fblockList` It is only for internal processing.
`(package private) java.util.Map<java.lang.String,SteptimeRef_FBcl>`	`idxSteptimes`
`(package private) int`	`ixEvInput`
`Write_FBlockType_FBwr`	`mdlifcCreate`

Fields inherited from class org.vishia.fbcl.fblock.Module_FBcl.Create
mdl

Constructor Summary

Constructors
Constructor and Description
`Write_Module_FBwr(FBlock_Type_FBcl createParts)` Creates a Module for Parts of the given Interface.
`Write_Module_FBwr(Module_FBcl mdl)` Constructs a writer to a given module.
`Write_Module_FBwr(java.lang.String name)` Constructs a writer and constructs the module to write too inclusively its `Module_FBcl.ifcFB`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Dout_FBcl`	`addDinPort(int ixPin, java.lang.String namePin, DataTypeRef_FBcl dtype)` Adds a bound out to the preliminary list.
`Portdout_FBcl.Wr`	`addDoutPort(int ixPin, java.lang.String namePin, DataTypeRef_FBcl dtype)` Adds a bound out to the preliminary list.
`void`	`addEvchain(Evchain_FBcl.Wr evChain)`
`Evout_FBcl`	`addEvinPort(java.lang.String namePin)` Adds a bound out to the preliminary list.
`Evin_FBcl`	`addEvoutPort(java.lang.String namePin)` Adds a bound out to the preliminary list.
`void`	`addFBlock(Write_FBlock_FBwr fbc, int nrNetwork)` Adds the new FBlock.
`void`	`completeIfc(TranslationScripts trlScripts)` Completes the `FBlock_Type_FBcl` of the `Module_FBcl.ifcFB` because of all ports are set with the correct Data types.
`java.util.List<Evchain_FBcl.Wr>`	`evChains()`
`Evout_FBcl`	`evinPort(int ix)`
`void`	`gatherAllFBdtypes()`
`private java.util.HashMap<DataTypeRef_FBcl,DataTypeRef_FBcl>`	`gatherPortDataTypes()` All datatypes inside the module are connected together, it means all non deterministic datatypes are present on the pins.
`private void`	`gatherPortDataTypes(Pin_FBcl[] conns, java.util.Map<DataTypeRef_FBcl,DataTypeRef_FBcl> dtm)`
`Evout_FBcl`	`getaddEvinPort(java.lang.String namePin)` Gets the named port event input, if not found adds it to the preliminary list with `addEvinPort(String)`.
`Pin_FBcl`	`getaddEvoutPort(java.lang.String namePin)` Gets the named port event input, if not found adds it to the preliminary list with `addEvinPort(String)`.
`SteptimeRef_FBcl`	`getCreateSteptime(java.lang.String steptime)`
`Dout_FBcl`	`getDinPortByName(java.lang.String name)`
`Portdout_FBcl.Wr`	`getDoutPortByName(java.lang.String name)`
`Write_FBlock_FBwr`	`getFBlock(java.lang.String name)`
`java.lang.Iterable<Dout_FBcl>`	`iterDinPort()`
`java.lang.Iterable<Portdout_FBcl.Wr>`	`iterDoutPort()`
`java.lang.Iterable<Write_FBlock_FBwr>`	`iterFBlocks()`
`void`	`postPrepareDtypesToIfc()`
`void`	`postPrepareFBlocks()`
`void`	`setAllPortsToIfc()`
`private void`	`setEqualsSteptimeInFBlocks()`

Methods inherited from class org.vishia.fbcl.fblock.Module_FBcl.Create
addAlgorithm, addDoutCombin, addDoutVar, addEvchain, addFBlock_, addOperation, addState, containsDoutCombin, createDinPortsToInnerModule, createdoutPortsFromInnerModule, createEvinPortsToInnerModule, createEvoutPortsFromInnerModule, getdinPortArray, getdoutPortArray, getevinPortArray, getevoutPortArray, nextIxOperInMdl, setAlgorithmSimpleFB, setDtypes, toString

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

- Field Detail
  - mdlifcCreate
```
public final Write_FBlockType_FBwr mdlifcCreate
```
  - evinPortList
```
private java.util.List<Evout_FBcl> evinPortList
```
  - evoutPortList
```
private java.util.List<Evin_FBcl> evoutPortList
```
  - dinPortList
```
private java.util.List<Dout_FBcl> dinPortList
```
  - doutPortList
```
private java.util.List<Portdout_FBcl.Wr> doutPortList
```
  - evChains
```
private java.util.List<Evchain_FBcl.Wr> evChains
```
  - fblockList
```
private java.util.List<Write_FBlock_FBwr> fblockList
```
    It is only for internal processing.
  - fblockIdx
```
private java.util.Map<java.lang.String,Write_FBlock_FBwr> fblockIdx
```
    It is only for internal processing.
  - ixEvInput
```
int ixEvInput
```
  - bCombinatoricDout
```
public boolean bCombinatoricDout
```
    TODO a port may be combinatoric.
  - idxSteptimes
```
java.util.Map<java.lang.String,SteptimeRef_FBcl> idxSteptimes
```
- Constructor Detail
  - Write_Module_FBwr
```
public Write_Module_FBwr(java.lang.String name)
```
    Constructs a writer and constructs the module to write too inclusively its Module_FBcl.ifcFB
    
    Parameters:
    
    name - The name of the module
  - Write_Module_FBwr
```
public Write_Module_FBwr(Module_FBcl mdl)
```
    Constructs a writer to a given module.
    
    Parameters:
    
    mdl -
  - Write_Module_FBwr
```
public Write_Module_FBwr(FBlock_Type_FBcl createParts)
```
    Creates a Module for Parts of the given Interface. Do not change the interface. Hence the mdlifcCreate aggregation is set to null.
    
    Parameters:
    
    createParts -
- Method Detail
  - iterFBlocks
```
public java.lang.Iterable<Write_FBlock_FBwr> iterFBlocks()
```
  - addFBlock
```
public void addFBlock(Write_FBlock_FBwr fbc,
                      int nrNetwork)
```
    Adds the new FBlock.
    
    Parameters:
    
    fbwr -
    
    nrNetwork - from 1, max 254
  - getFBlock
```
public Write_FBlock_FBwr getFBlock(java.lang.String name)
```
  - addEvinPort
```
public Evout_FBcl addEvinPort(java.lang.String namePin)
```
    Adds a bound out to the preliminary list. Later call setAllPortsToIfc() to establish all port pins from the module and create all pins on the ifc-FB
    
    Parameters:
    
    namePin -
    
    Since:
    
    2019-08-28
  - getaddEvinPort
```
public Evout_FBcl getaddEvinPort(java.lang.String namePin)
```
    Gets the named port event input, if not found adds it to the preliminary list with addEvinPort(String). Later call setAllPortsToIfc() to establish all port pins from the module and create all pins on the ifc-FB
    
    Parameters:
    
    namePin -
    
    Since:
    
    2019-08-28
  - evinPort
```
public Evout_FBcl evinPort(int ix)
```
  - addEvoutPort
```
public Evin_FBcl addEvoutPort(java.lang.String namePin)
```
    Adds a bound out to the preliminary list. Later call setAllPortsToIfc() to establish all port pins from the module and create all pins on the ifc-FB
    
    Parameters:
    
    namePin -
    
    Since:
    
    2019-08-28
  - getaddEvoutPort
```
public Pin_FBcl getaddEvoutPort(java.lang.String namePin)
```
    Gets the named port event input, if not found adds it to the preliminary list with addEvinPort(String). Later call setAllPortsToIfc() to establish all port pins from the module and create all pins on the ifc-FB
    
    Parameters:
    
    namePin -
    
    Since:
    
    2019-08-28
  - addDinPort
```
public Dout_FBcl addDinPort(int ixPin,
                            java.lang.String namePin,
                            DataTypeRef_FBcl dtype)
```
    Adds a bound out to the preliminary list. Later call setAllPortsToIfc() to establish all port pins from the module and create all pins on the ifc-FB
    
    Parameters:
    
    namePin -
    
    Since:
    
    2019-08-28
  - addDoutPort
```
public Portdout_FBcl.Wr addDoutPort(int ixPin,
                                    java.lang.String namePin,
                                    DataTypeRef_FBcl dtype)
```
    Adds a bound out to the preliminary list. Later call setAllPortsToIfc() to establish all port pins from the module and create all pins on the ifc-FB
    
    Parameters:
    
    namePin -
    
    Since:
    
    2019-08-28
  - iterDinPort
```
public java.lang.Iterable<Dout_FBcl> iterDinPort()
```
  - iterDoutPort
```
public java.lang.Iterable<Portdout_FBcl.Wr> iterDoutPort()
```
  - getDoutPortByName
```
public Portdout_FBcl.Wr getDoutPortByName(java.lang.String name)
```
  - getDinPortByName
```
public Dout_FBcl getDinPortByName(java.lang.String name)
```
  - addEvchain
```
public void addEvchain(Evchain_FBcl.Wr evChain)
```
  - evChains
```
public java.util.List<Evchain_FBcl.Wr> evChains()
```
  - setAllPortsToIfc
```
public void setAllPortsToIfc()
```
  - getCreateSteptime
```
public SteptimeRef_FBcl getCreateSteptime(java.lang.String steptime)
```
  - gatherPortDataTypes
```
private java.util.HashMap<DataTypeRef_FBcl,DataTypeRef_FBcl> gatherPortDataTypes()
```
    All datatypes inside the module are connected together, it means all non deterministic datatypes are present on the pins.
  - gatherPortDataTypes
```
private void gatherPortDataTypes(Pin_FBcl[] conns,
                                 java.util.Map<DataTypeRef_FBcl,DataTypeRef_FBcl> dtm)
```
  - gatherAllFBdtypes
```
public void gatherAllFBdtypes()
```
  - completeIfc
```
public void completeIfc(TranslationScripts trlScripts)
```
    Completes the FBlock_Type_FBcl of the Module_FBcl.ifcFB because of all ports are set with the correct Data types. It is important that the data type dependencies are correct.
  - postPrepareFBlocks
```
public void postPrepareFBlocks()
```
  - setEqualsSteptimeInFBlocks
```
private void setEqualsSteptimeInFBlocks()
```
  - postPrepareDtypesToIfc
```
public void postPrepareDtypesToIfc()
```

Class Write_Module_FBwr

Field Summary

Fields inherited from class org.vishia.fbcl.fblock.Module_FBcl.Create

Constructor Summary

Method Summary

Methods inherited from class org.vishia.fbcl.fblock.Module_FBcl.Create

Methods inherited from class java.lang.Object

Field Detail

mdlifcCreate

evinPortList

evoutPortList

dinPortList

doutPortList

evChains

fblockList

fblockIdx

ixEvInput

bCombinatoricDout

idxSteptimes

Constructor Detail

Write_Module_FBwr

Write_Module_FBwr

Write_Module_FBwr

Method Detail

iterFBlocks

addFBlock

getFBlock

addEvinPort

getaddEvinPort

evinPort

addEvoutPort

getaddEvoutPort

addDinPort

addDoutPort

iterDinPort

iterDoutPort

getDoutPortByName

getDinPortByName

addEvchain

evChains

setAllPortsToIfc

getCreateSteptime

gatherPortDataTypes

gatherPortDataTypes

gatherAllFBdtypes

completeIfc

postPrepareFBlocks

setEqualsSteptimeInFBlocks

postPrepareDtypesToIfc