OdgGBlock

java.lang.Object
- org.vishia.fbcl.readOdg.OdgGBlock

Direct Known Subclasses:

OdgGState, 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
`(package private) boolean`	`bCreatedFBlockPins`
`FBkind_FBcl`	`eKindBlock` The style designation of the graphic rectangle.
`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.
`OdgGPin`	`fbPinThis` 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.
`int`	`gSequence` Sequence of this GBlock in graphic.
`java.lang.String`	`idGroup`
`java.lang.String`	`idRectangle`
`private java.util.TreeMap<java.lang.Integer,OdgGPin>`	`idxPin` List of all pins excl.
`private java.util.TreeMap<java.lang.String,OdgGPin>`	`idxPinByName` List of all pins excl.
`(package private) int[]`	`ixArray` Remain null if it is not an array GBlock, value set from `OdgNameTypeArray.descr`.
`int`	`ixGraphicOrder` Current index of this instance in `OdgModule.idxAllGBlockByGpos` only for report.
`(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
`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
Modifier	Constructor and Description
`protected`	`OdgGBlock(FBkind_FBcl style, XY_FBcl pos, OdgNameTypeArray nameTypeArray, int page, OdgModule odgMdl, LogMessage log)` Constructs.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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
`(package private) OdgGPin`	`getCreatePin(OdgGPin src, PinKind_FBcl kind, java.lang.String name, java.lang.String text, OdgModule odgMdl, LogMessage log)`
`(package private) OdgGPin`	`getCreatePin(PinKind_FBcl kind, DoutTargetCodeAccess accTargetCode, java.lang.String name, java.lang.String text, XY_FBcl xy, OdgModule odgMdl, LogMessage log)` Gets or creates a pin on odg level.
`(package private) OdgGPin`	`getCreatePin(java.lang.String id, XY_FBcl odgxy, PinKind_FBcl kind, java.lang.String name, java.lang.String text, OdgGBlock fbg, OdgModule odgMdl, LogMessage log)`
`(package private) OdgGPin`	`getCreatePinThis(LogMessage log)` Gets or created the pin port THIS both for use as FBtype GBlock reference as also for FBlock.
`OdgGPin`	`getFbPinDst(OdgModule odgMdl)` Creates if not given the `fbPinDst` : `OdgGPin` for a connection to the FBlock itself, not to a dedicated pin.
`OdgGPin`	`getFbPinSrc(OdgModule odgMdl)` Creates if not given the `fbPinSrc` : `OdgGPin` 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
`(package private) OdgGPin`	`getPin(java.lang.String name)`
`java.lang.Iterable<OdgGPin>`	`iterPin()`
`java.lang.String`	`name()`
`static OdgGBlock`	`new_OdgGBlock(FBkind_FBcl style, XY_FBcl pos, OdgNameTypeArray nameTypeArray, int page, OdgModule gMdl)` Constructs a new OdgGBlock and registers it in `OdgModule.idxAllGBlockByGpos`.
`boolean`	`putPin(OdgGPin pin, XY_FBcl xyPin, LogMessage log)` Stores the pin with a proper order built by position.
`java.lang.String`	`toString()`

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 final 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.-
  - gSequence
```
public final int gSequence
```
    Sequence of this GBlock in graphic. It is either the position or comes from
  - ixGraphicOrder
```
public int ixGraphicOrder
```
    Current index of this instance in OdgModule.idxAllGBlockByGpos only for report.
  - 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.
    
    If the FBlock presents an FBoper_OFB, this refers the type where the FBoper_OFB is member of (which is aggregated), whereas then fbt set with the FBoper_FBcl type instance.
  - 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_FBcl.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).
  - eKindBlock
```
public FBkind_FBcl eKindBlock
```
    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.
  - sName
```
java.lang.String sName
```
    It is the base name if sliced. Set from OdgNameTypeArray.descr.
  - idxPin
```
private final java.util.TreeMap<java.lang.Integer,OdgGPin> idxPin
```
    List of all pins excl. #fbPinSrc and #fbPinDst which are seen on this graphic block, independent of the type. This index is sorted to the graphic order. the key is built from the position. It contains, of course, also expression input pins.
  - idxPinByName
```
private final java.util.TreeMap<java.lang.String,OdgGPin> idxPinByName
```
    List of all pins excl. #fbPinSrc and #fbPinDst which are seen on this graphic block, independent of the type. This Index has the name of the pin as key. Expression input pins are not contained here. Note: The expression inputs have the name 'X1'... and are built with the order in idxPin later in the FBexpr_FBcl
  - 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.
  - fbPinThis
```
public OdgGPin fbPinThis
```
    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.
  - bCreatedFBlockPins
```
boolean bCreatedFBlockPins
```
- Constructor Detail
  - OdgGBlock
```
protected OdgGBlock(FBkind_FBcl style,
                    XY_FBcl pos,
                    OdgNameTypeArray nameTypeArray,
                    int page,
                    OdgModule odgMdl,
                    LogMessage log)
```
    Constructs. It should not be used by user, use new_OdgGBlock(FBkind_FBcl, XY_FBcl, OdgNameTypeArray, int, OdgModule). It is only used by the derived OdgXrefGraphic.
    
    Parameters:
    
    style - The semantic of the GBlock from the style in LOffcDraw
    
    pos - position in graphic should be given
    
    nameTypeArray - additional info to the GBlock
    
    page - the page number (also contained in pos ?)
    
    gMdl - the module where this GBlock is member off, to register, to access OdgModule.prj and Prj_FBcl.log for logging.
- Method Detail
  - new_OdgGBlock
```
public static OdgGBlock new_OdgGBlock(FBkind_FBcl style,
                                      XY_FBcl pos,
                                      OdgNameTypeArray nameTypeArray,
                                      int page,
                                      OdgModule gMdl)
```
    Constructs a new OdgGBlock and registers it in OdgModule.idxAllGBlockByGpos. This index contains then ALL existing GBlocks, used for report and debug.
    
    Parameters:
    
    style - The semantic of the GBlock from the style in LOffcDraw
    
    pos - position in graphic should be given
    
    nameTypeArray - additional info to the GBlock
    
    page - the page number (also contained in pos ?)
    
    gMdl - the module where this GBlock is member off, to register, to access OdgModule.prj and Prj_FBcl.log for logging.
    
    Returns:
    
    the created instance, or null if the GBlock is twice on the same graphic position or with the same sequence number in OdgNameTypeArray.nrGpos.
  - fbt
```
FBtype_FBcl fbt()
```
    Returns the FBtype_FBcl either from given fbtw for a class block or from the given fbw
    
    Returns:
  - getCreatePin
```
OdgGPin getCreatePin(OdgGPin src,
                     PinKind_FBcl kind,
                     java.lang.String name,
                     java.lang.String text,
                     OdgModule odgMdl,
                     LogMessage log)
```
  - getCreatePin
```
OdgGPin getCreatePin(PinKind_FBcl kind,
                     DoutTargetCodeAccess accTargetCode,
                     java.lang.String name,
                     java.lang.String text,
                     XY_FBcl xy,
                     OdgModule odgMdl,
                     LogMessage log)
```
    Gets or creates a pin on odg level. But the pin will be registered in Write_FBtype_FBwr to assure that the pin is unique and admissible. It is not registered in the Write_FBlock_FBwr.
    
    Parameters:
    
    kind - To create the correct pin kind, or to compare with the found one.
    
    name - Name in type
    
    text - null or possible additional information, for example the data type as given in graphic.
    
    xy - graphic position
    
    odgMdl -
    
    log -
    
    Returns:
    
    The pin registered in idxPin, idxPinByName if name is given and also in fbtw if given, or found in fbt()
  - getCreatePin
```
OdgGPin getCreatePin(java.lang.String id,
                     XY_FBcl odgxy,
                     PinKind_FBcl kind,
                     java.lang.String name,
                     java.lang.String text,
                     OdgGBlock fbg,
                     OdgModule odgMdl,
                     LogMessage log)
```
  - getPin
```
OdgGPin getPin(java.lang.String name)
```
  - putPin
```
public boolean putPin(OdgGPin pin,
                      XY_FBcl xyPin,
                      LogMessage log)
```
    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.
    Store the pin in this idxPin and idxPinByName:
    - If a pin is already existing with the same position, the position will be incremented by 1 to distinguish in idxPin and store behind the found pin in this order. Up to 10 pins are possible on the same position, if the next pin has a distance of 1 mm.
    - With this key as order the pin is stored in idxPin
    - If the pin has a name only then it is stored also in idxPinByName. 'idxPinByName' does not contain nameless pins, it is especially expression inputs. They are unnecessary their (never searched by name).
    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 fbPinSrc : OdgGPin for a connection from the FBlock itself, not from a dedicated pin. This connections from this pin may be later create dedicated pins in the FBcl data, but not immediately yet. Because they depends from the kind of connection. For example OdgConnection.ECkind.dataflow creates an expression output on an ofbExpr FBlock, but later in the operation OdgModule.createFBexprPins_duetoGBlockPins(OdgGBlock). Also in the later called OdgModule.createFBlockPins(OdgGBlock) connections are evaluated and creates specific pins.
    
    Returns:
    
    the PinInstance to use for a connection.
  - getFbPinDst
```
public OdgGPin getFbPinDst(OdgModule odgMdl)
```
    Creates if not given the fbPinDst : OdgGPin for a connection to the FBlock itself, not to a dedicated pin. This connections to this pin may be later create dedicated pins in the FBcl data, but not immediately yet. Because they depends from the kind of connection. For example OdgConnection.ECkind.dataflow creates an expression input on an ofbExpr FBlock, but later in the operation OdgModule.createFBexprPins_duetoGBlockPins(OdgGBlock). Also in the later called OdgModule.createFBlockPins(OdgGBlock) connections are evaluated and creates specific pins.
    
    Note: This operation is not used if a graphic connection of kind
    
    Returns:
    
    the PinInstance to use for a connection.
  - getCreatePinThis
```
OdgGPin getCreatePinThis(LogMessage log)
```
    Gets or created the pin port THIS both for use as FBtype GBlock reference as also for FBlock. This operation is called in evaluation of connections to the fbPinDst to build the FBcl data. if is called first in OdgModule.buildFBclData() and there in OdgModule#processGraphicPinConnections(OdgGPin, OdgGBlock, org.vishia.fbcl.readOdg.OdgConnection.ECkind) for the OdgConnection.piDst as here found fbPinDst if a connection of kind OdgConnection.ECkind.aggr or also assoc and comp is connected to a whole odgGBlock. It is necessary to create then the necessary Pins in the FBcl data. This OdgGPin instance has only the task that a one time found connection can be used more as one time more simple. It changes the odgGBlock instance in a later state (after finish OdgReader.gatherGraphic(org.vishia.fbcl.readOdg.xml.XmlForOdg, String)). Hence it may be removed later in a cleanup phase, use the immediately necessary THIS pins in the FBcl data. (TODO)
    - The fbPinThis is returned, or created and returned.
    - If the pin is created:
    - If fbw is set, for all FBlock_FBcl referenced via fbw: Write_FBlock_FBwr all OdgGPin.pinObj in fbPinThis are set. Also OdgGPin.pinType is set.
    - If fbw is not set, but either fbtw is set or only fbt is set (a pre defined FBtype), then only OdgGPin.pinType is set.
    It means the situation about fbw fbtw needs to be clarify before. This is ok if the graphic connection resolving to FBcl connection is done after all instances of FBlock, FBtype are created for the module.
    Parameters:
    
    log - only for message on problems / errors.
    
    Returns:
    
    the pin for THIS, the reference to the whole FBlock and / or only FBtype.
  - name
```
public java.lang.String name()
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class OdgGBlock

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

idRectangle

idGroup

sPosxy

xy

gSequence

ixGraphicOrder

page

pcol

fbtw

fbt

odgMdl

fbw

eKindBlock

sFrameText

sClassTypeName

nameTypeArray

ixArray

listSlices

sName

idxPin

idxPinByName

fbPinSrc

fbPinDst

fbPinThis

bCreatedFBlockPins

Constructor Detail

OdgGBlock

Method Detail

new_OdgGBlock

fbt

getCreatePin

getCreatePin

getCreatePin

getPin

putPin

iterPin

getFirstPin

getFbPinSrc

getFbPinDst

getCreatePinThis

name

toString