FindNextItemNumber (Arraylist function)

Return number of matching item (Arraylist class)

FindNextItemNumber is a member of the Arraylist class.

This function searches "forward" in the Arraylist to find and return the item number of the next item that matches a specified criterion. The criterion is supplied by the SelectionCriterion object that is a required FindNextItemNumber parameter. If no item satisfies the criterion, the method returns a zero.

FindNextItemNumber is available in Sirius Mods version 7.6 and later.

Syntax

%number = al:FindNextItemNumber( selectionCriterion, [Start= number])

Syntax terms

%itemnum	A numeric variable to contain the item number of the item that is located by the search.
al	An Arraylist object.
criterion	A SelectionCriterion object, which is a relational expression that is applied to an al item value to determine whether the value satisfies the expression. The expression consists of a function, an operator, and a numeric or string value. For example, GT(this, -11) is the criterion this > -11, where this is an identity function that simply returns the item's value. The item number of the first item tested by FindNextItemNumber that satisfies this expression is the method's return value. The function in the criterion is a method value (a method or class member name literal, or a method variable) for a method that operates on items of the type specified on the al declaration and that returns a numeric or string value. This is described further in "Specifying a SelectionCriterion's parameters".
Start= itemnum	The number of the item after which to begin the search. If the itemnum value of Start is 2, item 3 is the first item considered. The value of Start may be 0 through the number of items in the collection. For a collection of three items, itemnum may be 0, 1, 2, or 3. This is an optional argument, and it defaults to 0. If you specify a value, the parameter name Start is required.

Usage notes

• If the value of Start is greater than the number of items in the Arraylist, the request is cancelled. If the value of Start is equal to the number of items, FindNextItemNumber returns a zero.
• FindPreviousItemNumber is identical to FindNextItemNumber except that it searches backward in the Arraylist.

Examples

The following request contains two FindNextItemNumber calls, one with a simple selection criterion and one with a compound criterion:

    Begin
    %al is  arraylist of float
    %al = list(111, 29, 0, 93, 77, -345)

    %sel1 is object selectioncriterion for float
    %sel2 is object selectioncriterion for float
    %sel1 = GT(this, 100)
    %sel2 = AND(GE(this, 53), LT(this, 93))

    printtext {~} is: {%al:findNextItemNumber(%sel1, start=1)}
    printtext {~} is: {%al:findNextItemNumber(%sel2)}
    End

The result is:

    %al:findNextItemNumber(%sel1, start=1) is: 0
    %al:findNextItemNumber(%sel2) is: 5