org.vishia.fbcl.fblockwr

Class Write_Module_FBwr

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
private java.util.List<Evchain_FBcl.Wr>	evChains
Write_FBtype_FBwr	fbtwMdl Write access to the type of the FBlock_FBcl associated to the inner module pins
Write_FBlock_FBwr	fbwMdl Write access of the FBlock presenting the module for inner connection processing.
(package private) java.util.HashMap<DType_FBcl,DType_FBcl>	idxDtypeMdl Index between DType_FBcl on the PinType_FBcl of the module (key for map) and the DType_FBcl on the Pin_FBcl of the module (value for the map).
private java.util.Map<java.lang.String,Write_FBlock_FBwr>	idxFBlock FBlock_FBcl used inside this module.
private java.util.Map<java.lang.String,Write_FBlock_FBwr>	idxFBlockTEST FBlock_FBcl used inside this module for test stuff.
private java.util.Map<java.lang.String,Write_FBtype_FBwr>	idxFBtype Index of FBtype_FBcl which are defined in its properties inside this module.
java.util.Map<java.lang.String,Pin_FBcl>	idxPinByName
private java.util.Map<java.lang.String,EccState_FBcl.Create>	idxState
(package private) java.util.Map<java.lang.String,SteptimeRef_FBcl>	idxSteptimes
(package private) int	ixEvInput
private java.util.List<Write_FBlock_FBwr>	listFblock FBlock_FBcl used inside this module.
private java.util.List<Write_FBlock_FBwr>	listFBoper FBlock_FBcl FBexpr with THIZ and an operation, it are FBoper.
private java.util.List<Write_FBtype_FBwr>	listFBtype List of FBtype_FBcl which are defined in its properties inside this module.
java.util.List<DinExprK_FBcl>	listKpinToReplaceVariable Intermediate index of all K1999-Pins of expressions which contains access to variables which needs to be fulfilled.
FBtype_FBcl.WriteFBT	mdlifcWr Write access to the type of the interface of module pins
Prj_FBCLrd	prj
private static java.lang.String	sIndent
(package private) long	timeCmpFBcl
(package private) long	timeCompleteModule
(package private) long	timeDataPropg
(package private) long	timeEndModule
(package private) long	timeEventPropg
(package private) long	timePrep
(package private) long	timeStartModule
(package private) long	timeWrCmpCode
(package private) long	timeWrFBcl
boolean	xxxbCombinatoricDout TODO a port may be combinatoric.
private java.util.List<FBexpr_FBcl>	XXXlistExprEv The order in this list is the bit position in Evinout_FBcl.condBits.

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

mdl

Constructor Summary

Constructors

Constructor and Description
Write_Module_FBwr(java.lang.String name, Prj_FBCLrd prj) Constructs a writer and constructs the module to write too inclusively its Module_FBcl.ifcFB

Method Summary

