org.vishia.fbcl.fblock

Class Dout_FBcl

java.lang.Object

org.vishia.fbcl.fblock.Pin_FBcl

org.vishia.fbcl.fblock.Dinout_FBcl

org.vishia.fbcl.fblock.Dout_FBcl

All Implemented Interfaces:

org.vishia.util.ToStringBuilder

Direct Known Subclasses:

DoutElemAcc_FBcl, DoutExpr_FBcl, PinPort_FBcl

public class Dout_FBcl
extends Dinout_FBcl

This class describes data output for FBlock_FBcl instances. There are some additional information and operations for event chain building and code generation to Pin_FBcl.

Nested Class Summary

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

Pin_FBcl.XXXXXEKind

Field Summary

Fields

Modifier and Type	Field and Description
boolean	bCheckedNonConst
boolean	bEvInQueue True then this output is driven by an event in a chain already, used for org.vishia.fbcl.readSource.Dataflow2Eventchain_FBrd.
private boolean	bIsConst The output evaluates to a constant value independent from a data flow.
private boolean	bLocalVar Set in the Event Chain Builder: true then this output should be presented by an local variable in code generation.
private boolean	bObjectVar Set in the Event Chain Builder: true then this output value should be stored in an object or instance variable, because other event chains uses this value or the value is used from previous storing.
private boolean	bSetInEvinOp True then this dout is used or the variable will be set (bLocalVar) while the evin-operation is executed.
private long	mAlreadyCheckedInEvChain The bit of the Evchain_FBcl.nr is set if this Dout is already processed inside the evChain by Evchain_FBcl.Wr.checkDin(long, FBlock_FBcl, EccAction_FBcl, Write_Module_FBwr).
private long	mCheckedDinForEvin The Din which are checked for evin already in the same evChain.
private long	mOperations Bits for all operations which influences this output.
private long	mOperationsNext Bits for a next opeation which uses this Dout_FBcl as input.
static Dout_FBcl[]	nullArray
private java.lang.String	sCodeAccess If not null then it is a constant given as String on this input.
boolean	XXXbBreakChain Deprecated.

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

nDTypeIsPropg, steptime, zVectorDim

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

connectDst, connectSrc, fb, name, pint, version, xy

Constructor Summary

Constructors

Constructor and Description
Dout_FBcl(DoutType_FBcl pint, FBlock_FBcl fb, XY_FBcl xy)
Dout_FBcl(DoutType_FBcl pint, java.lang.String name, FBlock_FBcl fb, XY_FBcl xy)

Method Summary

Modifier and Type	Method and Description
Evout_FBcl	assgndFirstEvout() Searches the first and often only one evout due to this dout.
java.lang.String	assgndFirstEvoutName() Searches the first and often only one evout due to this dout.
java.lang.Iterable<Din_FBcl>	connectDst()
java.lang.String	getCodeAccess()
DoutType_FBcl	getDoutType()
EccAction_FBcl	getOneOperation() Returns the only one operation or null.
boolean	isAlreadyCombinatoricDinChecked(Evchain_FBcl evChain)
boolean	isConstant()
boolean	isLocalVar() This output should be presented in generate code with a variable.
boolean	isObjectVar() This output should be presented in generate code with an instance variable because other evChain operations may use it, or an output is connected, or the output is wired from back (a state variable).
org.vishia.util.IterableIterator<Evout_FBcl>	iterAssocEvout(boolean bCreate) Gets the associated Evout to this pin using the type information and IteratorAssocPins_FBcl.
java.lang.Iterable<EccAction_FBcl>	iterOperations(Module_FBcl mdl)
java.lang.Iterable<EccAction_FBcl>	iterOperNext(Module_FBcl mdl)
long	mCheckedDinForEvin()
void	mCheckedDinForEvin(long bits)
long	mOper() Operations which sets this output.
long	mOperNext() Operations which uses this output for calculation.
java.lang.String	operHex()
boolean	setAlreadyCombinatoricDinChecked(Evchain_FBcl evChain)
void	setCodeAccess(java.lang.String val)
void	setLocalVar(Write_Module_FBwr mdlwr) This output should be presented in generate code with a variable.
void	setObjectVar(Write_Module_FBwr mdlwr) This output should be presented in generate code with an instance variable because other evChain operations may use it, or an output is connected, or the output is wired from back (a state variable).
void	setOperation(EccAction_FBcl oper)
void	setOperNext(EccAction_FBcl operNext) Inform that this output is used by the given operation.
void	setToConstant()
java.lang.String	toString()
java.lang.String	varName() Returns a variable name proper to the Dout and FBlock.

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

