FindNextItemNumber (GenericNamedArraylist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
mNo edit summary
 
(19 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{Template:GenericNamedArraylist:FindNextItemNumber subtitle}}
{{Template:GenericNamedArraylist:FindNextItemNumber subtitle}}


This function searches "forward" in the NamedArraylist to find and return
<var>FindNextItemNumber</var> searches "forward" in a <var>[[FloatNamedArraylist class|FloatNamedArraylist]]</var>, <var>[[NamedArraylist class|NamedArraylist]]</var>, or <var>[[UnicodeNamedArraylist class|UnicodeNamedArraylist]]</var> 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 <var>FindNextItemNumber</var> parameter. If no item satisfies the criterion, the method returns a zero.
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==
==Syntax==
{{Template:GenericNamedArraylist:FindNextItemNumber syntax}}
{{Template:GenericNamedArraylist:FindNextItemNumber syntax}}
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%itemnum</th>
<tr><th>%number</th>
<td>A numeric variable to contain the item number of the item that is located by the search. </td></tr>
<td>A numeric variable to contain the item number of the item that is located by the search. </td></tr>
<tr><th>%namrayl</th>
<tr><th>anyNal</th>
<td>A NamedArraylist object. </td></tr>
<td>The <var>FloatNamedArraylist</var>, <var>NamedArraylist</var> or <var>UnicodeNamedArraylist</var> method object. </td></tr>
<tr><th>criterion</th>
<tr><th>selectionCriterion</th>
<td>A SelectionCriterion object, which is a relational expression that is applied to a ''%namrayl'' item value to determine whether the value satisfies the expression. The expression consists of a function, an operator, and a numeric or string value.
<td>A <var>SelectionCriterion</var> object, which is a relational expression that is applied to a <var class="term">anyNal</var> item value to determine whether the value satisfies the expression. The expression consists of a function, an operator, and a numeric or string value.
<p>For example, <code>GT(this, 11)</code> is the criterion <code>this > 11</code>, where <var>This</var> is an identity function value that simply returns the item's value. The item number of the first item tested by <var>FindNextItemNumber</var> that satisfies this expression is the method's return value.</p>
<p>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 <var class="term">anyNal</var> 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"]].</p> </td></tr>
<tr><th><var>Start</var></th>
<td>The <var class="term">number</var> of the item <b><i>after</i></b> which to begin the search. If the value of <var>Start</var> is 2, item 3 is the first item considered. The value of <var>Start</var> may be 0 through the number of items in the <var>FloatNamedArraylist</var>, <var>NamedArraylist</var> or <var>UnicodeNamedArraylist</var>. For an array list of three items, <var class="term">number</var> may be 0, 1, 2, or 3.
<p>This is an optional, [[Methods#Named parameters|name required]], argument which defaults to 0. If you specify a value, the parameter name <var>Start</var> is required.</p></td></tr>
</table>


For example, <tt>GT(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 ''%namrayl'' 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]]". </td></tr>
<tr><th>Start= itemnum</th>
<td>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 NamedArraylist. For a NamedArraylist 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.</td></tr>
</table>
==Usage notes==
==Usage notes==
<ul>
<ul>
<li>If the value of Start is greater than the number of items in the NamedArraylist,
<li>If the value of <var>Start</var> is greater than the number of items in the <var>FloatNamedArraylist</var>, <var>NamedArraylist</var> or <var>UnicodeNamedArraylist</var>, the request is cancelled. If the value of <var>Start</var> is equal to the number of items, then <var>FindNextItemNumber</var> returns a zero.
the request is cancelled.
<li><var>FindNextItemNumber</var> is available in <var class="product">[[Sirius Mods|Sirius Mods]]</var> Version 7.6 and later.
If the value of Start is equal to the number of items, FindNextItemNumber
returns a zero.
<li>The [[FindPreviousItemNumber (NamedArraylist function)|FindPreviousItemNumber]] functional is identical
to FindNextItemNumber except that it searches backward in the NamedArraylist.
</ul>
</ul>
==Examples==
==Examples==
 
<ol><li>In the following fragment, two <var>FindNextItemNumber</var> calls and one <var>[[FindPreviousItemNumber_(GenericNamedArraylist_function)|FindPreviousItemNumber]]</var> call are applied to a collection of objects of the <code>staff</code> class that is defined in the request in the [[FindNextItem (GenericNamedArraylist function)#Examples|"FindNextItem Examples"]] section:
In the following fragment, two FindNextItemNumber calls and one
FindPreviousItemNumber call are applied to a collection
of objects of the <tt>staff</tt> class that is defined in the
request in "[[FindPreviousItem (NamedArrayArraylist function)#Examples|NamedArrayArraylist FindPreviousItem function example]]":
<p class="code">%old is namedArraylist of object staff
<p class="code">%old is namedArraylist of object staff
%old = new
%old = new
Line 50: Line 36:
%old('Jon') = newf('White', 'retired')
%old('Jon') = newf('White', 'retired')


%sel1 is object selectioncriterion for float
%sel1 is object selectioncriterion for object staff
%sel2 is object selectioncriterion for float
%sel2 is object selectioncriterion for object staff
%n is float
%n is float
%sel1 = GT(name, 'Mud')
%sel1 = gt(name, 'Mud')
%sel2 = AND(GT(name, 'Mud'), EQ(status, 'retired'))
%sel2 = and(gt(name, 'Mud'), eq(status, 'retired'))


%n = %old:FindNextItemNumber(%sel1, start=1)
%n = %old:findNextItemNumber(%sel1, start=1)
Print %old:nameByNumber(%n)
print %old:nameByNumber(%n)


%n = %old:FindNextItemNumber(%sel2)
%n = %old:findNextItemNumber(%sel2)
Print %old:nameByNumber(%n)
print %old:nameByNumber(%n)


%n = %old:FindPreviousItemNumber(LT(name, 'Mud'), -
%n = %old:findPreviousItemNumber(lt(name, 'Mud'), start=%n)
start=%n)
print %old:nameByNumber(%n)
Print %old:nameByNumber(%n)
</p>
</p>


Line 70: Line 55:
<p class="output">Jim
<p class="output">Jim
Jon
Jon
Jan
Jed
</p>
 
<li>The following request contains two <var>FindNextItemNumber</var> calls and one
<var>FindPreviousItemNumber</var> call:
<p class="code">begin
 
%k  is unicodeNamedArraylist of longstring
%k = new
%k('&amp;sect;Jan':u) = 'Orion'
%k('&amp;sect;Apr':u) = 'Leo'
%k('&amp;sect;Mar':u) = 'Cancer'
%k('&amp;sect;Jun':u) = 'Ursa Minor'
%k('&amp;sect;Nov':u) = 'Andromeda'
%k('&amp;sect;Dec':u) = 'Aries'
%k('&amp;sect;Feb':u) = 'Canis Major'
 
%sel is object selectionCriterion for longstring
%n is float
%sel = LT(this, 'C')
 
%n = %k:findNextitemNumber(%sel)
print %k:nameByNumber(%n)
 
%n = %k:findNextItemNumber(%sel, start=%n)
print %k:nameByNumber(%n)
 
%n = %k:findPreviousItemNumber(EQ(this, 'Leo'), start=%n)
print %k:nameByNumber(%n)
 
end
</p>
</p>
The result is:
<p class="code">&sect;Dec
&sect;Nov
&sect;Apr
</p>
</ol>
==See also==
==See also==
<ul><li><var>[[FindPreviousItemNumber_(GenericNamedArraylist_function)|FindPreviousItemNumber]]</var> is identical to <var>FindNextItemNumber</var> except that it searches backward in the <var>FloatNamedArraylist</var>, <var>NamedArraylist</var> or <var>UnicodeNamedArraylist</var>.</ul>
{{Template:GenericNamedArraylist:FindNextItemNumber footer}}
{{Template:GenericNamedArraylist:FindNextItemNumber footer}}

Latest revision as of 21:16, 7 August 2012

Item number of next item that matches some selection criteria (FloatNamedArraylist, NamedArraylist, and UnicodeNamedArraylist classes)


FindNextItemNumber searches "forward" in a FloatNamedArraylist, NamedArraylist, or UnicodeNamedArraylist 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.

Syntax

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

Syntax terms

%number A numeric variable to contain the item number of the item that is located by the search.
anyNal The FloatNamedArraylist, NamedArraylist or UnicodeNamedArraylist method object.
selectionCriterion A SelectionCriterion object, which is a relational expression that is applied to a anyNal 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 value 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 anyNal declaration and that returns a numeric or string value. This is described further in "Specifying a SelectionCriterion's parameters".

Start The number of the item after which to begin the search. If the 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, NamedArraylist or UnicodeNamedArraylist. For an array list of three items, number may be 0, 1, 2, or 3.

This is an optional, name required, argument which 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 FloatNamedArraylist, NamedArraylist or UnicodeNamedArraylist, the request is cancelled. If the value of Start is equal to the number of items, then FindNextItemNumber returns a zero.
  • FindNextItemNumber is available in Sirius Mods Version 7.6 and later.

Examples

  1. In the following fragment, two FindNextItemNumber calls and one FindPreviousItemNumber call are applied to a collection of objects of the staff class that is defined in the request in the "FindNextItem Examples" section:

    %old is namedArraylist of object staff %old = new %old('Jim') = newf('Red', 'employed') %old('Jed') = newf('Black', 'retired') %old('Jan') = newf('Green', 'employed') %old('Jud') = newf('Brown', 'retired') %old('Jon') = newf('White', 'retired') %sel1 is object selectioncriterion for object staff %sel2 is object selectioncriterion for object staff %n is float %sel1 = gt(name, 'Mud') %sel2 = and(gt(name, 'Mud'), eq(status, 'retired')) %n = %old:findNextItemNumber(%sel1, start=1) print %old:nameByNumber(%n) %n = %old:findNextItemNumber(%sel2) print %old:nameByNumber(%n) %n = %old:findPreviousItemNumber(lt(name, 'Mud'), start=%n) print %old:nameByNumber(%n)

    The result is:

    Jim Jon Jed

  2. The following request contains two FindNextItemNumber calls and one FindPreviousItemNumber call:

    begin %k is unicodeNamedArraylist of longstring %k = new %k('&sect;Jan':u) = 'Orion' %k('&sect;Apr':u) = 'Leo' %k('&sect;Mar':u) = 'Cancer' %k('&sect;Jun':u) = 'Ursa Minor' %k('&sect;Nov':u) = 'Andromeda' %k('&sect;Dec':u) = 'Aries' %k('&sect;Feb':u) = 'Canis Major' %sel is object selectionCriterion for longstring %n is float %sel = LT(this, 'C') %n = %k:findNextitemNumber(%sel) print %k:nameByNumber(%n) %n = %k:findNextItemNumber(%sel, start=%n) print %k:nameByNumber(%n) %n = %k:findPreviousItemNumber(EQ(this, 'Leo'), start=%n) print %k:nameByNumber(%n) end

    The result is:

    §Dec §Nov §Apr

See also

  • FindPreviousItemNumber is identical to FindNextItemNumber except that it searches backward in the FloatNamedArraylist, NamedArraylist or UnicodeNamedArraylist.