org.vishia.fbcl.fblock

Class Dinout_FBcl

java.lang.Object

org.vishia.fbcl.fblock.Pin_FBcl

org.vishia.fbcl.fblock.Dinout_FBcl

All Implemented Interfaces:

org.vishia.util.ToStringBuilder

Direct Known Subclasses:

Din_FBcl, Dout_FBcl

public abstract class Dinout_FBcl
extends 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
int	nDTypeIsPropg True then this pin is reached by any forward declaration.
SteptimeRef_FBcl	steptime The steptime is only necessary if the module has no event connection.
int	zVectorDim If not 0 then this port is a scalar port and the associated Pin_FBcl.fb can be used for a vector (sliced, for each) operation if the data type of connection is a vector.

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

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

Constructor Summary

Constructors

Constructor and Description
Dinout_FBcl(DinoutType_FBcl pint, java.lang.String name, FBlock_FBcl fb, XY_FBcl xy)
Dinout_FBcl(PinType_FBcl pint, java.lang.String name, FBlock_FBcl fb, XY_FBcl xy)

Method Summary

Modifier and Type	Method and Description
java.lang.String	dtArrayCpp()
DType_FBcl	dType() Gets the data type.
DType_FBcl	dType(java.lang.String sElement) Gets the data type.
DType_FBcl	dTypeArray() gets the data type of array connection.
char	dTypeChar()
java.lang.String	dtypeCpp(char what)
SteptimeRef_FBcl	getSteptime() Returns the steptime reference to the instance.
java.lang.String	getSteptimeStr() Returns the string representation of the Steptime.
boolean	isComplexDType() Simple access to DType properties from Otx script.
java.lang.String	namePin()
void	propagateSteptime(SteptimeRef_FBcl steptime)
java.lang.String	setDType(DType_FBcl src) Checks and sets the data type form src.
private void	setSteptimeToOtherCon(Pin_FBcl[] thiscon, DinoutType_FBcl[] typecon, SteptimeRef_FBcl steptimeType)

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, toString, XXXremoveConnectSrc, XXXremoveConnSrc

Methods inherited from class java.lang.Object

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

Field Detail

steptime

public SteptimeRef_FBcl steptime

The steptime is only necessary if the module has no event connection. It is used to associate event cluster to FBlocks.

zVectorDim

public int zVectorDim

If not 0 then this port is a scalar port and the associated Pin_FBcl.fb can be used for a vector (sliced, for each) operation if the data type of connection is a vector.
That property of a Connection is defined with the kind of FBlock. Any simple block has this capability (num operation etc). A Callmodule_FBlock_JgenMdl-connection has this property >0 only if it is a for-each-subsystem and the port is a for-each-port.

nDTypeIsPropg

public transient int nDTypeIsPropg

True then this pin is reached by any forward declaration. If true then a backward declaration is unnecessary.

Constructor Detail

Dinout_FBcl

public Dinout_FBcl(DinoutType_FBcl pint,
                   java.lang.String name,
                   FBlock_FBcl fb,
                   XY_FBcl xy)

Dinout_FBcl

public Dinout_FBcl(PinType_FBcl pint,
                   java.lang.String name,
                   FBlock_FBcl fb,
                   XY_FBcl xy)

Method Detail

namePin

public final java.lang.String namePin()

dType

public DType_FBcl dType()

Gets the data type. It is either a fix type stored in the DinoutType_FBcl or it is a variable type stored in FBlock_FBcl.dTypes. or it is the non specified type stored in FBtype_FBcl.dTypes if FBlock..dTypes is not set. It is null if the type is yet not set.

It calls dType(String) with null as element.

Returns:

the type or null if no type is given.

dType

public DType_FBcl dType(java.lang.String sElement)

Gets the data type. It is either a fix type stored in the DinoutType_FBcl or it is a variable type stored in FBlock_FBcl.dTypes. or it is the non specified type stored in FBtype_FBcl.dTypes if FBlock..dTypes is not set. It is null if the type is yet not set.

Parameters:

sElement - The access string to an element of a maybe given array or structure. If null, the original DType_FBcl is returned. If not null, then the array type is derived to its element type or the structure type is derived to the type of the element. Last one is proper for complex types with '.re' and '.im' but not yet for any structures. This may be done later in future by evaluating the FBtype_FBcl description to the structure. An element is a pin of this FBtype.

Returns:

the type or null if no type is given or the deviating is not possible.

dTypeArray

public DType_FBcl dTypeArray()

gets the data type of array connection. It is either a fix type stored in the DinoutType_FBcl or it is a variable type stored in FBlock_FBcl.dTypes for the array connection gotten from dTypes[ix][1] instead dTypes[ix][0]. or it is the non specified type stored in FBtype_FBcl.dTypes if FBlock..dTypes is not set. It is null if the type is yet not set.

Returns:

the type or null.

dTypeChar

public char dTypeChar()

isComplexDType

public boolean isComplexDType()

Simple access to DType properties from Otx script.

Returns:

true if the DType of the pin is complex.

dtypeCpp

public java.lang.String dtypeCpp(char what)

dtArrayCpp

public java.lang.String dtArrayCpp()

setDType

public java.lang.String setDType(DType_FBcl src)

Checks and sets the data type form src.
Either the dType() is already the same as src argument, then nothing is done. This is for dedicated matching dTypes.

If the dType() is not the same, but the dType of the DinoutType_FBcl.dType() is not flexible, it means the DinoutType_FBcl.ixDtype is -1, then returns the error message.

If the dType() is not the same, then but it is able to change, then FBlock_FBcl.setDtype(int, DType_FBcl) is called. This operation checks the given DinoutType_FBcl.dType() for compatibility and sets, if possible, the given DType_FBcl in src in the FBlock_FBcl.dTypes array valid for this pin, but also adusts all depending DTypes in FBlock_FBcl.dTypes.

If the compatibility check fails in FBlock_FBcl.setDtype(int, DType_FBcl), then there also an error message is returned.

Parameters:

src - any given Data Type.

Returns:

null if ok or an error/warning message String "DType is not able to change: " + Pin_FBcl.nameFBpin().

getSteptimeStr

public java.lang.String getSteptimeStr()

Returns the string representation of the Steptime.

Returns:

"?" if the steptime is not defined.

getSteptime

public SteptimeRef_FBcl getSteptime()

Returns the steptime reference to the instance.

setSteptimeToOtherCon

private void setSteptimeToOtherCon(Pin_FBcl[] thiscon,
                                   DinoutType_FBcl[] typecon,
                                   SteptimeRef_FBcl steptimeType)

propagateSteptime

public void propagateSteptime(SteptimeRef_FBcl steptime)