Modifier and Type	Method and Description
void	addEvchain(Evchain_FBcl.Wr evChain)
void	addFBlock(Write_FBlock_FBwr fbc, int nrNetwork) Adds the new FBlock.
void	addFBlockTEST(Write_FBlock_FBwr fbc) Adds the new FBlock.
void	addFBoper(Write_FBlock_FBwr fbc) Adds a FBoper to complete.
private void	buildEvtree(org.vishia.msgDispatch.LogMessage logDbg)
void	completeAllFBlockTypePinsInModule() Completes all FBtype_FBcl inside the idxFBtype with its pins and store it in Mdl This is a central approach that is necessary when in a LibreOffice diagram some types are completely given externally (fbd).
void	completeAllMdlPins(TranslationScripts trlScripts) Completes the inner FBtype_FBcl of all of the Module_FBcl.ifcFB because of all ports are set with the correct Data types.
void	completeMdl() Complete the new read module: completeMissingEventPinsInTypes() postPrepareFBlocks() #postPrepareDtypesToIfc() completeAllFBlockTypePinsInModule() #propgDtypes(LogMessage) Dataflow2Eventchain_FBrd#prc(Write_Module_FBwr) completeAllMdlPins(TranslationScripts) createAllFBblockPins() createAllMdlIfcPins(LogMessage) setExprOperatorToPins()
void	completeMissingEventPinsInTypes()
void	createAllFBblockPins()
void	createAllInheritanceFromTypeInModule() Completes the FBtype_FBcl inside the Module_FBcl.ifcFB This is adequate TODO
void	createAllMdlIfcPins(org.vishia.msgDispatch.LogMessage log) Completes the module interface.
java.util.List<Evchain_FBcl.Wr>	evChains()
Write_FBlock_FBwr	getCreateFBjoin(java.lang.String name) Gets the FBlock_FBcl writer by name or creates it.
Write_FBlock_FBwr	getCreateFBlock(java.lang.String name, FBtype_FBcl fbType, Write_FBtype_FBwr fbtw, XY_FBcl graphicPos) Gets the FBlock_FBcl writer by name or creates it.
Write_FBlock_FBwr	getCreateFBlockTEST(java.lang.String name, FBtype_FBcl fbType, Write_FBtype_FBwr fbtw, XY_FBcl graphicPos) Gets the FBlock_FBcl writer by name or creates it.
Write_FBtype_FBwr	getCreateFBtype(FBtype_FBcl fbt)
Write_FBtype_FBwr	getCreateFBtype(java.lang.String name, FBlock_FBcl.Blocktype fbtype) Gets an existing FBtype_FBcl to complete it with more features given in a GraphicBlock of LibreOffice-odg or another appropriate tool or creates just first time this FBlock.
EccState_FBcl.Create	getCreateState(java.lang.String name)
SteptimeRef_FBcl	getCreateSteptime(java.lang.String steptime)
DType_FBcl	getDTypePinMdl(DinoutType_FBcl pinMdl) Gets the instance DType_FBcl due to the type DType_FBcl for a modules pin.
Write_FBlock_FBwr	getFBw(java.lang.String name) Returns a stored FBlock, also a TEST FBlock by given name.
Pin_FBcl	getPin(PinType_FBcl pintw) Gets a pin with known pin type.
Pin_FBcl	getPin(java.lang.String namePin) Gets a pin with known pin type.
java.lang.Iterable<Write_FBlock_FBwr>	iterFBlocks() Returns an iterator sorted by the name of the FBlocks.
java.lang.Iterable<EccState_FBcl.Create>	iterStates() Returns an Iterable over all states, which's Iterable.iterator() can be used especially in for loops.
void	postPrepareFBlocks()
private void	setEqualsSteptimeInFBlocks() Check whether the FBlock instance has any step time assignments.
void	setExprOperatorToPins()
void	XXXcreateAllFBlockPinsFromTypeInModule() Creates the pins of all FBlock_FBcl instances given in idxFBlock in the module due to its FBtype_FBcl.

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

addAlgorithm, addAllExprEv, addEvchain, addEvtreeRootnode, addFBlock_, addFBlockTEST_, addFBlockType, addIfcFile, addOperation, addVariable, completeStates, nextIxOperInMdl, setAlgorithmSimpleFB, setDtypes, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

prj

public final Prj_FBCLrd prj

timeStartModule

long timeStartModule

timePrep

long timePrep

timeDataPropg

long timeDataPropg

timeEventPropg

long timeEventPropg

timeCompleteModule

long timeCompleteModule

timeWrFBcl

long timeWrFBcl

timeCmpFBcl

long timeCmpFBcl

timeWrCmpCode

long timeWrCmpCode

timeEndModule

long timeEndModule

mdlifcWr

public final FBtype_FBcl.WriteFBT mdlifcWr

Write access to the type of the interface of module pins

fbwMdl

public final Write_FBlock_FBwr fbwMdl

Write access of the FBlock presenting the module for inner connection processing.

fbtwMdl

public final Write_FBtype_FBwr fbtwMdl

Write access to the type of the FBlock_FBcl associated to the inner module pins

listKpinToReplaceVariable

public final java.util.List<DinExprK_FBcl> listKpinToReplaceVariable

Intermediate index of all K1999-Pins of expressions which contains access to variables which needs to be fulfilled.

idxPinByName

public final java.util.Map<java.lang.String,Pin_FBcl> idxPinByName

idxDtypeMdl

java.util.HashMap<DType_FBcl,DType_FBcl> idxDtypeMdl

Index between DType_FBcl on the PinType_FBcl of the module (key for map) and the DType_FBcl on the Pin_FBcl of the module (value for the map). It is filled on new created pins with non full deterministic pins.

evChains

private java.util.List<Evchain_FBcl.Wr> evChains

XXXlistExprEv

private java.util.List<FBexpr_FBcl> XXXlistExprEv

The order in this list is the bit position in Evinout_FBcl.condBits. The list is transferred to the Module_FBcl.exprEv, it can be used in code generation to select the name of the FBexpr by given bits.

listFblock

private java.util.List<Write_FBlock_FBwr> listFblock

FBlock_FBcl used inside this module.

listFBoper

private java.util.List<Write_FBlock_FBwr> listFBoper

FBlock_FBcl FBexpr with THIZ and an operation, it are FBoper.

idxFBlock

private java.util.Map<java.lang.String,Write_FBlock_FBwr> idxFBlock

FBlock_FBcl used inside this module.

idxFBlockTEST

