Rate (UserStatistics function) - Revision history

Dme: Redirected page to Rate and RatePerSecond (UserStatistics functions)

2011-04-01T13:40:24Z

Redirected page to Rate and RatePerSecond (UserStatistics functions)

← Older revision		Revision as of 13:40, 1 April 2011
Line 1:		Line 1:
	~~{{Template:UserStatistics:Rate subtitle}}~~		#REDIRECT [[Rate and RatePerSecond (UserStatistics functions)]]

	~~This function returns 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;ldquo;Final&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==~~
	~~{{Template:UserStatistics:Rate syntax}}~~
	~~===Syntax terms===~~
	~~<table class="syntaxTable">~~
	~~<tr><th><i>%num</i></th>~~
	~~<td>A numeric variable to contain the rate for the specified statistic. </td></tr>~~
	~~<tr><th><i>%ustat</i></th>~~
	~~<td>A UserStatistics object variable. </td></tr>~~
	~~<tr><th><i>%ustatOld</i></th>~~
	~~<td>An older UserStatistics object variable for the same user login as ''%ustat''. </td></tr>~~
	~~<tr><th><i>statistic</i></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>~~
	~~</table>~~
	~~==Usage notes==~~
	~~<ul>~~
	~~<li>The statistics UpdtTime(MS)~~ and ~~LongupdTime(MS) can also be specified~~
	~~without the parentheses: for example,~~
	~~UpdtTimeMs and LongUpdtimeMs, respectively.~~
	~~<li>Request statistics are not valid for the Rate method since most don't~~
	~~really make sense for this operation.~~
	~~The Request statistics for which it does make sense (CPU, for example)~~
	~~have corresponding Login statistics that return the exact same difference.~~
	~~<li>Some Login statistics (like PCPU) don't really make sense as a rate, but~~
	~~the Rate method returns 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>To get rates with a divisor other than time, use the [[Difference~~ (UserStatistics ~~function~~)~~\|Difference~~]] ~~function.~~
	~~For example:~~
	~~<p class="code">%dkrdPerDkpr = %stat:difference(%statOld, 'DKRD') / -~~
	~~%stat:difference(%statOld, 'DKPR')~~
	~~</p>~~
	~~</ul>~~
	~~==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==~~
	~~{{Template:UserStatistics:Rate footer}}~~

DmeWiccan: 1 revision

2011-03-14T20:42:32Z

1 revision

← Older revision	Revision as of 20:42, 14 March 2011
(No difference)

DmeWiccan: 1 revision

2011-03-14T20:42:30Z

1 revision

