Difference (UserStatistics function): Difference between revisions
Jump to navigation
Jump to search
No edit summary |
mNo edit summary |
||
| (9 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:UserStatistics:Difference subtitle}} | |||
[[ | The <var>Difference</var> function returns the difference in [[UserStatistics class#login|Login]] (also called "Final") statistic values between one <var>UserStatistics</var> object and another. | ||
< | |||
</ | |||
==Syntax== | |||
{{Template:UserStatistics:Difference syntax}} | |||
===Syntax terms=== | ===Syntax terms=== | ||
< | <table class="syntaxTable"> | ||
< | <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 the one contained in the older <var>UserStatistics</var> object. </td></tr> | ||
specified statistic | |||
contained in the method object and contained in the older UserStatistics object. | <tr><th>userStatistics</th> | ||
< | <td>A <var>UserStatistics</var> object variable. </td></tr> | ||
< | |||
< | <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> | ||
as | |||
< | <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> | ||
All other names return an UnknownStatistic exception. | </table> | ||
==Usage notes== | |||
<ul> | <ul> | ||
<li>The statistics UpdtTime(MS) and LongupdTime(MS) can also be specified | <li><var>Difference</var> cancels the request if it is applied to a statistic that is exclusively a [[UserStatistics class#request|"Request statistic"]]. | ||
without the parentheses: for example, | |||
UpdtTimeMs and LongUpdtimeMs, respectively. | <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>Request statistics are not valid for | |||
really make sense for this operation. | <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. | ||
The Request statistics for which it does make sense (CPU, 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. | ||
<li>Some statistics (like PCPU) don't really make sense as a difference but | |||
</ul> | </ul> | ||
The following example returns | ==Examples== | ||
the amount of CPU a request uses and how many DKRDs it did: | The following example returns the amount of CPU a request uses and how many DKRDs it did: | ||
< | <p class="code">begin | ||
%statStart is object userStatistics | |||
%statEnd is object userStatistics | |||
%statStart = new | |||
... processing | |||
%statEnd = new | |||
[[PrintText statement|printText]] CPU: {%statEnd:difference(%statStart, 'CPU')} | |||
printText DKRDs: {%statEnd:difference(%statStart, 'DKRD')} | |||
end | |||
</p> | |||
</ | |||
==See also== | |||
<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. | |||
</ul> | |||
{{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.