private java.util.Map<java.lang.String,Write_FBlock_FBwr> idxFBlockTEST

FBlock_FBcl used inside this module for test stuff.

listFBtype

private java.util.List<Write_FBtype_FBwr> listFBtype

List of FBtype_FBcl which are defined in its properties inside this module.

idxFBtype

private java.util.Map<java.lang.String,Write_FBtype_FBwr> idxFBtype

Index of FBtype_FBcl which are defined in its properties inside this module.

idxState

private java.util.Map<java.lang.String,EccState_FBcl.Create> idxState

ixEvInput

int ixEvInput

xxxbCombinatoricDout

public boolean xxxbCombinatoricDout

TODO a port may be combinatoric.

idxSteptimes

java.util.Map<java.lang.String,SteptimeRef_FBcl> idxSteptimes

sIndent

private static final java.lang.String sIndent

See Also:

Constant Field Values

Constructor Detail

Write_Module_FBwr

public Write_Module_FBwr(java.lang.String name,
                         Prj_FBCLrd prj)

Constructs a writer and constructs the module to write too inclusively its Module_FBcl.ifcFB

Parameters:

name - The name of the module

Method Detail

iterFBlocks

public java.lang.Iterable<Write_FBlock_FBwr> iterFBlocks()

Returns an iterator sorted by the name of the FBlocks. Gets from idxFBlock.

Returns:

addFBlock

public void addFBlock(Write_FBlock_FBwr fbc,
                      int nrNetwork)

Adds the new FBlock.

Parameters:

fbwr -

nrNetwork - from 1, max 254

addFBlockTEST

public void addFBlockTEST(Write_FBlock_FBwr fbc)

Adds the new FBlock.

Parameters:

fbwr -

nrNetwork - from 1, max 254

addFBoper

public void addFBoper(Write_FBlock_FBwr fbc)

Adds a FBoper to complete.

Parameters:

fbwr -

getCreateFBlock

public Write_FBlock_FBwr getCreateFBlock(java.lang.String name,
                                         FBtype_FBcl fbType,
                                         Write_FBtype_FBwr fbtw,
                                         XY_FBcl graphicPos)

Gets the FBlock_FBcl writer by name or creates it. This is called whenever a new FBlock_FBcl instance is necessary in a module to complete.

Parameters:

name - of the FBlock instance

fbkind - stored in FBlock_FBcl#_kindFBlock

fbType - the type identically with fbtw.fbt if fbtw is given. Else the necessary FBtype_FBcl

fbtw - null if fbType is from a given (standard or library) FBlock. Given if the FBlock's FBtype_FBcl is given in this module.

Returns:

given or created instance of this FBlock_FBcl writer.

getCreateFBjoin

public Write_FBlock_FBwr getCreateFBjoin(java.lang.String name)

Gets the FBlock_FBcl writer by name or creates it. This is called whenever a new FBlock_FBcl instance is necessary in a module to complete.

Parameters:

name - of the FBlock instance

fbkind - stored in FBlock_FBcl#_kindFBlock

fbType - the type identically with fbtw.fbt if fbtw is given. Else the necessary FBtype_FBcl

fbtw - null if fbType is from a given (standard or library) FBlock. Given if the FBlock's FBtype_FBcl is given in this module.

Returns:

given or created instance of this FBlock_FBcl writer.

getCreateFBlockTEST

public Write_FBlock_FBwr getCreateFBlockTEST(java.lang.String name,
                                             FBtype_FBcl fbType,
                                             Write_FBtype_FBwr fbtw,
                                             XY_FBcl graphicPos)

Gets the FBlock_FBcl writer by name or creates it. This is called whenever a new FBlock_FBcl instance is necessary in a module to complete.

Parameters:

name - of the FBlock instance

fbkind - stored in FBlock_FBcl#_kindFBlock

fbType - the type identically with fbtw.fbt if fbtw is given. Else the necessary FBtype_FBcl

fbtw - null if fbType is from a given (standard or library) FBlock. Given if the FBlock's FBtype_FBcl is given in this module.

Returns:

given or created instance of this FBlock_FBcl writer.

getFBw

public Write_FBlock_FBwr getFBw(java.lang.String name)

Returns a stored FBlock, also a TEST FBlock by given name.

Parameters:

name -

Returns:

getCreateFBtype

public Write_FBtype_FBwr getCreateFBtype(java.lang.String name,
                                         FBlock_FBcl.Blocktype fbtype)

Gets an existing FBtype_FBcl to complete it with more features given in a GraphicBlock of LibreOffice-odg or another appropriate tool or creates just first time this FBlock. It is for FBlocks which are defined in graphic programming.

