SNAPLIMD parameter: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (link repair)
 
(18 intermediate revisions by 5 users not shown)
Line 1: Line 1:
0 or max number of occurrences of any particular snap
{{Template:SNAPLIMD parameter subtitle}}
 
==Summary==
==Summary==
<dl>
<dl>
Line 11: Line 12:
<dd>All
<dd>All
<dt>Introduced
<dt>Introduced
<dd><var class="product">Sirius Mods</var> 8.1 (and by zap in 8.0)
<dd><var class="product">[[Sirius Mods]]</var> 8.1
</dl>
</dl>
==Description==
==Description==
This parameter limits the number of snaps which can be issued with any given snap title.  That is, it prevents some bug from using up the snaps available as specified by the <var>SNAPLIM</var> parameter.
This parameter limits the number of snaps which can be issued with any given snap title.  That is, it prevents some bug from using up the snaps available as specified by the <var>[[SNAPLIM parameter|SNAPLIM]]</var> parameter. The minimum value of <var>SNAPLIMD</var> is 0, which indicates that there is no limit (other than <var>SNAPLIM</var>, of course) to the number of snaps for any given snap title, and the maximum value is 32767.  The default value is 3.


The <code>*SNAP</code> snap title is not subject to <var>SNAPLIMD</var>, thus:
===Usage notes===
<ul>
<ul>
<li>When the <var>*SNAP</var> command is issued, each snap thus created is considered unique, and will not be suppressed due to <var>SNAPLIMD</var>.
<li>The <code>*SNAP</code> snap title is not subject to <var>SNAPLIMD</var>, thus, whenever either the <var>[[*SNAP command|*SNAP]]</var> or <var>[[SIRIUS command#SNAPLMOD|SIRIUS SNAPLMOD]]</var>
<li>When the <var>BUMPSNAP</var> command is issued, each snap thus created is considered unique, and will not be suppressed due to <var>SNAPLIMD</var>.
command is issued, each snap thus created is considered unique, and will not be suppressed due to <var>SNAPLIMD</var>. </li>
</ul>
 
<li>When the <var>[[BUMPSNAP command|BUMPSNAP]]</var> command is issued, each snap thus created is considered unique, and will not be suppressed due to <var>SNAPLIMD</var>. </li>
 
<li>When the value of <var>SNAPLIMD</var> is greater than 0, the overall count of snaps (that is, the value of the <var>[[SNAPID_parameter|SNAPID]]</var> parameter) and the count for
each snap title reflect snaps that were <b>actually generated</b>; snaps which are suppressed either due to <var>SNAPLIM</var>
or <var>SNAPLIMD</var> do not increment those counts.
<p>
One useful consequence of this is that, as long as <var>SNAPLIMD</var> had not been zero whenever any snaps occurred,
you can be sure that <var>SNAPID</var> will always be less than or equal to the value of <var>SNAPLIM</var>, and so, to
increase <var>SNAPLIM</var> to generate an additional snap, you can simply:
</p>
<p class="code">RESET SNAPLIM 1+ </p>
<p>
Note that if you want to effectively <b>disable</b> the "duplicate elimination" feature of <var>SNAPLIMD</var> (but why would you?) but   
keep this benefit, you can: </p>
<p class="code">R SNAPLIMD 32767 </p>
<p>
(Any smaller big number will have the same effect, and makes no difference.) </p></li>
 
<li>When the value of <var>SNAPLIMD</var> is 0, the value of the <var>SNAPID</var> parameter is incremented for each snap
whether it is generated or suppressed, but the count for each
each snap title reflects only snaps that were actually generated. </li>
 
<li>If <var>SNAPLIMD</var> is (and has always been) greater than 0 (and so is used to limit duplicate snaps),
to generate additional snaps for those which have already reached the value of <var>SNAPLIMD</var>, you can increase its value, for example:
<p class="code">RESET SNAPLIMD 3+ </p>
<p>
In order to generate these additional snaps, of course, you may also need to increase the value of the <var>SNAPLIM</var> parameter. </p></li>
 
<li>The <var>[[RESET_command|RESET]]</var> examples above use the feature described in [[Relative values for Model 204 numeric parameters]]. </li>


Note that
<li>The table of snap titles used by the <var>SNAPLIMD</var> parameter can be viewed or re-initialized using the <var>[[SNAPLIMD command|SNAPLIMD]]</var> command. </li>
<ul>
<li>When a snap is suppressed due to exceeding the <var>SNAPLIM</var> parameter, the <var>SNAPID</var> parameter is incremented.
<li>If that is not the case (that is, if the <var>SNAPLIM</var> parameter is less than the <var>SNAPID</var> parameter), if there have already been at least as many snaps <b>actually produced</b> for the given snap title as the value of the <var>SNAPLIMD</var> parameter:
<ul>
<li>The snap is suppressed and the <var>SNAPID</var> parameter is <b>not</b> incremented (otherwise, the purpose of <var>SNAPLIMD</var> would be circumvented).
</ul>
</ul>
</ul>
To suppress the action due to <var>SNAPLIMD</var>, set it to 0.  Note that when it is 0 it does not prevent snaps from occurring, but it still counts snaps for each snap title, so if you subsequently change it to a positive value, the next snap for any given snap title will be suppressed if the number of occurrences of that snap had already been as large as the new <var>SNAPLIMD</var>.


To capture additional snaps for those which have already reached the value of <var>SNAPLIMD</var>, you can increase its value, for example:
<p class="code">RESET SNAPLIMD +3</p> (See the [[??]].)
[[Category:System parameters]]
[[Category:System parameters]]
[[Category:Parameters]]
[[Category:Parameters]]

Latest revision as of 21:02, 26 April 2018

0 or max number of occurrences of any particular snap

Summary

Default value
3
Parameter type
System
Where set
System manager resettable
Related products
All
Introduced
Sirius Mods 8.1

Description

This parameter limits the number of snaps which can be issued with any given snap title. That is, it prevents some bug from using up the snaps available as specified by the SNAPLIM parameter. The minimum value of SNAPLIMD is 0, which indicates that there is no limit (other than SNAPLIM, of course) to the number of snaps for any given snap title, and the maximum value is 32767. The default value is 3.

Usage notes

  • The *SNAP snap title is not subject to SNAPLIMD, thus, whenever either the *SNAP or SIRIUS SNAPLMOD command is issued, each snap thus created is considered unique, and will not be suppressed due to SNAPLIMD.
  • When the BUMPSNAP command is issued, each snap thus created is considered unique, and will not be suppressed due to SNAPLIMD.
  • When the value of SNAPLIMD is greater than 0, the overall count of snaps (that is, the value of the SNAPID parameter) and the count for each snap title reflect snaps that were actually generated; snaps which are suppressed either due to SNAPLIM or SNAPLIMD do not increment those counts.

    One useful consequence of this is that, as long as SNAPLIMD had not been zero whenever any snaps occurred, you can be sure that SNAPID will always be less than or equal to the value of SNAPLIM, and so, to increase SNAPLIM to generate an additional snap, you can simply:

    RESET SNAPLIM 1+

    Note that if you want to effectively disable the "duplicate elimination" feature of SNAPLIMD (but why would you?) but keep this benefit, you can:

    R SNAPLIMD 32767

    (Any smaller big number will have the same effect, and makes no difference.)

  • When the value of SNAPLIMD is 0, the value of the SNAPID parameter is incremented for each snap whether it is generated or suppressed, but the count for each each snap title reflects only snaps that were actually generated.
  • If SNAPLIMD is (and has always been) greater than 0 (and so is used to limit duplicate snaps), to generate additional snaps for those which have already reached the value of SNAPLIMD, you can increase its value, for example:

    RESET SNAPLIMD 3+

    In order to generate these additional snaps, of course, you may also need to increase the value of the SNAPLIM parameter.

  • The RESET examples above use the feature described in Relative values for Model 204 numeric parameters.
  • The table of snap titles used by the SNAPLIMD parameter can be viewed or re-initialized using the SNAPLIMD command.
Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=SNAPLIMD_parameter&oldid=115023"