org.vishia.fbcl.fblock

Class FBexpr_FBcl

java.lang.Object

org.vishia.fbcl.fblock.Block_FBcl

org.vishia.fbcl.fblock.FBlock_FBcl

org.vishia.fbcl.fblock.FBexpr_FBcl

Direct Known Subclasses:

FBoper_FBcl, StateTransCond

public class FBexpr_FBcl
extends FBlock_FBcl

Nested Class Summary

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
protected boolean	bCastoutput
boolean	bFullDTypePropagatedDin
protected boolean	bhasInputs
private char	cAccess A char determining the kind of access to this FBexpr: '~' it is inline in a expression term with only one output '&' it is inline in an expression term but with some additional outputs necessary as call by reference in C/++.
static java.lang.String[]	cmp2Operators
private char	cOp A char determining the basic function of the expression.
static char	cOpSetExpr
static char	cOpTextExpr
protected DType_FBcl.DtIxmdl	dTypeAllDin This is the resulting highest data type of all inputs.
static java.lang.String[]	limitOperators
Module_FBcl.CreateMdl	mdlcr
int	nrBitTrueFalse The bit number used in the module's event mask to set result true and false if it is an StdLibFBlocks_FBcl.fbtExprEv_OFB -1 if not used.
private java.lang.String	sFn A more complex function given as String, null if not used.
static java.lang.String[]	shiftOperators

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

din, dout, doutempty, dTypes, evin, evout, fbt, graphicPos, ixSlice, mdl, port, reference, sizeArrayFB, sOperators, steptime, sVersion, XXXfbPinDst, XXXfbPinSrc

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

graphicIntPos, name

Constructor Summary

Constructors

Constructor and Description
FBexpr_FBcl(FBtype_FBcl typeFb, java.lang.String name, Module_FBcl.CreateMdl parentModule, XY_FBcl graphicPos)

Method Summary

Modifier and Type	Method and Description
void	adjustFBexrFnDtypes() Adjust the type designations in sFn for all expressions due to the propagated read pin types.
char	cAccess() Returns the kind of access, see cAccess
boolean	castOutput() If true, then because of following compatible data type, the output in the source code generated expression should be casted to the DType stored on the exprOut.
char	cOp()
DType_FBcl	dTypeAllDin() Returns the effective deterministic DType as highest DType of all inner Din of the FBexpr.
DType_FBcl	dtypeExprOut() Returns the effective DType of the expression output, the scalar type of one of more FBexpr in one GBlock.
DType_FBcl.DtIxmdl	dtypeIxMdlExprOut() Gets the data type of the expression output, the scalar type of one of more FBexpr in one GBlock as reference to a maybe deterministic type with DType_FBcl.DtIxmdl.ixMdl().
char	getAccess()
Dout_FBcl	getFirstDout() Typical operation to get the only one Dout of an expression.
java.lang.String	getFunction()
boolean	hasInputs()
java.util.List<DinExpr_FBcl>	iterDinExpr() Returns an container which contains only the value inputs of this expression.
boolean	setAccess(char cAccess) Set the cAccess().
void	setCastOutput(boolean b)
void	setDTypeAllDin(DType_FBcl.DtIxmdl dtAllDin)
void	setExprPinFromPinsExprFn() Sets the din[0] with name "expr" content to the Din_FBcl.sConstant from the values on all pins on Dinout_FBcl#sOperator and the sFn, as it was read before with #setOperatorToPins() and maybe after adjustment written back.
boolean	setFunction(java.lang.String sFn)
void	setHasInputs()
boolean	setOperation(char cOp) Set the cOp().
void	setOperatorToPins(Prj_FBcl prj) Prepares the DinExpr_FBcl.sOperator in that kind which is proper for code generation following the expression term stored as constant on the first input with name 'expr'.

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

din, dinForeach, dout, doutForeach, dtNonArrayFB, dTypes, evin, evin, evout, evout, fbt, getFbPinSrc, getNrofConnin, getNrofConnout, getNrofDin, getNrofDout, getNrofEvin, getNrofEvout, getOut1Properties, getPin, getPinEvInByName, getPinEvOutByName, getPinInByName, getPinOutByName, getSteptime, getSteptimeStr, getTypeFB, isKind, iterEvout, iterEvout, iterPins, ixSlice, kind, kindWhatis, setDtypeInFBlock, setSizeArray, setSliceIndex, sizeArray, sizeArray, toString, typeName, XXXgetConnin, XXXgetConnout

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

addGpos, name, setName

Methods inherited from class java.lang.Object

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

Field Detail

shiftOperators

