org.vishia.fbcl.fblock

Class IteratorAssocPins_FBcl<T extends Pin_FBcl>

java.lang.Object

org.vishia.fbcl.fblock.IteratorAssocPins_FBcl<T>

Type Parameters:

T - The pin Type returned by next()

All Implemented Interfaces:

java.lang.Iterable<T>, java.util.Iterator<T>, org.vishia.util.IterableIterator<T>

public class IteratorAssocPins_FBcl<T extends Pin_FBcl>
extends java.lang.Object
implements org.vishia.util.IterableIterator<T>

This is a specific iterator which works with a bit mask for associated pins given in the PinType_FBcl but returns the associated Pin_FBcl in the FBlock_FBcl.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	bCreateNonExists
(package private) boolean	bExecHasNext Set to true if hasNext() was called, set to false on next().
(package private) PinType_FBcl[]	dstArray Either this array is set from the associated type FBtype_FBcl, for library modules
(package private) T[]	dstPinArray If listPinTypeDst is null then the pins are searched and gotten from here, it is the array in the FBlock_FBcl.
private PinType_FBcl	dstType current pin in the type which is the primary found one. null on beginning.
(package private) FBlock_FBcl	fb Alternatively to thisW, use fb to get the pin if all is prepared.
private java.util.Iterator<T>	iterMulitplePins This iterator is currently used if multiple pins are searched in the list or map of thisW.
(package private) java.lang.Iterable<T>	iterPinDst This iterator is the start value for iterMulitplePins given in ctor.
(package private) int	ixMask Current ix in mask, -1 as startvalue is increment to 0 = bit0, 0b...1
(package private) int	ixMultiPin This is used as iterator over the dstArray for multiple pins. -2 means, multipin mode is switched of.
(package private) java.util.List<? extends PinType_FBcl>	listPinTypeDst Or this List is set from the associated type Write_FBtype_FBwr, for own created types.
(package private) long	mask
(package private) T	pinNext If not null, hasNext() has found a multi pin.
private int	recursive
(package private) Write_FBlock_FBwr	thisW If the data are not ready prepared, yet only stored in this write version, use it to get or create a pin.

Constructor Summary

Constructors

Constructor and Description
IteratorAssocPins_FBcl(long mask, Write_FBlock_FBwr fbw, FBlock_FBcl fb, java.lang.Iterable<T> iterDstPin, T[] dstPinArray, java.util.List<? extends PinType_FBcl> dstListInType, PinType_FBcl[] dstArrayInType) Same as IteratorAssocPins_FBcl(long, Write_FBlock_FBwr, FBlock_FBcl, Iterable, Pin_FBcl[], List, PinType_FBcl[], boolean) but without create, creates never an non existing instance pin.
IteratorAssocPins_FBcl(long mask, Write_FBlock_FBwr fbw, FBlock_FBcl fb, java.lang.Iterable<T> iterDstPin, T[] dstPinArray, java.util.List<? extends PinType_FBcl> dstListInType, PinType_FBcl[] dstArrayInType, boolean bCreateNonExists)

Method Summary

Modifier and Type	Method and Description
(package private) T	getPinInFBarray(PinType_FBcl pinType)
boolean	hasNext()
java.util.Iterator<T>	iterator()
T	next() Returns the pin of thisW proper to the type pin with the mask.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

mask

final long mask

ixMask

int ixMask

Current ix in mask, -1 as startvalue is increment to 0 = bit0, 0b...1

thisW

final Write_FBlock_FBwr thisW

If the data are not ready prepared, yet only stored in this write version, use it to get or create a pin.

bCreateNonExists

private final boolean bCreateNonExists

fb

final FBlock_FBcl fb

Alternatively to thisW, use fb to get the pin if all is prepared.

dstPinArray

final T extends Pin_FBcl[] dstPinArray

If listPinTypeDst is null then the pins are searched and gotten from here, it is the array in the FBlock_FBcl.

dstArray

final PinType_FBcl[] dstArray

Either this array is set from the associated type FBtype_FBcl, for library modules

listPinTypeDst

final java.util.List<? extends PinType_FBcl> listPinTypeDst

Or this List is set from the associated type Write_FBtype_FBwr, for own created types.

iterPinDst

final java.lang.Iterable<T extends Pin_FBcl> iterPinDst

This iterator is the start value for iterMulitplePins given in ctor. Never changed.

iterMulitplePins

private java.util.Iterator<T extends Pin_FBcl> iterMulitplePins

This iterator is currently used if multiple pins are searched in the list or map of thisW.

dstType

private PinType_FBcl dstType

current pin in the type which is the primary found one. null on beginning. Used for Multi Pins.

ixMultiPin

int ixMultiPin

This is used as iterator over the dstArray for multiple pins. -2 means, multipin mode is switched of.

pinNext

T extends Pin_FBcl pinNext

If not null, hasNext() has found a multi pin.

bExecHasNext

boolean bExecHasNext

Set to true if hasNext() was called, set to false on next(). If false, then next() calls first hasNext() to prepare the next access. With this help next() can be used without hasNext() which is proper due the interface definition.

recursive

private int recursive

Constructor Detail

IteratorAssocPins_FBcl

public IteratorAssocPins_FBcl(long mask,
                              Write_FBlock_FBwr fbw,
                              FBlock_FBcl fb,
                              java.lang.Iterable<T> iterDstPin,
                              T[] dstPinArray,
                              java.util.List<? extends PinType_FBcl> dstListInType,
                              PinType_FBcl[] dstArrayInType,
                              boolean bCreateNonExists)

Parameters:

mask - from the given pin in its type either PinType_FBcl.maskAssociatedEvData() or PinType_FBcl.maskAssocInOut()

fbw - null or the used Write_FBlock_FBwr where the FBlock pins are defined.

fb - null or the FBlock where the ready to used pins are defined.

iterDstPin - null if fbw == null or the List or Map.values() where the pins should contain in

dstPinArray - null if fb==null or the array where the pins are contained.

dstListInType - the list of the pins in this #fbtw or null if not given (for library blocks)

dstArrayInType - the array of the pins in this FBlock_FBcl.WriteFB.fb or null if empty (for new created FBlocks

bCreateNonExists - only used for fbw given, true then create non existing pins if their are given in the type.

IteratorAssocPins_FBcl

public IteratorAssocPins_FBcl(long mask,
                              Write_FBlock_FBwr fbw,
                              FBlock_FBcl fb,
                              java.lang.Iterable<T> iterDstPin,
                              T[] dstPinArray,
                              java.util.List<? extends PinType_FBcl> dstListInType,
                              PinType_FBcl[] dstArrayInType)

Same as IteratorAssocPins_FBcl(long, Write_FBlock_FBwr, FBlock_FBcl, Iterable, Pin_FBcl[], List, PinType_FBcl[], boolean) but without create, creates never an non existing instance pin.

Parameters:

mask -

fbw -

fb -

iterDstPin -

dstPinArray -

dstListInType -

dstArrayInType -

Method Detail

iterator

public java.util.Iterator<T> iterator()

Specified by:

iterator in interface java.lang.Iterable<T extends Pin_FBcl>

getPinInFBarray

T getPinInFBarray(PinType_FBcl pinType)

hasNext

public boolean hasNext()

Specified by:

hasNext in interface java.util.Iterator<T extends Pin_FBcl>

next

public T next()

Returns the pin of thisW proper to the type pin with the mask.

Specified by:

next in interface java.util.Iterator<T extends Pin_FBcl>