← Older revision		Revision as of 20:42, 14 March 2011
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 &ldquo;Final&rdquo;) statistic.		The Rate method reports the rate of a ''Model 204'' user [[UserStatistics class#login\|Login]] (also called &amp;ldquo;Final&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 14:		Line 14:
	{{Template:UserStatistics:Rate syntax}}		{{Template:UserStatistics:Rate syntax}}
	===Syntax terms===		===Syntax terms===
	<dl>		<table class="syntaxTable">
	<dt><i>%num</i>		<tr><th><i>%num</i></th>
	<dd>A numeric variable to contain the rate for the specified statistic.		<td>A numeric variable to contain the rate for the specified statistic. </td></tr>
	<dt><i>%ustat</i>		<tr><th><i>%ustat</i></th>
	<dd>A UserStatistics object variable.		<td>A UserStatistics object variable. </td></tr>
	<dt><i>%ustatOld</i>		<tr><th><i>%ustatOld</i></th>
	<dd>An older UserStatistics object variable for the same user login		<td>An older UserStatistics object variable for the same user login as ''%ustat''. </td></tr>
	as ''%ustat''.		<tr><th><i>statistic</i></th>
	<dt><i>statistic</i>		<td>This case-independent string contains the name of a ''Model 204'' user Login statistic. All other names return an UnknownStatistic exception.</td></tr>
	<dd>This case-independent string contains the name of a ''Model 204'' user Login statistic.		</table>
	All other names return an UnknownStatistic exception.

	</dl>
	==Usage notes==		==Usage notes==
	<ul>		<ul>

DmeWiccan: 1 revision

2011-03-14T20:42:08Z

1 revision

← Older revision	Revision as of 20:42, 14 March 2011
(No difference)

JAL at 20:42, 14 March 2011

2011-03-14T20:42:07Z

← Older revision		Revision as of 20:42, 14 March 2011
Line 1:		Line 1:
	~~<span style="font-size~~:~~120%; color:black"><b>Rate per second of specified Login statistic for two UserStatisti</b></span>~~		{{Template:UserStatistics:Rate subtitle}}
	~~[[Category:UserStatistics methods\|Rate function]]~~
	~~<!--DPL?? Category:UserStatistics methods\|Rate function: Rate per second of specified Login statistic for two UserStatisti-->~~
	~~<!--DPL?? Category:System methods\|Rate (~~UserStatistics ~~function)~~: Rate ~~per second of specified Login statistic for two UserStatisti-->~~
	~~<p>~~
	~~Rate is a member of the [[UserStatistics class]].~~
	~~</p>~~

	This function returns the difference in statistic values between one UserStatistics		This function returns the difference in statistic values between one UserStatistics
Line 11:		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 “Final”) statistic.		The Rate method reports the rate of a ''Model 204'' user [[UserStatistics class#login\|Login]] (also called &ldquo;Final&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 17:		Line 11:

	'''RatePerSecond''' is a synonym for <tt>Rate</tt>.		'''RatePerSecond''' is a synonym for <tt>Rate</tt>.
	===Syntax===		==Syntax==
	~~%num = %ustat~~:Rate~~(%ustatOld, statistic)~~		{{Template:UserStatistics:Rate syntax}}
	===Syntax terms===		===Syntax terms===
	<dl>		<dl>
Line 33:		Line 27:

	</dl>		</dl>
	===Usage ~~Notes=~~==		==Usage notes==
	<ul>		<ul>
	<li>The statistics UpdtTime(MS) and LongupdTime(MS) can also be specified		<li>The statistics UpdtTime(MS) and LongupdTime(MS) can also be specified
Line 53:		Line 47:
	</p>		</p>
	</ul>		</ul>
	===Examples===		==Examples==

	The following statement returns the rate for DKRD		The following statement returns the rate for DKRD
Line 59:		Line 53:
	<p class="code">%dkrdPerSecond = %stat:difference(%statOld, 'dkrd')		<p class="code">%dkrdPerSecond = %stat:difference(%statOld, 'dkrd')
	</p>		</p>
			==See also==
			{{Template:UserStatistics:Rate footer}}

JAL at 17:00, 28 February 2011

2011-02-28T17:00:40Z

← Older revision		Revision as of 17:00, 28 February 2011
Line 49:		Line 49:
	<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 the [[Difference (UserStatistics function)\|Difference]] function.
	For example:		For example:
	<~~pre~~>		<p class="code">%dkrdPerDkpr = %stat:difference(%statOld, 'DKRD') / -
	%dkrdPerDkpr = %stat:difference(%statOld, 'DKRD') / -		%stat:difference(%statOld, 'DKPR')
	%stat:difference(%statOld, 'DKPR')		</p>
	</~~pre~~>
	</ul>		</ul>
	===Examples===		===Examples===
Line 58:		Line 57:
	The following statement returns the rate for DKRD		The following statement returns the rate for DKRD
	over the interval from the creation of %ustatOld to the creation of %ustat:		over the interval from the creation of %ustatOld to the creation of %ustat:
	<~~pre~~>		<p class="code">%dkrdPerSecond = %stat:difference(%statOld, 'dkrd')
	%dkrdPerSecond = %stat:difference(%statOld, 'dkrd')		</p>
	</~~pre~~>

Dme at 19:57, 31 December 2010

2010-12-31T19:57:36Z

← Older revision		Revision as of 19:57, 31 December 2010
Line 1:		Line 1:
	<span style="font-size:120%; color:black"><b>Rate per second of specified Login statistic for two UserStatisti</b></span>		<span style="font-size:120%; color:black"><b>Rate per second of specified Login statistic for two UserStatisti</b></span>
	[[Category:UserStatistics methods\|Rate function]]		[[Category:UserStatistics methods\|Rate function]]
	~~[[Category:System methods]]~~
	<!--DPL?? Category:UserStatistics methods\|Rate function: Rate per second of specified Login statistic for two UserStatisti-->		<!--DPL?? Category:UserStatistics methods\|Rate function: Rate per second of specified Login statistic for two UserStatisti-->
	<!--DPL?? Category:System methods\|Rate (UserStatistics function): Rate per second of specified Login statistic for two UserStatisti-->		<!--DPL?? Category:System methods\|Rate (UserStatistics function): Rate per second of specified Login statistic for two UserStatisti-->

Admin: 1 revision

2010-12-17T20:13:42Z

1 revision

← Older revision	Revision as of 20:13, 17 December 2010
(No difference)

Dme at 19:43, 17 December 2010

2010-12-17T19:43:02Z

New page

Rate per second of specified Login statistic for two UserStatisti
[[Category:UserStatistics methods|Rate function]]
[[Category:System methods]]



Rate is a member of the [[UserStatistics class]].


This function returns 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 “Final”) 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===
%num = %ustat:Rate(%ustatOld, statistic)
===Syntax terms===
<dl>
<dt>%num
<dd>A numeric variable to contain the rate for the specified statistic.
<dt>%ustat
<dd>A UserStatistics object variable.
<dt>%ustatOld
<dd>An older UserStatistics object variable for the same user login
as ''%ustat''.
<dt>statistic
<dd>This case-independent string contains the name of a ''Model 204'' user Login statistic.
All other names return an UnknownStatistic exception.

</dl>
===Usage Notes===
<ul>
<li>The statistics UpdtTime(MS) and LongupdTime(MS) can also be specified
without the parentheses: for example,
UpdtTimeMs and LongUpdtimeMs, respectively.
<li>Request statistics are not valid for the Rate method since most don't
really make sense for this operation.
The Request statistics for which it does make sense (CPU, for example)
have corresponding Login statistics that return the exact same difference.
<li>Some Login statistics (like PCPU) don't really make sense as a rate, but
the Rate method returns 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>To get rates with a divisor other than time, use the [[Difference (UserStatistics function)|Difference]] function.
For example:
<pre>
%dkrdPerDkpr = %stat:difference(%statOld, 'DKRD') / -
%stat:difference(%statOld, 'DKPR')
</pre>
</ul>
===Examples===

The following statement returns the rate for DKRD
over the interval from the creation of %ustatOld to the creation of %ustat:
<pre>
%dkrdPerSecond = %stat:difference(%statOld, 'dkrd')
</pre>