org.vishia.fbcl.fblock

Class Pin_FBcl<Type_Pin extends Pin_FBcl<Type_Pin,Type_Connect>,Type_Connect extends Pin_FBcl<Type_Connect,Type_Pin>>

java.lang.Object

org.vishia.fbcl.fblock.PinBase_FBcl

org.vishia.fbcl.fblock.Pin_FBcl<Type_Pin,Type_Connect>

All Implemented Interfaces:

PinDtypeIfc_FBcl

Direct Known Subclasses:

Dinout_FBcl, Evin_FBcl, Evout_FBcl

public abstract class Pin_FBcl<Type_Pin extends Pin_FBcl<Type_Pin,Type_Connect>,Type_Connect extends Pin_FBcl<Type_Connect,Type_Pin>>
extends PinBase_FBcl

A Pin is any connector on a Function Block, either for event or data, either in or output. This is the base class for all.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Pin_FBcl.XXXXXEKind

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

PinBase_FBcl.EPinKind

Field Summary

Fields

Modifier and Type	Field and Description
java.util.List<Type_Connect>	connect
private java.util.List<Evchain_FBcl.Wr>	evChainShow Note whether this pin is a member of a event chain.
FBlock_FBcl	fb The block which this connection is member of.
private long	mEvChains Up to 64 evChain can tangent this pin. 1 bit per chain.
private long	mEvChainsDep Up to 64 evChain which's data and outputs are depending from this pin.
protected java.util.Map<java.lang.String,Type_Connect>	sorted

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

ixPin, kind, mAssociatedEvData, namePin

Constructor Summary

Constructors

Constructor and Description
Pin_FBcl(PinBase_FBcl.EPinKind what, java.lang.String namePin, int ixPin, FBlock_FBcl fb) If not null then it contains the generation rule to execute the data access operation.

Method Summary

Modifier and Type	Method and Description
void	addEvchain(Evchain_FBcl.Wr evchain)
void	addEvchainDepending(int ixEvChainInMdl)
boolean	connectFrom(Type_Connect fromPin) Sets the connection between this and any destination, it is an in pin of any other FBlock_FBcl If the same toPin is already connected, nothing is done.
java.util.List<Type_Connect>	connections()
boolean	containsEvchain(Evchain_FBcl evchain)
boolean	containsOtherEvchain(Evchain_FBcl evchain)
DinType_FBcl	dinType() Gets the din from the Type of the given FBlock.
DoutType_FBcl	doutType() Gets the dout from the Type of the given FBlock.
java.lang.String	evChainHex()
EvinType_FBcl	evinType() Gets the evin from the Type of the given FBlock.
EvoutType_FBcl	evoutType() Gets the evout from the Type of the given FBlock.
Type_Connect	getFirstConnection() If the connection has at least one partner, returns the first or only one.
java.lang.String	getNameFBpin() Gets a String with the FBLock name and the pin name.
Type_Connect	getOneConnection() If the ev input has exactly one source, returns it.
java.util.Iterator<Type_Connect>	iterConnections()
java.lang.Iterable<Evchain_FBcl>	iterEvchainDep(Module_FBcl mdl)
java.lang.Iterable<Evchain_FBcl.Wr>	iterEvchainShow()
int	nrofConnections()
void	removeConnections() Removes all connections from this pin.
protected void	throwError(java.lang.String txt, DinoutType_FBcl src)
java.lang.String	toString()
java.lang.String	toStringDtype()
java.lang.String	wrConInfo() Returns the connection info as String without the information about fb info.

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

addAssociatedEvData, dtype, maskAssociatedEvData

Methods inherited from class java.lang.Object

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

Field Detail

evChainShow

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

Note whether this pin is a member of a event chain. It is yet only for check, not used for generation.

mEvChains

private long mEvChains

Up to 64 evChain can tangent this pin. 1 bit per chain. If more as 64 evChain are part of the module, then this element should be enhanced with an array.

mEvChainsDep

