Rate and RatePerSecond (UserStatistics functions) - Revision history

JAL at 21:49, 20 November 2012

2012-11-20T21:49:32Z

← Older revision		Revision as of 21:49, 20 November 2012
Line 1:		Line 1:
	{{Template:UserStatistics:Rate and RatePerSecond subtitle}}		{{Template:UserStatistics:Rate and RatePerSecond subtitle}}
	<var>Rate</var> and <var>RatePerSecond</var> are aliases for each other. They return the difference in statistic values between one <var>UserStatistics</var> object and another, divided by the number of seconds between the time the two <var>UserStatistics</var> objects were instantiated. They report the rate of a <var class="product">Model 204</var> user ~~<var>~~[[UserStatistics class#login\|Login]]~~</var>~~ (also called "Final") statistic.		<var>Rate</var> and <var>RatePerSecond</var> are aliases for each other. They return the difference in statistic values between one <var>UserStatistics</var> object and another, divided by the number of seconds between the time the two <var>UserStatistics</var> objects were instantiated. They report the rate of a <var class="product">Model 204</var> user [[UserStatistics class#login\|Login]] (also called "Final") statistic.

	==Syntax==		==Syntax==
	{{Template:UserStatistics:Rate syntax}}		{{Template:UserStatistics:Rate syntax}}
	{{Template:UserStatistics:RatePerSecond syntax}}		{{Template:UserStatistics:RatePerSecond syntax}}

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%number</th>		<tr><th>%number</th>
	<td>A numeric variable to contain the rate for the specified statistic. </td></tr>		<td>A numeric variable to contain the rate for the specified statistic. </td></tr>

	<tr><th>userStatistics</th>		<tr><th>userStatistics</th>
	<td>A <var>UserStatistics</var> object variable. </td></tr>		<td>A <var>UserStatistics</var> object variable. </td></tr>

	<tr><th>ustatOld</th>		<tr><th>ustatOld</th>
	<td>An older <var>UserStatistics</var> object variable for the same user login as <var class="term">userStaistics</var>. </td></tr>		<td>An older <var>UserStatistics</var> object variable for the same user login as <var class="term">userStaistics</var>. </td></tr>

	<tr><th>string</th>		<tr><th>string</th>
	<td>This case-independent string contains the name of a <var class="product">Model 204</var> user Login statistic. All other names return an <var>[[UnknownStatistic_class\|UnknownStatistic]]</var> exception.</td></tr>		<td>This case-independent string contains the name of a <var class="product">Model 204</var> user Login statistic. All other names return an <var>[[UnknownStatistic_class\|UnknownStatistic]]</var> exception.</td></tr>
Line 20:		Line 24:
	<ul>		<ul>
	<li><var>Rate</var> or <var>RatePerSecond</var> will cancel the request if they are applied to a statistic that is exclusively a [[UserStatistics class#request\|"Request statistic"]].		<li><var>Rate</var> or <var>RatePerSecond</var> will cancel the request if they are applied to a statistic that is exclusively a [[UserStatistics class#request\|"Request statistic"]].
	<li>The statistics UpdtTime(MS) and LongupdTime(MS) can also be specified without the parentheses: for example, UpdtTimeMs and LongUpdtimeMs, respectively.
	<li~~><var~~>Request~~</var>~~ statistics are not valid for <var>Rate</var> or <var>RatePerSecond</var>, since most don't really make sense for this operation. The ~~<var>~~Request~~</var>~~ statistics for which it does make sense (CPU, for example) have corresponding ~~<var>~~Login~~</var>~~ statistics that return the exact same difference.		<li>The statistics <var>UpdtTime(MS)</var> and <var>LongupdTime(MS)</var> can also be specified without the parentheses: for example, <code>UpdtTimeMs</code> and <code>LongUpdtimeMs</code>, respectively.
	<li>Some <var>Login</var> statistics (like PCPU) don't really make sense as a rate, but <var>Rate</var> or <var>RatePerSecond</var> will return a rate anyway.
	<li>All rates are rounded to thousandths, except for the CPU statistic. The units for CPU are milliseconds, so CPU rates are rounded to thousandths of a millisecond.		<li>Request statistics are not valid for <var>Rate</var> or <var>RatePerSecond</var>, since most don't really make sense for this operation. The Request statistics for which it does make sense (<var>CPU</var>, for example) have corresponding Login statistics that return the exact same difference.

			<li>Some <var>Login</var> statistics (like <var>PCPU</var>) don't really make sense as a rate, but <var>Rate</var> or <var>RatePerSecond</var> will return a rate anyway.

			<li>All rates are rounded to thousandths, except for the <var>CPU</var> statistic. The units for <var>CPU</var> are milliseconds, so <var>CPU</var> rates are rounded to thousandths of a millisecond.

	</ul>		</ul>

	==Examples==		==Examples==
	<ol><li>The following statement returns the rate for DKRD over the interval from the creation of %ustatOld to the creation of %ustat:		<ol><li>The following statement returns the rate for <var>DKRD</var> over the interval from the creation of <code>%ustatOld</code> to the creation of <code>%ustat</code>:
	<p class="code">%dkrdPerSecond = %ustat:rate(%ustatOld, 'dkrd')		<p class="code">%dkrdPerSecond = %ustat:rate(%ustatOld, 'dkrd')
	</p>		</p>
	<li>To get rates with a divisor other than time, use <var>[[Difference (UserStatistics function)\|Difference]]</var>. For example:
	<p class="code">%dkrdPerDkpr = %stat:difference(%statOld, 'DKRD') / -		<li>To get rates with a divisor other than time, use <var>[[Difference (UserStatistics function)\|Difference]]</var>. For example:
	%stat:difference(%statOld, 'DKPR')		<p class="code">%dkrdPerDkpr = %stat:difference(%statOld, 'DKRD') / %stat:difference(%statOld, 'DKPR')
	</p>		</p>
	</ol>		</ol>

Goff: /* Syntax terms */

2011-04-15T04:27:34Z

Syntax terms

← Older revision		Revision as of 04:27, 15 April 2011
Line 11:		Line 11:
	<tr><th>userStatistics</th>		<tr><th>userStatistics</th>
	<td>A <var>UserStatistics</var> object variable. </td></tr>		<td>A <var>UserStatistics</var> object variable. </td></tr>
	<tr><th>%ustatOld</th>		<tr><th>ustatOld</th>
	<td>An older <var>UserStatistics</var> object variable for the same user login as <var class="term">userStaistics</var>. </td></tr>		<td>An older <var>UserStatistics</var> object variable for the same user login as <var class="term">userStaistics</var>. </td></tr>
	<tr><th>string</th>		<tr><th>string</th>

Dme: /* See also */

2011-04-01T13:39:08Z

Dme at 13:34, 1 April 2011

2011-04-01T13:34:28Z

← Older revision		Revision as of 13:34, 1 April 2011
Line 1:		Line 1:
	{{Template:UserStatistics:Rate and RatePerSecond subtitle}}		{{Template:UserStatistics:Rate and RatePerSecond subtitle}}
	<var>Rate</var> and <var>RatePerSecond</var> are aliases for each other. They return the difference in statistic values between one <var>UserStatistics</var> object and another divided by the number of seconds between the time the two <var>UserStatistics</var> objects were instantiated. They report the rate of a <var class="product">Model 204</var> user <var>[[UserStatistics class#login\|Login]]</var> (also called "Final") statistic.		<var>Rate</var> and <var>RatePerSecond</var> are aliases for each other. They return the difference in statistic values between one <var>UserStatistics</var> object and another, divided by the number of seconds between the time the two <var>UserStatistics</var> objects were instantiated. They report the rate of a <var class="product">Model 204</var> user <var>[[UserStatistics class#login\|Login]]</var> (also called "Final") statistic.

	==Syntax==		==Syntax==

Goff: match syntax table to syntax template, tags and edits

2011-03-31T09:40:35Z

match syntax table to syntax template, tags and edits

← Older revision		Revision as of 09:40, 31 March 2011
Line 1:		Line 1:
	{{Template:UserStatistics:Rate and RatePerSecond subtitle}}		{{Template:UserStatistics:Rate and RatePerSecond subtitle}}
			<var>Rate</var> and <var>RatePerSecond</var> are aliases for each other. They return the difference in statistic values between one <var>UserStatistics</var> object and another divided by the number of seconds between the time the two <var>UserStatistics</var> objects were instantiated. They report the rate of a <var class="product">Model 204</var> user <var>[[UserStatistics class#login\|Login]]</var> (also called "Final") statistic.

	~~These functions, which are aliases for each other, return the difference in statistic values between one UserStatistics~~
	~~object and another divided by the number of seconds between the time~~
	~~the two UserStatistics objects were instantiated.~~

	~~The Rate method reports the rate of a ''Model 204'' user [[UserStatistics class#login\|Login]] (also called &amp;amp;amp;ldquo;Final&amp;amp;amp;rdquo;) statistic.~~
	~~The method cancels the request if it is applied to a statistic~~
	~~that is exclusively a [[UserStatistics class#request\|Request~~
	~~statistic]].~~

	~~'''RatePerSecond''' is a synonym for <tt>Rate</tt>.~~
	==Syntax==		==Syntax==
	{{Template:UserStatistics:Rate syntax}}		{{Template:UserStatistics:Rate syntax}}
Line 16:		Line 7:
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th~~><i~~>%~~num</i>~~</th>		<tr><th>%number</th>
	<td>A numeric variable to contain the rate for the specified statistic. </td></tr>		<td>A numeric variable to contain the rate for the specified statistic. </td></tr>
	<tr><th>~~<i>%ustat</i>~~</th>		<tr><th>userStatistics</th>
	<td>A UserStatistics object variable. </td></tr>		<td>A <var>UserStatistics</var> object variable. </td></tr>
	<tr><th~~><i~~>%ustatOld~~</i>~~</th>		<tr><th>%ustatOld</th>
	<td>An older UserStatistics object variable for the same user login as ~~''%ustat''~~. </td></tr>		<td>An older <var>UserStatistics</var> object variable for the same user login as <var class="term">userStaistics</var>. </td></tr>
	<tr><th>~~<i>statistic</i>~~</th>		<tr><th>string</th>
	<td>This case-independent string contains the name of a ''Model 204'' user Login statistic. All other names return an UnknownStatistic exception.</td></tr>		<td>This case-independent string contains the name of a <var class="product">Model 204</var> user Login statistic. All other names return an <var>[[UnknownStatistic_class\|UnknownStatistic]]</var> exception.</td></tr>
	</table>		</table>

	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>The statistics UpdtTime(MS) and LongupdTime(MS) can also be specified		<li><var>Rate</var> or <var>RatePerSecond</var> will cancel the request if they are applied to a statistic that is exclusively a [[UserStatistics class#request\|"Request statistic"]].
	without the parentheses: for example,		<li>The statistics UpdtTime(MS) and LongupdTime(MS) can also be specified without the parentheses: for example, UpdtTimeMs and LongUpdtimeMs, respectively.
	UpdtTimeMs and LongUpdtimeMs, respectively.		<li><var>Request</var> statistics are not valid for <var>Rate</var> or <var>RatePerSecond</var>, since most don't really make sense for this operation. The <var>Request</var> statistics for which it does make sense (CPU, for example) have corresponding <var>Login</var> statistics that return the exact same difference.
	<li>Request statistics are not valid for ~~the~~ Rate ~~method~~ since most don't		<li>Some <var>Login</var> statistics (like PCPU) don't really make sense as a rate, but <var>Rate</var> or <var>RatePerSecond</var> will return a rate anyway.
	really make sense for this operation.		<li>All rates are rounded to thousandths, except for the CPU statistic. The units for CPU are milliseconds, so CPU rates are rounded to thousandths of a millisecond.
	The Request statistics for which it does make sense (CPU, for example)
	have corresponding Login statistics that return the exact same difference.		</ul>
	<li>Some Login statistics (like PCPU) don't really make sense as a rate, but
	~~the~~ Rate ~~method returns~~ a rate anyway.		==Examples==
	<li>All rates are rounded to thousandths, except for the CPU statistic.		<ol><li>The following statement returns the rate for DKRD over the interval from the creation of %ustatOld to the creation of %ustat:
	The units for CPU are milliseconds, so		<p class="code">%dkrdPerSecond = %ustat:rate(%ustatOld, 'dkrd')
	CPU rates are rounded to thousandths of a millisecond.		</p>
	<li>To get rates with a divisor other than time, use ~~the~~ [[Difference (UserStatistics function)\|Difference]] ~~function~~.		<li>To get rates with a divisor other than time, use <var>[[Difference (UserStatistics function)\|Difference]]</var>. For example:
	For example:
	<p class="code">%dkrdPerDkpr = %stat:difference(%statOld, 'DKRD') / -		<p class="code">%dkrdPerDkpr = %stat:difference(%statOld, 'DKRD') / -
	%stat:difference(%statOld, 'DKPR')		%stat:difference(%statOld, 'DKPR')
	</p>		</p>
	</ul>		</ol>
	~~==Examples==~~

	~~The following statement returns the rate for DKRD~~
	~~over the interval from the creation of %ustatOld to the creation of %ustat:~~
	~~<p class="code">%dkrdPerSecond = %stat:difference(%statOld, 'dkrd')~~
	~~</p>~~
	==See also==		==See also==
	{{Template:UserStatistics:Rate and RatePerSecond footer}}		{{Template:UserStatistics:Rate and RatePerSecond footer}}
	{{Template:UserStatistics:Rate footer}}		{{Template:UserStatistics:Rate footer}}

DmeWiccan: 1 revision

2011-03-14T21:18:58Z

1 revision

← Older revision	Revision as of 21:18, 14 March 2011
(No difference)

Dme at 21:18, 14 March 2011

2011-03-14T21:18:57Z

← Older revision		Revision as of 21:18, 14 March 2011
Line 1:		Line 1:
	{{Template:UserStatistics:Rate subtitle}}		{{Template:UserStatistics:Rate and RatePerSecond subtitle}}

	These functions, which are aliases for each other, return the difference in statistic values between one UserStatistics		These functions, which are aliases for each other, return the difference in statistic values between one UserStatistics
Line 5:		Line 5:
	the two UserStatistics objects were instantiated.		the two UserStatistics objects were instantiated.

	The Rate method reports the rate of a ''Model 204'' user [[UserStatistics class#login\|Login]] (also called &amp;amp;ldquo;Final&amp;amp;rdquo;) statistic.		The Rate method reports the rate of a ''Model 204'' user [[UserStatistics class#login\|Login]] (also called &amp;amp;amp;ldquo;Final&amp;amp;amp;rdquo;) statistic.
	The method cancels the request if it is applied to a statistic		The method cancels the request if it is applied to a statistic
	that is exclusively a [[UserStatistics class#request\|Request		that is exclusively a [[UserStatistics class#request\|Request

Dme at 21:15, 14 March 2011

2011-03-14T21:15:56Z

← Older revision		Revision as of 21:15, 14 March 2011
Line 1:		Line 1:
	{{Template:UserStatistics:Rate ~~and RatePerSecond~~ subtitle}}		{{Template:UserStatistics:Rate subtitle}}

	These functions, which are aliases for each other, return the difference in statistic values between one UserStatistics		These functions, which are aliases for each other, return the difference in statistic values between one UserStatistics

DmeWiccan: 1 revision

2011-03-14T21:12:33Z

1 revision

← Older revision	Revision as of 21:12, 14 March 2011
(No difference)

Dme: Created page with "{{Template:UserStatistics:Rate subtitle}} These functions, which are aliases for each other, return the difference in statistic values between one UserStatistics object and anot..."

2011-03-14T21:12:33Z

Created page with "{{Template:UserStatistics:Rate subtitle}} These functions, which are aliases for each other, return the difference in statistic values between one UserStatistics object and anot..."

← Older revision		Revision as of 21:12, 14 March 2011
Line 1:		Line 1:
	{{Template:UserStatistics:Rate subtitle}}		{{Template:UserStatistics:Rate and RatePerSecond subtitle}}

	These functions, which are aliases for each other, return the difference in statistic values between one UserStatistics		These functions, which are aliases for each other, return the difference in statistic values between one UserStatistics
Line 5:		Line 5:
	the two UserStatistics objects were instantiated.		the two UserStatistics objects were instantiated.

	The Rate method reports the rate of a ''Model 204'' user [[UserStatistics class#login\|Login]] (also called &amp;ldquo;Final&amp;rdquo;) statistic.		The Rate method reports the rate of a ''Model 204'' user [[UserStatistics class#login\|Login]] (also called &amp;amp;ldquo;Final&amp;amp;rdquo;) statistic.
	The method cancels the request if it is applied to a statistic		The method cancels the request if it is applied to a statistic
	that is exclusively a [[UserStatistics class#request\|Request		that is exclusively a [[UserStatistics class#request\|Request
Line 52:		Line 52:
	</p>		</p>
	==See also==		==See also==
			{{Template:UserStatistics:Rate and RatePerSecond footer}}
	{{Template:UserStatistics:Rate footer}}		{{Template:UserStatistics:Rate footer}}

← Older revision		Revision as of 13:39, 1 April 2011
Line 39:		Line 39:
	==See also==		==See also==
	{{Template:UserStatistics:Rate and RatePerSecond footer}}		{{Template:UserStatistics:Rate and RatePerSecond footer}}
	~~{{Template:UserStatistics:Rate footer}}~~