The FBtype_FBcl itself is registered in Prj_FBCLrd.idxAllFBlockType where all usable FBtype_FBcl are listed sorted by type.

Parameters:

name - unique name in the project

Returns:

existing or new created FBlockType to write/complete

getCreateFBtype

public Write_FBtype_FBwr getCreateFBtype(FBtype_FBcl fbt)

getPin

public Pin_FBcl getPin(PinType_FBcl pintw)

Gets a pin with known pin type. It used idxPinByName with the given name in the type.

Parameters:

pintw -

Returns:

getPin

public Pin_FBcl getPin(java.lang.String namePin)

Gets a pin with known pin type. It used idxPinByName with the given name.

Parameters:

pintw -

Returns:

addEvchain

public void addEvchain(Evchain_FBcl.Wr evChain)

evChains

public java.util.List<Evchain_FBcl.Wr> evChains()

getCreateSteptime

public SteptimeRef_FBcl getCreateSteptime(java.lang.String steptime)

getCreateState

public EccState_FBcl.Create getCreateState(java.lang.String name)

iterStates

public java.lang.Iterable<EccState_FBcl.Create> iterStates()

Returns an Iterable over all states, which's Iterable.iterator() can be used especially in for loops.

Returns:

never null. If idxState == null, Iterator.hasNext() of this return value returns always false.

getDTypePinMdl

public DType_FBcl getDTypePinMdl(DinoutType_FBcl pinMdl)

Gets the instance DType_FBcl due to the type DType_FBcl for a modules pin.

Parameters:

pinMdl - A pin of the type of module.

Returns:

completeAllFBlockTypePinsInModule

public void completeAllFBlockTypePinsInModule()

Completes all FBtype_FBcl inside the idxFBtype with its pins and store it in Mdl This is a central approach that is necessary when in a LibreOffice diagram some types are completely given externally (fbd). Then adequate the types given in the LibreOffice diagram should be completed to the same state, and then, if all the types are complete, #createAllFBlockPinsFromTypeInModule() creates the pins of all FBlocks due to the type. This is the proper approach.

Since:

2023-10-14 Used for LibreOffic graphic but should be usable also for all other inputs.

createAllFBblockPins

public void createAllFBblockPins()

completeAllMdlPins

public void completeAllMdlPins(TranslationScripts trlScripts)

Completes the inner FBtype_FBcl of all 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.

createAllMdlIfcPins

public void createAllMdlIfcPins(org.vishia.msgDispatch.LogMessage log)

Completes the module interface. The interface referenced with mdlifcWr and then FBtype_FBcl.WriteFBT#thisfb of type FBtype_FBcl is the access to the type of the module from outer. It should contain all pins but also the access to operations with the events, to call this operation in code generation without knowledge of the inner module structure.
The inner module pins are mirrored. It means a module din pin is of type DoutType_FBcl etc., an output to the inner wiring of the module. Hence the mirrored pin types are created here with call of FBtype_FBcl.WriteFBT#createDinTypeMdlIfc(DoutType_FBcl[]) etc. with the given arrays in the inner module interface. All Pin instances are created newly from the given pin instances of the inner module interface copying all necessities.

XXXcreateAllFBlockPinsFromTypeInModule

public void XXXcreateAllFBlockPinsFromTypeInModule()

Creates the pins of all FBlock_FBcl instances given in idxFBlock in the module due to its FBtype_FBcl. This should be called before the connections are associated.

Since:

2023-10-14. Used for LibreOffic graphic but should be usable also for all other inputs.

createAllInheritanceFromTypeInModule

public void createAllInheritanceFromTypeInModule()

Completes the FBtype_FBcl inside the Module_FBcl.ifcFB This is adequate TODO

postPrepareFBlocks

public void postPrepareFBlocks()

completeMdl

public void completeMdl()

Complete the new read module:

• completeMissingEventPinsInTypes()
• postPrepareFBlocks()
• #postPrepareDtypesToIfc()
• completeAllFBlockTypePinsInModule()
• #propgDtypes(LogMessage)
• Dataflow2Eventchain_FBrd#prc(Write_Module_FBwr)
• completeAllMdlPins(TranslationScripts)
• createAllFBblockPins()
• createAllMdlIfcPins(LogMessage)
• setExprOperatorToPins()

completeMissingEventPinsInTypes

public void completeMissingEventPinsInTypes()

setEqualsSteptimeInFBlocks

private void setEqualsSteptimeInFBlocks()

Check whether the FBlock instance has any step time assignments. If all are equal the associate this steptime to the {FBlock_FBcl#steptime}.

setExprOperatorToPins

public void setExprOperatorToPins()

buildEvtree

private void buildEvtree(org.vishia.msgDispatch.LogMessage logDbg)