private long mEvChainsDep

Up to 64 evChain which's data and outputs are depending from this pin. The doutPin should be virtual for the own evChain. If more as 64 evChain are part of the module, then this element should be enhanced with an array.

fb

public final FBlock_FBcl fb

The block which this connection is member of. Never null.

connect

public final java.util.List<Type_Connect extends Pin_FBcl<Type_Connect,Type_Pin>> connect

sorted

protected final java.util.Map<java.lang.String,Type_Connect extends Pin_FBcl<Type_Connect,Type_Pin>> sorted

Constructor Detail

Pin_FBcl

public Pin_FBcl(PinBase_FBcl.EPinKind what,
                java.lang.String namePin,
                int ixPin,
                FBlock_FBcl fb)

If not null then it contains the generation rule to execute the data access operation. For primitive expression flow it is the expression using the inputs.

Method Detail

connectFrom

public boolean connectFrom(Type_Connect fromPin)

Sets the connection between this and any destination, it is an in pin of any other FBlock_FBcl If the same toPin is already connected, nothing is done. Twice trying connection is allowed. It is asserted if the same toPin is not connected , this is not connected in toPin too. It is called in preparation process. Note: It is package private, only used in the Overridden Pin_FBcl#connectFrom(ConnIn_FBcl)

Parameters:

toPin - the partner, there the connection is added too.

Returns:

true if added, false if already was added before.

connections

public java.util.List<Type_Connect> connections()

nrofConnections

public int nrofConnections()

getOneConnection

public Type_Connect getOneConnection()

If the ev input has exactly one source, returns it. If the input has no source or more as one source (or-Event), this operation returns null. Use #getMultipleSrcEv() to check all event sources if this operation returns null.

getFirstConnection

public Type_Connect getFirstConnection()

If the connection has at least one partner, returns the first or only one. If the input has no source this operation returns null.

removeConnections

public void removeConnections()

Removes all connections from this pin. If it is a din or evin, the source connection is removed only. If it is a dout or evout, all connections are removed in both directions.

iterConnections

public java.util.Iterator<Type_Connect> iterConnections()

evinType

public EvinType_FBcl evinType()

Gets the evin from the Type of the given FBlock.

Returns:

Info from the type of this FBlock.

evoutType

public EvoutType_FBcl evoutType()

Gets the evout from the Type of the given FBlock.

Returns:

Info from the type of this FBlock.

dinType

public DinType_FBcl dinType()

Gets the din from the Type of the given FBlock.

Returns:

Info from the type of this FBlock.

doutType

public DoutType_FBcl doutType()

Gets the dout from the Type of the given FBlock.

Returns:

Info from the type of this FBlock.

getNameFBpin

public java.lang.String getNameFBpin()

Gets a String with the FBLock name and the pin name.

Returns:

wrConInfo

public java.lang.String wrConInfo()

Returns the connection info as String without the information about fb info. It is especially for out connections in the netlist. The FBlock info is written already in the head information.

Returns:

name: type

addEvchain

public void addEvchain(Evchain_FBcl.Wr evchain)

addEvchainDepending

public void addEvchainDepending(int ixEvChainInMdl)

containsEvchain

public boolean containsEvchain(Evchain_FBcl evchain)

containsOtherEvchain

public boolean containsOtherEvchain(Evchain_FBcl evchain)

iterEvchainDep

public java.lang.Iterable<Evchain_FBcl> iterEvchainDep(Module_FBcl mdl)

iterEvchainShow

public java.lang.Iterable<Evchain_FBcl.Wr> iterEvchainShow()

evChainHex

public java.lang.String evChainHex()

toStringDtype

public java.lang.String toStringDtype()

Returns:

name: type FB: { * } name.ixCon/ixPort

See Also:

Object.toString()

toString

public java.lang.String toString()

Overrides:

toString in class PinBase_FBcl

throwError

protected void throwError(java.lang.String txt,
                          DinoutType_FBcl src)