Difference (UserStatistics function): Difference between revisions
Jump to navigation
Jump to search
m (match syntax table to syntax template, tags and edits) |
mNo edit summary |
||
| (One intermediate revision by one other user not shown) | |||
| Line 4: | Line 4: | ||
==Syntax== | ==Syntax== | ||
{{Template:UserStatistics:Difference syntax}} | {{Template:UserStatistics:Difference 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 difference between the values of the specified statistic contained in the method object and contained in the older <var>UserStatistics</var> object. </td></tr> | <td>A numeric variable to contain the difference between the values of the specified statistic contained in the method object and the one contained in the older <var>UserStatistics</var> object. </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">userStatistics</var>.</td></tr> | <td>An older <var>UserStatistics</var> object variable for the same user login as <var class="term">userStatistics</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. | <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><li><var>Difference</var> cancels the request if it is applied to a statistic that is exclusively a [[UserStatistics class#request|"Request statistic"]]. | <ul> | ||
<li>The statistics UpdtTime(MS) and LongupdTime(MS) can also be specified without the parentheses: for example, UpdtTimeMs and LongUpdtimeMs, respectively. | <li><var>Difference</var> cancels the request if it is applied to a statistic that is exclusively a [[UserStatistics class#request|"Request statistic"]]. | ||
<li>Request statistics are not valid for <var>Difference</var> since most don't really make sense for this operation. | |||
have corresponding Login 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 statistics (like PCPU) don't really make sense as a difference but <var>Difference</var> returns a difference anyway. | |||
<li>Request statistics are not valid for <var>Difference</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 statistics (like <var>PCPU</var>) don't really make sense as a difference, but <var>Difference</var> returns a difference anyway. | |||
</ul> | </ul> | ||
==Examples== | ==Examples== | ||
The following example returns the amount of CPU a request uses and how many DKRDs it did: | |||
<p class="code">begin | <p class="code">begin | ||
%statStart is object userStatistics | %statStart is object userStatistics | ||
| Line 35: | Line 42: | ||
printText DKRDs: {%statEnd:difference(%statStart, 'DKRD')} | printText DKRDs: {%statEnd:difference(%statStart, 'DKRD')} | ||
end | end | ||
</p | </p> | ||
==See also== | ==See also== | ||
<ul><li><var>[[DifferenceToString (UserStatistics function)|DifferenceToString]]</var> returns the value differences between two <var>UserStatistics</var> objects for the Login statistics. | <ul> | ||
<li><var>[[DifferenceToString (UserStatistics function)|DifferenceToString]]</var> returns the value differences between two <var>UserStatistics</var> objects for the Login statistics. | |||
<li><var>[[DifferenceToXmlDoc (UserStatistics function)|DifferenceToXmlDoc]]</var> returns the differences to an <var>[[XmlDoc_API#The_XmlDoc_class|XmlDoc]]</var> object. | <li><var>[[DifferenceToXmlDoc (UserStatistics function)|DifferenceToXmlDoc]]</var> returns the differences to an <var>[[XmlDoc_API#The_XmlDoc_class|XmlDoc]]</var> object. | ||
</ul> | </ul> | ||
{{Template:UserStatistics:Difference footer}} | {{Template:UserStatistics:Difference footer}} | ||
Latest revision as of 21:22, 20 November 2012
Difference in login statistics (UserStatistics class)
The Difference function returns the difference in Login (also called "Final") statistic values between one UserStatistics object and another.
Syntax
%number = userStatistics:Difference( ustatOld, string) Throws UnknownStatistic
Syntax terms
| %number | A numeric variable to contain the difference between the values of the specified statistic contained in the method object and the one contained in the older UserStatistics object. |
|---|---|
| userStatistics | A UserStatistics object variable. |
| ustatOld | An older UserStatistics object variable for the same user login as userStatistics. |
| string | This case-independent string contains the name of a Model 204 user Login statistic. All other names return an UnknownStatistic exception. |
Usage notes
- Difference cancels the request if it is applied to a statistic that is exclusively a "Request statistic".
- The statistics UpdtTime(MS) and LongupdTime(MS) can also be specified without the parentheses: for example,
UpdtTimeMsandLongUpdtimeMs, respectively. - Request statistics are not valid for Difference 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.
- Some statistics (like PCPU) don't really make sense as a difference, but Difference returns a difference anyway.
Examples
The following example returns the amount of CPU a request uses and how many DKRDs it did:
begin %statStart is object userStatistics %statEnd is object userStatistics %statStart = new ... processing %statEnd = new printText CPU: {%statEnd:difference(%statStart, 'CPU')} printText DKRDs: {%statEnd:difference(%statStart, 'DKRD')} end
See also
- DifferenceToString returns the value differences between two UserStatistics objects for the Login statistics.
- DifferenceToXmlDoc returns the differences to an XmlDoc object.