|
|
| Line 1: |
Line 1: |
| <span style="font-size:120%; color:black"><b><section begin=dpl_desc/>Return number of m<section end=dpl_desc/></b></span>
| | #REDIRECT [[FindNextItemNumber (GenericNamedArraylist function)]] |
| [[Category:FloatNamedArraylist methods|FindNextItemNumber function]]
| |
| <!--DPL?? Category:FloatNamedArraylist methods|FindNextItemNumber function: Return number of m-->
| |
| <p>
| |
| FindNextItemNumber is a member of the [[FloatNamedArraylist class]].
| |
| </p>
| |
| | |
| This function searches “forward” in the FloatNamedArraylist to find and return
| |
| the item number of the next item that matches a specified criterion.
| |
| The criterion is supplied by the [[SelectionCriterion class|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==
| |
| %itemnum = %fnamrayl:FindNextItemNumber(criterion -
| |
| [, Start=itemnum])
| |
| ===Syntax Terms===
| |
| <dl>
| |
| <dt><i>%itemnum</i>
| |
| <dd>A numeric variable to contain the item number of the
| |
| item that is located by the search.
| |
| <dt><i>%fnamrayl</i>
| |
| <dd>A FloatNamedArraylist object.
| |
| <dt><i>criterion</i>
| |
| <dd>A SelectionCriterion object, which is a relational expression that is
| |
| applied to a ''%fnamrayl'' 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, <tt>LT(this, 11)</tt> is the
| |
| criterion <tt>this</tt> <tt><</tt> <tt>11</tt>, where
| |
| <tt>this</tt> 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 ''%fnamrayl''
| |
| declaration and that returns a numeric or string value.
| |
| This is described further in "[[SelectionCriterion class#Specifying a SelectionCriterion's parameters|Specifying a SelectionCriterion's parameters]]".
| |
| <dt><b>Start=</b><i> itemnum</i>
| |
| <dd>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 FloatNamedArraylist.
| |
| For a FloatNamedArraylist 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 <tt>Start</tt> is required.
| |
| | |
| </dl>
| |
| ==Usage Notes==
| |
| <ul>
| |
| <li>If the value of Start is greater than the number of items in the FloatNamedArraylist,
| |
| the request is cancelled.
| |
| If the value of Start is equal to the number of items, FindNextItemNumber
| |
| returns a zero.
| |
| <li>[[FindPreviousItemNumber (FloatNamedArraylist function)|FindPreviousItemNumber]] is identical
| |
| to FindNextItemNumber except that it searches backward in the FloatNamedArraylist.
| |
| </ul>
| |
| ==Examples==
| |
| | |
| In the following fragment, two FindNextItemNumber calls and one
| |
| FindPreviousItemNumber call are applied to a FloatNamedArraylist
| |
| of objects of the <tt>annual</tt> class that is defined in the
| |
| request in the "[[Minimum (FloatNamedArraylist function)#Examples|FloatNamedArraylist Minimum function example]]".
| |
| <pre style="xmp">
| |
| %fann is floatnamedArraylist of object annual
| |
| %fann = new
| |
| %fann(12) = newa(621, 650)
| |
| %fann(14) = newa(334, 343)
| |
| %fann(15) = newa(288, 276)
| |
| %fann(13) = newa(141, 182)
| |
| %fann(11) = newa(131, 115)
| |
| | |
| %sel is object selectionCriterion for object annual
| |
| %sel2 is object selectionCriterion for object annual
| |
| %sel = GT(chg, 0)
| |
| %sel2 = AND(GT(chg, 0), GE(yend, 200))
| |
| | |
| %n is float
| |
| %n = %fann:findNextItemNumber(%sel)
| |
| Print %fann:itemByNumber(%n):myprint
| |
| | |
| %n = %fann:FindNextItemNumber(%sel2, start=%n)
| |
| Print %fann:itemByNumber(%n):myprint
| |
| | |
| %n = %fann:FindPreviousItemNumber(LT(chg, 0), start=%n)
| |
| Print 'item subscript is: ' %fann:nameByNumber(%n)
| |
| </pre>
| |
| | |
| The result is:
| |
| <pre style="xmp">
| |
| ybegin=621, yend=650
| |
| ybegin=334, yend=343
| |
| item subscript is: 11
| |
| </pre>
| |