org.vishia.fbcl.readOdg

Class OdgGBlock

java.lang.Object

org.vishia.fbcl.readOdg.OdgGBlock

Direct Known Subclasses:

OdgXrefGraphic

public class OdgGBlock
extends java.lang.Object

This is the instance of a block in the graphic, independent of the built roundup FBlock for the class and instance.

• If the frame has the style "ofbClass". It is either a named FBlock, fbw refers a FBlock and fbtw refers a FBtype_FBcl.
• If the frame has the style "ofbXref" then fbw is instanceof OdgXref
• If the frame has the style "ofbConnPoint" then fbw is instanceof ConnPoint
• If the frame has the style "ofbComment" then fbw is instanceof ConnPoint
• If the frame has the style "ofbRequirement" then fbw is instanceof ConnPoint

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.
OdgGPin	fbPinDst It is a pin class for connections from this FB to other FBs or Pins.
OdgGPin	fbPinSrc It is a pin class for connections from this FB to other FBs or Pins.
protected FBtype_FBcl	fbt The type used here.
Write_FBtype_FBwr	fbtw The wrapper to write to a FBtype_FBcl, same instance for all occurrences of the FBlock type (class) in all diagrams.
java.util.List<Write_FBlock_FBwr>	fbw The FBlock_FBcl representation for the real used data.
java.lang.String	idGroup
java.lang.String	idRectangle
private java.util.TreeMap<java.lang.Integer,OdgGPin>	idxPinInstance List of all pins excl.
(package private) int[]	ixArray Remain null if it is not an array GBlock, value set from OdgNameTypeArray.descr.
(package private) java.util.List<java.lang.String>	listSlices Set if this describes a sliced FBlock presentation, value set from OdgNameTypeArray.descr.
OdgNameTypeArray	nameTypeArray Should be always given, final or set with OdgReader.assignFBlockNameTypeIdCreateFBlock(OdgShape, OdgGBlock, OdgModule)
OdgModule	odgMdl The module where this block is member of.
(package private) int	page Position of the main shape of the graphic block in mm, page, left, right, top, bottom, used to find the main frame for other ones.
(package private) int	pcol column association.
java.lang.String	sClassTypeName The original given Strings with style ofnClassTypeName and ofnClassObjName to determine the FBlock_Type_FBcl or FBlock.
java.lang.String	sFrameText The text to the graphic rectangle, the frame of the element.
(package private) java.lang.String	sName It is the base name if sliced.
java.lang.String	sPosxy Info about position manual readable
FBkind_FBcl	styleGraphicFrame The style designation of the graphic rectangle.
protected java.lang.String	sVariant Designation written on any pin in form '...
XY_FBcl	xy Helper class to sort OdgGBlock to xy-positions and to build a position instance (with #fbg ==null) to search pins of the graphic instance

Constructor Summary

Constructors

Constructor and Description
OdgGBlock(FBkind_FBcl style, XY_FBcl pos, OdgNameTypeArray nameTypeArray, int page, OdgModule odgMdl, org.vishia.msgDispatch.LogMessage log)

Method Summary

Modifier and Type	Method and Description
(package private) FBtype_FBcl	fbt() Returns the FBtype_FBcl either from given fbtw for a class block or from the given fbw
OdgGPin	getFbPinDst(OdgModule odgMdl) Creates if not given the PinInstance for a connection to the FBlock itself, not to a dedicated pin.
OdgGPin	getFbPinSrc(OdgModule odgMdl) Creates if not given the PinInstance for a connection from the FBlock itself, not from a dedicated pin.
OdgGPin	getFbPinSrc(PinKind_FBcl kind, OdgModule odgMdl) Creates if not given the PinInstance for a connection from the FBlock itself, not from a dedicated pin.
OdgGPin	getFirstPin() Returns the pin left top to help check the type of the GBlock
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.
java.lang.Iterable<OdgGPin>	iterPin()
boolean	putPin(OdgGPin pin, XY_FBcl xyPin) Stores the pin with a proper order built by position.
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) It sets the highest bit (MSB) as tag.
boolean	setVariant(java.lang.String sVariant)
java.lang.String	toString()
java.lang.String	variant()

Methods inherited from class java.lang.Object

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

Field Detail

idRectangle

public java.lang.String idRectangle

idGroup

public java.lang.String idGroup

sPosxy

public java.lang.String sPosxy

Info about position manual readable

xy

public XY_FBcl xy