dtArrayCpp, dType, dType, dTypeArray, dTypeChar, dtypeCpp, getSteptime, getSteptimeStr, isComplexDType, namePin, propagateSteptime, setDType

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

addEvchain, addEvchainDepending, connDst, connectFrom, connectFrom, connSrc, containsEvchain, containsOtherEvchain, dinType, doutType, evChainHex, evinType, evoutType, fbtypeName, getFirstConnDst, getFirstConnSrc, getMaskEvinMdlChainDriven, getMaskEvoutMdlBackChainDriven, getOneConnSrc, getOneConnSrc, isEventBackChainDriven, isEventBackChainDriven, isEventChainDriven, isEventChainDriven, isEventChainDriven, isEventChainDriven, isKind, isNotKind, isUpdatePin, iterConnDst, iterConnSrc, iterEvchainDep, iterEvchainShow, nameFBpin, nameFBpin, nrofConnDst, nrofConnSrc, pinType, removeConnectDst, removeConnectSrc, removeConnSrcAll, removePinSimpleInConnDst, setEventBackChainDriven, setEventChainDriven, spec, spec, throwError, toString, XXXremoveConnectSrc, XXXremoveConnSrc

Methods inherited from class java.lang.Object

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

Field Detail

nullArray

public static Dout_FBcl[] nullArray

sCodeAccess

private java.lang.String sCodeAccess

If not null then it is a constant given as String on this input. Note: a numeric constant is written "1.234", a String constant is contained with " here ("\"string\""). Note: If given, connectFromBlock is null.

bEvInQueue

public transient boolean bEvInQueue

True then this output is driven by an event in a chain already, used for org.vishia.fbcl.readSource.Dataflow2Eventchain_FBrd.

bLocalVar

private boolean bLocalVar

Set in the Event Chain Builder: true then this output should be presented by an local variable in code generation. It should store a value only during calculation, not used from outer

bIsConst

private boolean bIsConst

The output evaluates to a constant value independent from a data flow. Usual it is an expression which should be first calculated.

bObjectVar

private boolean bObjectVar

Set in the Event Chain Builder: true then this output value should be stored in an object or instance variable, because other event chains uses this value or the value is used from previous storing.

mOperations

private long mOperations

Bits for all operations which influences this output. Usual one.

mOperationsNext

private long mOperationsNext

Bits for a next opeation which uses this Dout_FBcl as input. Hence it is depending in the event queue execution.

mCheckedDinForEvin

private long mCheckedDinForEvin

The Din which are checked for evin already in the same evChain. It is for additional din because of bObjectVar

mAlreadyCheckedInEvChain

private long mAlreadyCheckedInEvChain

The bit of the Evchain_FBcl.nr is set if this Dout is already processed inside the evChain by Evchain_FBcl.Wr.checkDin(long, FBlock_FBcl, EccAction_FBcl, Write_Module_FBwr).

bSetInEvinOp

private boolean bSetInEvinOp

True then this dout is used or the variable will be set (bLocalVar) while the evin-operation is executed.

XXXbBreakChain

@Deprecated
public boolean XXXbBreakChain

Deprecated.

An output which breaks the chain of events because of an special internal wiring condition from the source of the graphical module, it is for example a Unit delay in Simulink, or from the FBtype_FBcl which has this property too: DinoutType_FBcl.bBreakChain.

bCheckedNonConst

public transient boolean bCheckedNonConst

Constructor Detail

Dout_FBcl

public Dout_FBcl(DoutType_FBcl pint,
                 java.lang.String name,
                 FBlock_FBcl fb,
                 XY_FBcl xy)

Dout_FBcl

public Dout_FBcl(DoutType_FBcl pint,
                 FBlock_FBcl fb,
                 XY_FBcl xy)