public static final java.lang.String[] shiftOperators

cmp2Operators

public static final java.lang.String[] cmp2Operators

limitOperators

public static final java.lang.String[] limitOperators

mdlcr

public final Module_FBcl.CreateMdl mdlcr

sFn

private java.lang.String sFn

A more complex function given as String, null if not used.

cOp

private char cOp

A char determining the basic function of the expression.

• ! 33 cOpSetExpr If the FBexpr has only one X input, but maybe also with a DinExpr_FBcl.pinK
• + * & v ^ = h for the types of the operation (ADD, MULT or DIV, AND, OR, XOR, CMP, SHIFT
• $ 36 cOpTextExpr if the sFn is set by a text in the expression graphic frame itself. It can be a function or a free expression text. If the expression contains also an aggregation it is used in the expression generation TODO in a special way not implemented yet. 2024-03
• ( If the ofpExprOut contains a function. It may be an FBoper with THIZ in a Expression term or any usual numeric function. The arguments comes in order of inputs. It is possible that the code generation can generate a specific code given by this text in the ofpExprOut sub shape. Whereby the function can contain data type identifier, which are adapted to the real used data types. For example the ofpExprOut can contain "atan2(n):N" which means, it is the atan2 function with one argument as complex any type, and the output is any real type. The translation produces "atan2(f)=F" which means atan2 from float complext to float. This string is used for code generation and may produce "atan2(X.im, X.re)" whereby X is the value on the input.
• . if it is an set of an element ".re" ".im" or other whereas the DinExpr_FBcl.sOperator contains the name of the element to set. The expression should have unconditionally an output variable of the proper type.
• TODO [ if it is an set to an array element whereas the DinExpr_FBcl.sOperator contains the access text.
• : if it is an access to an element of the input path whereas the name of the Dout_FBcl determines the access. The Dout_FBcl is one of maybe more members of the FBexpr_FBcl based on FBlock_FBcl.dout respectively Write_FBlock_FBwr.idxDout
• @ TODO it is used

Search for usage of setOperation(char) to see under which condition it is set.

cOpTextExpr

public static final char cOpTextExpr

See Also:

Constant Field Values

cOpSetExpr

public static final char cOpSetExpr

See Also:

Constant Field Values

cAccess

private char cAccess

A char determining the kind of access to this FBexpr:

• '~' it is inline in a expression term with only one output
• '&' it is inline in an expression term but with some additional outputs necessary as call by reference in C/++. This occurs especially for cOp == '(' as FBoper with more outputs. The additional output variables may be ofpDout, ofpVout, ofpZout
• '=' It sets all outputs to output variables, hence it is called as statement. The output variables may be ofpDout, ofpVout, ofpZout
• '@' it is inline in a expression term as FBoper (access with THIZ to a FBlock), without more outputs, but possible input arguments.
• '%' it is inline in an expression term as FBoper (access with THIZ to a FBlock), but with some additional outputs necessary as call be reference in C/++. This occurs especially for cOp == '(' as FBoper with more outputs. The additional output variables may be ofpDout, ofpVout, ofpZout
• '$' It is an FBoper which sets all outputs to output variables, hence it is called as statement. The output variables may be ofpDout, ofpVout, ofpZout
• '^' It is an FBexprEv which has outputs for true and false
• '#' It is an StateTrans_OFB which has outputs for true and false

nrBitTrueFalse

public int nrBitTrueFalse

The bit number used in the module's event mask to set result true and false if it is an StdLibFBlocks_FBcl.fbtExprEv_OFB -1 if not used.

bhasInputs

protected boolean bhasInputs

bCastoutput

protected boolean bCastoutput

dTypeAllDin

protected DType_FBcl.DtIxmdl dTypeAllDin

This is the resulting highest data type of all inputs. It is set to the dout if the dout is not determined. But if dout is determined the dout.dType() is used as cast, and this element can be used for modifying the value cast. Used for cast for example from float to 'I.20', with defined fractional bits

bFullDTypePropagatedDin

public transient boolean bFullDTypePropagatedDin

Constructor Detail

FBexpr_FBcl

public FBexpr_FBcl(FBtype_FBcl typeFb,
                   java.lang.String name,
                   Module_FBcl.CreateMdl parentModule,
                   XY_FBcl graphicPos)

Method Detail

setOperation

public boolean setOperation(char cOp)

Set the cOp(). See cOp.

Parameters:

cOp -

Returns:

false if cOp is already set with another value, this is an error in the graphic. The inputs of an expression should matching together.

cOp

public char cOp()

castOutput

public boolean castOutput()

If true, then because of following compatible data type, the output in the source code generated expression should be casted to the DType stored on the exprOut. It is not the natural data type resulting from the inputs.

Returns:

true then should cast in code generation.

setCastOutput

public void setCastOutput(boolean b)

setDTypeAllDin

public void setDTypeAllDin(DType_FBcl.DtIxmdl dtAllDin)

dTypeAllDin

public DType_FBcl dTypeAllDin()

Returns the effective deterministic DType as highest DType of all inner Din of the FBexpr. TODO the highest numeric type may be only determined on knowledge of the deterministic DTypes. But now using the common dTypeAllDin() it is determined for only the module itself. It is necessary to have a array of all non deterministic DTypes instead to check it more later, in this operation.

Returns:

The deterministic DType of the inner FBexpr-

dtypeIxMdlExprOut

public DType_FBcl.DtIxmdl dtypeIxMdlExprOut()

Gets the data type of the expression output, the scalar type of one of more FBexpr in one GBlock as reference to a maybe deterministic type with DType_FBcl.DtIxmdl.ixMdl(). It means the DType_FBcl.DtIx_.dt is the non deterministic one if it is non deterministic in the graphic. Use dtypeExprOut() to get the deterministic type on ready translated graphics in the calling environment.*

Returns:

null if not yet defined. The basic DType 'E' of the FBtype_FBcl is not returned.

dtypeExprOut

public DType_FBcl dtypeExprOut()

Returns the effective DType of the expression output, the scalar type of one of more FBexpr in one GBlock.

Returns:

null if not defined yet. Returns the non deterministic type if the deterministic is unknown. It calls Module_FBcl.dTypeMdl(org.vishia.fbcl.fblock.DType_FBcl.DtIxmdl) if the FBlock_FBcl.mdl is given.

hasInputs

public boolean hasInputs()

setHasInputs

public void setHasInputs()

setAccess

public boolean setAccess(char cAccess)

Set the cAccess(). See cAccess.

Parameters:

cOp -

Returns:

false if cOp is already set with another value, this is an error in the graphic. The inputs of an expression should matching together.

cAccess

public char cAccess()

Returns the kind of access, see cAccess

Returns:

getAccess

public char getAccess()

setFunction

public boolean setFunction(java.lang.String sFn)

getFunction

public java.lang.String getFunction()

iterDinExpr

public java.util.List<DinExpr_FBcl> iterDinExpr()

Returns an container which contains only the value inputs of this expression. It does not contain the expr input (din[0]) and does not contain all inputs which starts with "K", that are for multipliers also referenced with DinExpr_FBcl.pinK. This is for code generation from the inputs.

Returns:

Iterator for all data inputs.

getFirstDout

public Dout_FBcl getFirstDout()

Typical operation to get the only one Dout of an expression. Hint more as one is possible for FBoper_FBcl or expressions with specific function.

Returns:

null if FBlock_FBcl.dout is not set, else the first output.

setOperatorToPins

public void setOperatorToPins(Prj_FBcl prj)

Prepares the DinExpr_FBcl.sOperator in that kind which is proper for code generation following the expression term stored as constant on the first input with name 'expr'. For example a first "*" is removed in a multiplication term and a first "/" is replaced by "1/" to force a division. The form for code generation is always: An expression has operators only between its operands, not on first position. Only for ADD a "+" or "-" is admissible, it is a unary operator for the expression. See also
TODO sOperK not yet evaluated, set DinExpr_FBcl.sOperator for the K pins is missing. detected 2025-05

Parameters:

prj -

setExprPinFromPinsExprFn

public void setExprPinFromPinsExprFn()

Sets the din[0] with name "expr" content to the Din_FBcl.sConstant from the values on all pins on Dinout_FBcl#sOperator and the sFn, as it was read before with #setOperatorToPins() and maybe after adjustment written back. The value on din[0] for Din_FBcl.sConstant is important for write out in IEC61499. The operation setOperatorToPins(Prj_FBcl) is the backward operation, if 'expr' was read from fbd file in IEC61499 coding. For internal use the values on Dinout_FBcl#sOperator and the sFn are relevant.
The din[0] with name 'expr' was set on reading OFB diagram in org.vishia.fbcl.readOdg.OdgModule#createExprPins(org.vishia.fbcl.readOdg.OdgGBlock).

adjustFBexrFnDtypes

public void adjustFBexrFnDtypes()

Adjust the type designations in sFn for all expressions due to the propagated read pin types.
Only called for #fb instanceof FBexpr_FBcl

Parameters:

sFn - already read from the original