org.vishia.fbcl.readOdg

Class OdgGPin

java.lang.Object

org.vishia.fbcl.readOdg.OdgGPin

All Implemented Interfaces:

org.vishia.util.ToStringBuilder

public class OdgGPin
extends java.lang.Object
implements org.vishia.util.ToStringBuilder

This is one occurrence of a Pin in the graphic. First on evaluation of the graphic the pin connection are stored in OdgGBlock.idxPinInstance, as given in the graphic
On evaluation of the module the later pinType is set with the PinType_FBcl due to the type and pinObj is set with all Pin_FBcl of the instances of OdgGBlock.fbw. There the real existing connections between FBlocks are stored.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	bDeferredAssocEvData Set temporary to regard pins for the second call of OdgModule#buildAssociatedEventDataPins(org.vishia.fbcl.readOdg.OdgGBlock, org.vishia.fbcl.fblockwr.Write_Module_FBwr) for association of event and data because in a second call default behavior on missing events are done.
java.util.List<OdgConnection>	connections If a variable is assigned after the pinObj as output, this is it.
static OdgGPin	dummy
OdgGBlock	fbg where the pin is member of.
(package private) java.lang.String	id id from this instance
PinKind_FBcl	kind The same as PinType_FBcl.kind but stored before create the pin instances.
protected java.lang.String	name
OdgNameTypeArray	nameType
(package private) XY_FBcl	odgxy
private java.util.List<Pin_FBcl>	pinObj
private PinType_FBcl	pinType The associated roundup of the pin.
java.lang.String	sText The text to the pin as input for name, type etc. as written in graphic.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	OdgGPin()
	OdgGPin(OdgGPin src, PinKind_FBcl kind) Builds a copy for replacement of a pin which other kind.
	OdgGPin(PinType_FBcl pinType, OdgGBlock fbg, OdgNameTypeArray nameType, PinKind_FBcl kind) Builds a pin with given descriptions .
	OdgGPin(java.lang.String id, XY_FBcl odgxy, PinKind_FBcl kind, PinType_FBcl pinType, Pin_FBcl pin, java.lang.String text, OdgGBlock fbg, OdgModule odgMdl, org.vishia.msgDispatch.LogMessage log) Ctor with already given Pin_FBcl and PinType_FBcl
	OdgGPin(java.lang.String id, XY_FBcl odgxy, PinKind_FBcl kind, java.lang.String text, OdgGBlock fbg, OdgModule odgMdl, org.vishia.msgDispatch.LogMessage log) Constructs a graphic pin

Method Summary

