ToString (UserStatistics function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
{{Template:UserStatistics:ToString subtitle}}
{{Template:UserStatistics:ToString subtitle}}
<var>ToString</var> returns the values of the statistics in the method <var>UserStatistics</var> object.  By default, it will only return statistics with non-zero values; but, optionally, it may return all (including zero) statistics.
<var>ToString</var> returns the values of the statistics in the method <var>UserStatistics</var> object.  By default, it will only return statistics with non-zero values; but, as an option, it may return all (including zero) statistics.


==Syntax==
==Syntax==
{{Template:UserStatistics:ToString syntax}}
{{Template:UserStatistics:ToString syntax}}
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%string</th>
<tr><th>%string</th>
<td>A <var>longstring</var> variable to receive the listing of the values of the statistics. </td></tr>
<td>A <var>[[Longstrings|longstring]]</var> variable to receive the listing of the values of the statistics. </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><var>Zeros</var></th>
<tr><th><var>Zeros</var></th>
<td>This <var>[[Methods#Named parameters|NameRequired]]</var> argument (<var>Zeros</var>) is a <var>[[Enumerations#Using Boolean enumerations|Boolean]]</var> value that indicates whether statistics with a zero value should be included in the returned data. <var>Zeros</var> is an optional argument that defaults to <var>False</var>, which results in the inclusion of only statistics with non-zero values.</td></tr>
<td>This [[Notation conventions for methods#Named parameters|name required]] argument is a <var>[[Enumerations#Using Boolean enumerations|Boolean]]</var> value that indicates whether statistics with a zero value should be included in the returned data. <var>Zeros</var> is an optional argument that defaults to <var>False</var>, which results in the inclusion of only statistics with non-zero values.</td></tr>
 
<tr><th><var>NamesToLower</var></th>
<tr><th><var>NamesToLower</var></th>
<td>This <var>NameRequired</var> argument is a <var>Boolean</var> value that indicates whether the returned <var class="product">Model 204</var> statistic names, which are normally all-uppercase, should be returned as lowercase. This is an optional argument which defaults to <var>False</var>.</td></tr>
<td>This name required argument is a <var>Boolean</var> value that indicates whether the returned <var class="product">Model 204</var> statistic names, which are normally all-uppercase, should be returned as lowercase. This is an optional argument which defaults to <var>False</var>.</td></tr>
</table>
</table>


==Usage notes==
==Usage notes==
<ul>
<ul>
<li><var>ToString</var> can be applied implicitly: simply Print (or Audit) an object variable, and the <var>ToString</var> method is automatically applied to the object. That is:
<li><var>ToString</var> can be applied implicitly: simply <var>Print</var> (or <var>Audit</var>) an object variable, and the <var>ToString</var> method is automatically applied to the object. That is:
<p class="code">print %statobject</p> is equivalent to: <p class="code">print %statobject:ToString</p>
<p class="code">print %statobject</p> is equivalent to: <p class="code">print %statobject:ToString</p>
</ul>
</ul>


==Examples==
==Examples==
The following display of non-zero <var>[[UserStatistics class#login|Login]]</var> and <var>[[UserStatistics class#request|Request]]</var> statistics is produced by a
The following display of non-zero [[UserStatistics class#login|Login]] and [[UserStatistics class#request|Request]] statistics is produced by a
<p class="code">print %ustat</p>
<p class="code">print %ustat</p> statement:
statement.  The output line wrapping is altered for display purposes.
<p class="output">time='20080730102646772' userNumber=6 loginTime='20080730102645880' login: cnct=1 sqrd=29 sqwr=4 sgmto=27 cpu=890 -
<p class="output">time='20080730102646772' userNumber=6 loginTime='20080730-
req=1 move=97 slic=71 audit=32 dkar=253 dkpr=124751 pcpu=996 objswap=250247 request: ntbl=10 qtbl=29 stbl=524 vtbl=51 pdl=508 cnct=1 -
102645880' login: cnct=1 sqrd=29 sqwr=4 sgmto=27 cpu=890 -
cpu=887 out=1 slic=71 pcpu=996 rqtm=889 dkpr=124750 objswap=250247
req=1 move=97 slic=71 audit=32 dkar=253 dkpr=124751 pcpu=-
996 objswap=250247 request: ntbl=10 qtbl=29 stbl=524 vtbl-
=51 pdl=508 cnct=1 cpu=887 out=1 slic=71 pcpu=996 rqtm=88-
9 dkpr=124750 objswap=250247
</p>
</p>
A <code>print %ustat:ToString(Zeros=true)</code> statement would print all the statistics, including those with a <code>0</code> value.
A <code>print %ustat:ToString(Zeros=true)</code> statement would print all the statistics, including those with a <code>0</code> value.


==See also==
==See also==
<ul>
<ul>
<li><var>[[LoginToString (UserStatistics function)|LoginToString]]</var> returns the values of the <var>Login</var> statistics in the <var>UserStatistics</var> object.
<li><var>[[LoginToString (UserStatistics function)|LoginToString]]</var> returns the values of the Login statistics in the <var>UserStatistics</var> object.
<li><var>[[RequestToString (UserStatistics function)|RequestToString]]</var> returns the values of the <var>Request</var> statistics in the object.
 
<li><var>[[RequestToString (UserStatistics function)|RequestToString]]</var> returns the values of the Request statistics in the object.
</ul>
</ul>
{{Template:UserStatistics:ToString footer}}
{{Template:UserStatistics:ToString footer}}

Latest revision as of 22:08, 20 November 2012

Print UserStatistics values (UserStatistics class)

ToString returns the values of the statistics in the method UserStatistics object. By default, it will only return statistics with non-zero values; but, as an option, it may return all (including zero) statistics.

Syntax

%string = userStatistics:ToString[( [Zeros= boolean], [NamesToLower= boolean])]

Syntax terms

%string A longstring variable to receive the listing of the values of the statistics.
userStatistics A UserStatistics object variable.
Zeros This name required argument is a Boolean value that indicates whether statistics with a zero value should be included in the returned data. Zeros is an optional argument that defaults to False, which results in the inclusion of only statistics with non-zero values.
NamesToLower This name required argument is a Boolean value that indicates whether the returned Model 204 statistic names, which are normally all-uppercase, should be returned as lowercase. This is an optional argument which defaults to False.

Usage notes

  • ToString can be applied implicitly: simply Print (or Audit) an object variable, and the ToString method is automatically applied to the object. That is:

    print %statobject

    is equivalent to:

    print %statobject:ToString

Examples

The following display of non-zero Login and Request statistics is produced by a

print %ustat

statement:

time='20080730102646772' userNumber=6 loginTime='20080730102645880' login: cnct=1 sqrd=29 sqwr=4 sgmto=27 cpu=890 - req=1 move=97 slic=71 audit=32 dkar=253 dkpr=124751 pcpu=996 objswap=250247 request: ntbl=10 qtbl=29 stbl=524 vtbl=51 pdl=508 cnct=1 - cpu=887 out=1 slic=71 pcpu=996 rqtm=889 dkpr=124750 objswap=250247

A print %ustat:ToString(Zeros=true) statement would print all the statistics, including those with a 0 value.

See also

  • LoginToString returns the values of the Login statistics in the UserStatistics object.
  • RequestToString returns the values of the Request statistics in the object.