Method Detail

setLocalVar

public void setLocalVar(Write_Module_FBwr mdlwr)

This output should be presented in generate code with a variable. But it is a local variable (not an instance variable) if setObjectVar(Write_Module_FBwr) was not set.

Parameters:

mdlwr -

setToConstant

public void setToConstant()

isConstant

public boolean isConstant()

isLocalVar

public boolean isLocalVar()

This output should be presented in generate code with a variable. But it is a local variable (not an instance variable) if setObjectVar(Write_Module_FBwr) was not set.

setObjectVar

public void setObjectVar(Write_Module_FBwr mdlwr)

This output should be presented in generate code with an instance variable because other evChain operations may use it, or an output is connected, or the output is wired from back (a state variable).

Parameters:

mdlwr -

isObjectVar

public boolean isObjectVar()

This output should be presented in generate code with an instance variable because other evChain operations may use it, or an output is connected, or the output is wired from back (a state variable).

Parameters:

mdlwr -

setAlreadyCombinatoricDinChecked

public boolean setAlreadyCombinatoricDinChecked(Evchain_FBcl evChain)

isAlreadyCombinatoricDinChecked

public boolean isAlreadyCombinatoricDinChecked(Evchain_FBcl evChain)

mCheckedDinForEvin

public void mCheckedDinForEvin(long bits)

mCheckedDinForEvin

public long mCheckedDinForEvin()

connectDst

public java.lang.Iterable<Din_FBcl> connectDst()

setCodeAccess

public void setCodeAccess(java.lang.String val)

getCodeAccess

public java.lang.String getCodeAccess()

setOperation

public void setOperation(EccAction_FBcl oper)

mOper

public long mOper()

Operations which sets this output. Independent of evChains.

Returns:

mask each bit represents an operation in Module_FBcl.allOperations()

See Also:

#iterOperations(Module_FBcl)(Module_FBcl);r

iterOperations

public java.lang.Iterable<EccAction_FBcl> iterOperations(Module_FBcl mdl)

setOperNext

public void setOperNext(EccAction_FBcl operNext)

Inform that this output is used by the given operation.

Parameters:

operNext -

mOperNext

public long mOperNext()

Operations which uses this output for calculation. Independent of evChains.

Returns:

mask each bit represents an operation in Module_FBcl.allOperations()

See Also:

iterOperNext(Module_FBcl);r

iterOperNext

public java.lang.Iterable<EccAction_FBcl> iterOperNext(Module_FBcl mdl)

iterAssocEvout

public org.vishia.util.IterableIterator<Evout_FBcl> iterAssocEvout(boolean bCreate)

Gets the associated Evout to this pin using the type information and IteratorAssocPins_FBcl. The associated type pins are determined with PinType_FBcl.mAssocEvData. From that bits the FBtype_FBcl.doutPin are nominated. That helps to select the FBlock_FBcl.evout for iteration.

Parameters:

bCreate - true then create the adequate evout pin from the type information if not found in this instance.

Returns:

over evout due to associated ones from this evin. Never null, maybe empty.

getDoutType

public DoutType_FBcl getDoutType()

assgndFirstEvout

public Evout_FBcl assgndFirstEvout()

Searches the first and often only one evout due to this dout.

Returns:

null if no corresponding event is found.

assgndFirstEvoutName

public java.lang.String assgndFirstEvoutName()

Searches the first and often only one evout due to this dout.

Returns:

null if no corresponding event is found.

getOneOperation

public EccAction_FBcl getOneOperation()

Returns the only one operation or null. Note check #iterOperations() if returns null here.

Returns:

null if no or more operations are assigned. Usually for an output it is one operation.

varName

public java.lang.String varName()

Returns a variable name proper to the Dout and FBlock.

• If the FBlock has only this dout and has not instance data, the variable has the name of the FBlock.
• If the FBlock is a input port, then it has NAME_in.
• If the FBlock has more pins or has instance data, it is NAME_NAMEFBLOCK
  The variable name is used for all code generation languages.

Returns:

operHex

public java.lang.String operHex()

toString

public java.lang.String toString()

Overrides:

toString in class Pin_FBcl