Modifier and Type	Method and Description
java.lang.String	addConnection(OdgConnection conn)
void	addPinObj(Pin_FBcl pinObj)
boolean	isDeferredAssocEvDataClean() Tests and cleans the event-data association as deferred (used in association from the graphic, see org.vishia.fbcl.readOdg.OdgModule#buildAssociatedEventDataPins(org.vishia.fbcl.readOdg.OdgGBlock, org.vishia.fbcl.fblockwr.Write_Module_FBwr) It sets the highest bit (MSB) as tag.
PinKind_FBcl	kind()
java.lang.String	name()
java.util.List<Pin_FBcl>	pinObj()
PinType_FBcl	pinType()
void	setDeferredAssocEvData() Sets the event-data association as deferred (used in association from the graphic, see org.vishia.fbcl.readOdg.OdgModule#buildAssociatedEventDataPins(org.vishia.fbcl.readOdg.OdgGBlock, org.vishia.fbcl.fblockwr.Write_Module_FBwr)
boolean	setPinType(PinType_FBcl pinType, org.vishia.msgDispatch.LogMessage log)
java.lang.String	toString()
java.lang.StringBuilder	toString(java.lang.StringBuilder app, java.lang.String... cond)

Methods inherited from class java.lang.Object

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

Field Detail

id

java.lang.String id

id from this instance

pinType

private PinType_FBcl pinType

The associated roundup of the pin.

pinObj

private java.util.List<Pin_FBcl> pinObj

connections

public final java.util.List<OdgConnection> connections

If a variable is assigned after the pinObj as output, this is it. Use it for gather connections from connections to this pin.

fbg

public final OdgGBlock fbg

where the pin is member of. From here the OdgGBlock.fbtw and OdgGBlock#obj is referenced.

bDeferredAssocEvData

private transient boolean bDeferredAssocEvData

Set temporary to regard pins for the second call of OdgModule#buildAssociatedEventDataPins(org.vishia.fbcl.readOdg.OdgGBlock, org.vishia.fbcl.fblockwr.Write_Module_FBwr) for association of event and data because in a second call default behavior on missing events are done. It cannot be done in the first call. First all ...

odgxy

final XY_FBcl odgxy

sText

public final java.lang.String sText

The text to the pin as input for name, type etc. as written in graphic. This information is not evaluated, because it is pre-evaluated and stored in nameType But it may be important for debugging to recognize a pin.

nameType

public final OdgNameTypeArray nameType

name

protected java.lang.String name

kind

public PinKind_FBcl kind

The same as PinType_FBcl.kind but stored before create the pin instances.

dummy

public static final OdgGPin dummy

Constructor Detail

OdgGPin

public OdgGPin(java.lang.String id,
               XY_FBcl odgxy,
               PinKind_FBcl kind,
               java.lang.String text,
               OdgGBlock fbg,
               OdgModule odgMdl,
               org.vishia.msgDispatch.LogMessage log)

Constructs a graphic pin

Parameters:

id -

odgxy -

kind -

text -

fbg -

odgMdl -

log - Only for problem report if text is faulty.

OdgGPin

public OdgGPin(java.lang.String id,
               XY_FBcl odgxy,
               PinKind_FBcl kind,
               PinType_FBcl pinType,
               Pin_FBcl pin,
               java.lang.String text,
               OdgGBlock fbg,
               OdgModule odgMdl,
               org.vishia.msgDispatch.LogMessage log)

Ctor with already given Pin_FBcl and PinType_FBcl

Parameters:

id -

odgxy -

kind -

pinType -

pin -

text -

fbg -

odgMdl -

OdgGPin

public OdgGPin(OdgGPin src,
               PinKind_FBcl kind)

Builds a copy for replacement of a pin which other kind.

OdgGPin

public OdgGPin(PinType_FBcl pinType,
               OdgGBlock fbg,
               OdgNameTypeArray nameType,
               PinKind_FBcl kind)

Builds a pin with given descriptions .

OdgGPin

private OdgGPin()

Method Detail

name

public final java.lang.String name()

kind

public final PinKind_FBcl kind()

addConnection

public java.lang.String addConnection(OdgConnection conn)

pinType

public PinType_FBcl pinType()

pinObj

public java.util.List<Pin_FBcl> pinObj()

setPinType

public boolean setPinType(PinType_FBcl pinType,
                          org.vishia.msgDispatch.LogMessage log)

addPinObj

public void addPinObj(Pin_FBcl pinObj)

setDeferredAssocEvData

public void setDeferredAssocEvData()

Sets the event-data association as deferred (used in association from the graphic, see org.vishia.fbcl.readOdg.OdgModule#buildAssociatedEventDataPins(org.vishia.fbcl.readOdg.OdgGBlock, org.vishia.fbcl.fblockwr.Write_Module_FBwr)

isDeferredAssocEvDataClean

public boolean isDeferredAssocEvDataClean()

Tests and cleans the event-data association as deferred (used in association from the graphic, see org.vishia.fbcl.readOdg.OdgModule#buildAssociatedEventDataPins(org.vishia.fbcl.readOdg.OdgGBlock, org.vishia.fbcl.fblockwr.Write_Module_FBwr) It sets the highest bit (MSB) as tag.

toString

public java.lang.StringBuilder toString(java.lang.StringBuilder app,
                                        java.lang.String... cond)

Specified by:

toString in interface org.vishia.util.ToStringBuilder

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object