Helper class to sort OdgGBlock to xy-positions and to build a position instance (with #fbg ==null) to search pins of the graphic instance.-

page

int page

Position of the main shape of the graphic block in mm, page, left, right, top, bottom, used to find the main frame for other ones.

pcol

int pcol

column association. Frames which are near in px1 have the same px1 value. It helps for sorting in columns with really distance, and then y direction (using py1). Blocks that are almost under each other, but not exactly, get the same pcol. Then sorting is simple, it is to the integer value 10000*pcol + py1. pcol is the latched value of px1, also in mm.

fbtw

public Write_FBtype_FBwr fbtw

The wrapper to write to a FBtype_FBcl, same instance for all occurrences of the FBlock type (class) in all diagrams. This aggregation is null if the type is given as library or standard FBlock. Then use fbt() to access the type.

fbt

protected FBtype_FBcl fbt

The type used here. The type may be non complete, then also fbtw is set.

odgMdl

public final OdgModule odgMdl

The module where this block is member of.

fbw

public java.util.List<Write_FBlock_FBwr> fbw

The FBlock_FBcl representation for the real used data. For array FBlock handling it is a list of FBlocks. For non array GBlocks only the fbw.get(0) is used. It is the same instance for all occurrences of the FBlock object in all diagrams. Also for given FBtype_FBcl in Prj_FBCLrd.idxAllFBlockType or for standard FBlocks the adding of Pins may need to be supported, for FBlocks with flexible number of inputs. Hence generally the FBlock_FBcl are presented by the write_.. wrapper. Also possible: Adding connections only done in the Write... version (change in future).

styleGraphicFrame

public FBkind_FBcl styleGraphicFrame

The style designation of the graphic rectangle. It determines whether it is a FBclass or FBexpression or ...

sFrameText

public java.lang.String sFrameText

The text to the graphic rectangle, the frame of the element. Depending on #styleGraphicFrame it can be used as instance name, combined class and instance name or variable name or also only as comment if the names are defined by ofnClassObjName or ofnClassTypeName.

sClassTypeName

public java.lang.String sClassTypeName

The original given Strings with style ofnClassTypeName and ofnClassObjName to determine the FBlock_Type_FBcl or FBlock.

nameTypeArray

public OdgNameTypeArray nameTypeArray

Should be always given, final or set with OdgReader.assignFBlockNameTypeIdCreateFBlock(OdgShape, OdgGBlock, OdgModule)

ixArray

final int[] ixArray

Remain null if it is not an array GBlock, value set from OdgNameTypeArray.descr. More as one dimension written with 'NAME[2][3]' for a 2 x 3 array.

listSlices

final java.util.List<java.lang.String> listSlices

Set if this describes a sliced FBlock presentation, value set from OdgNameTypeArray.descr. Slices are written as 'NAME[a, b, c]' or also 'NAME[1..16]' for 16 Slices NAME1, NAME2 etc.

sVariant

protected java.lang.String sVariant

Designation written on any pin in form '...%designation' as part of the description

sName

final java.lang.String sName

It is the base name if sliced. Set from OdgNameTypeArray.descr.

idxPinInstance

private final java.util.TreeMap<java.lang.Integer,OdgGPin> idxPinInstance

List of all pins excl. #fbPinSrc and #fbPinDst which are seen on this graphic block, independent of the type.

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.

fbPinSrc

public OdgGPin fbPinSrc

It is a pin class for connections from this FB to other FBs or Pins. For example for inheritance, dependencies, requirements and end points of association etc as class Type.

fbPinDst

public OdgGPin fbPinDst

It is a pin class for connections from this FB to other FBs or Pins. For example for inheritance, dependencies, requirements and end points of association etc as class Type.

Constructor Detail

OdgGBlock

public OdgGBlock(FBkind_FBcl style,
                 XY_FBcl pos,
                 OdgNameTypeArray nameTypeArray,
                 int page,
                 OdgModule odgMdl,
                 org.vishia.msgDispatch.LogMessage log)

Method Detail

fbt

FBtype_FBcl fbt()

Returns the FBtype_FBcl either from given fbtw for a class block or from the given fbw

Returns:

putPin

public boolean putPin(OdgGPin pin,
                      XY_FBcl xyPin)

Stores the pin with a proper order built by position.
The pins are sorted in the following order: First left side, then top, then right side, then bottom, then inner pins in vertical rows.

• If the pin is left side max. 1 mm inner in the frame block, then the key is the y position. Whereby left top is -2.
• If the pin is top side, max 1 mm inner in the frame block, the key is 1000 + xpos, whereby left top would be 998 but this is left side. first pin on top has 1000
• If the pin is right side, max, 1 mm inner in the frame block, the key is 2000 + ypos, whereby right top is 1998
• If the pin is bottomt side, max, 1 mm inner in the frame block, the key is 3000 + xpos, whereby right top is 3000
• If the pin is inside, the key is 4000 + 1000 ypos + xpos. It means the pins are sorted from top to down

The maximal size of a frame block is 1000*1000 mm, it is one meter! Should be really enough.

Parameters:

pin -

xyPin - absolute pin position. It is compared with xy to build the relative pin position in the odg block frame.

Returns:

iterPin

public java.lang.Iterable<OdgGPin> iterPin()

getFirstPin

public OdgGPin getFirstPin()

Returns the pin left top to help check the type of the GBlock

Returns:

getFbPinSrc

public OdgGPin getFbPinSrc(OdgModule odgMdl)

Creates if not given the PinInstance for a connection from the FBlock itself, not from a dedicated pin. The OdgGPin is stored in fbPinSrc and also as PinObj in the FBlock_FBcl.fbPinSrc. If it is existing, the existing is returned and used more as one time for a connection.

Returns:

the PinInstance to use for a connection.

getFbPinSrc

public OdgGPin getFbPinSrc(PinKind_FBcl kind,
                           OdgModule odgMdl)

Creates if not given the PinInstance for a connection from the FBlock itself, not from a dedicated pin. The OdgGPin is stored in fbPinSrc and also as PinObj in the FBlock_FBcl.fbPinSrc. If it is existing, the existing is returned and used more as one time for a connection.

Returns:

the PinInstance to use for a connection.

getFbPinDst

public OdgGPin getFbPinDst(OdgModule odgMdl)

Creates if not given the PinInstance for a connection to the FBlock itself, not to a dedicated pin. This is the THIS pin as port pin. The OdgGPin is stored in fbPinDst and also as PinObj in the FBlock_FBcl.fbPinDst. If it is existing, the existing is returned and used more as one time for a connection.

Returns:

the PinInstance to use for a connection.

variant

public java.lang.String variant()

setVariant

public boolean setVariant(java.lang.String sVariant)

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) It sets the highest bit (MSB) as tag.

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.String toString()

Overrides:

toString in class java.lang.Object