UserStatistics class - Revision history

JAL: link repair

2016-09-13T18:12:47Z

link repair

JAL: remove Sys Man guide

2014-10-30T19:49:06Z

remove Sys Man guide

← Older revision		Revision as of 19:49, 30 October 2014
Line 29:		Line 29:
	that are restricted to one type or the other.		that are restricted to one type or the other.

	The ~~<i>~~[~~http://docs.rocketsoftware.com/nxt/gateway.dll/RKB6/~~system~~%20%26%20file%20management/m204_v7r4_system_manager.pdf Rocket Model 204 System Manager's Guide~~]~~</i>~~ and the <var class="product">[[SirMon]]</var> documentation are good sources of information about the		The [[Using system statistics]] topic and the <var class="product">[[SirMon]]</var> documentation are good sources of information about the
	available statistics (note that not all <var class="product">SirMon</var> statistics		available statistics (note that not all <var class="product">SirMon</var> statistics
	are included in a <var>UserStatistics</var> object).		are included in a <var>UserStatistics</var> object).
	Where they occasionally differ in spelling the name of a statistic,		Where they occasionally differ in spelling the name of a statistic,
	~~the <var class=~~"~~product~~"~~>Rocket Model 204 System Manager's Guide</var>~~ is more likely to have what the <var>UserStatistics</var>		"Using system statistics" is more likely to have what the <var>UserStatistics</var>
	methods require.		methods require.

Dme at 21:52, 27 February 2014

2014-02-27T21:52:16Z

← Older revision		Revision as of 21:52, 27 February 2014
Line 1:		Line 1:
	Intended for performance work, the <var>UserStatistics</var> class		Intended for performance work, the <var>UserStatistics</var> class
	is designed to replace <var>$Stat</var> and similar tools that return the		is designed to replace <var>[[$Stat]]</var> and similar tools that return the
	values for selected <var class="product">Model 204</var> User statistics.		values for selected <var class="product">Model 204</var> User statistics.

JAL at 00:36, 12 September 2013

2013-09-12T00:36:01Z

← Older revision		Revision as of 00:36, 12 September 2013
Line 29:		Line 29:
	that are restricted to one type or the other.		that are restricted to one type or the other.

	The <i>[http://~~www~~.rocketsoftware.com/~~m204~~/~~productsOLD~~/~~index~~/~~documentation~~/~~v7r4/M204-System-Mgr/view~~ Rocket Model 204 System Manager's Guide]</i> and the <var class="product">[[SirMon]]</var> documentation are good sources of information about the		The <i>[http://docs.rocketsoftware.com/nxt/gateway.dll/RKB6/system%20%26%20file%20management/m204_v7r4_system_manager.pdf Rocket Model 204 System Manager's Guide]</i> and the <var class="product">[[SirMon]]</var> documentation are good sources of information about the
	available statistics (note that not all <var class="product">SirMon</var> statistics		available statistics (note that not all <var class="product">SirMon</var> statistics
	are included in a <var>UserStatistics</var> object).		are included in a <var>UserStatistics</var> object).
Line 66:		Line 66:

	==List of UserStatistics methods==		==List of UserStatistics methods==
	The [[List of UserStatistics methods~~\|"List of UserStatistics methods"~~]] shows all the class methods.		The [[List of UserStatistics methods]] shows all the class methods.

	[[Category:System classes]]		[[Category:System classes]]

JAL: /* About the UserStatistics statistics */

2013-06-20T20:55:33Z

About the UserStatistics statistics

← Older revision		Revision as of 20:55, 20 June 2013
Line 29:		Line 29:
	that are restricted to one type or the other.		that are restricted to one type or the other.

	The <i>[http://www.rocketsoftware.com/m204/~~products~~/index/documentation/v7r4/M204-System-Mgr/view Rocket Model 204 System Manager's Guide]</i> and the <var class="product">[[SirMon]]</var> documentation are good sources of information about the		The <i>[http://www.rocketsoftware.com/m204/productsOLD/index/documentation/v7r4/M204-System-Mgr/view Rocket Model 204 System Manager's Guide]</i> and the <var class="product">[[SirMon]]</var> documentation are good sources of information about the
	available statistics (note that not all <var class="product">SirMon</var> statistics		available statistics (note that not all <var class="product">SirMon</var> statistics
	are included in a <var>UserStatistics</var> object).		are included in a <var>UserStatistics</var> object).

JAL at 22:39, 20 November 2012

2012-11-20T22:39:19Z

← Older revision		Revision as of 22:39, 20 November 2012
Line 1:		Line 1:
	Intended for performance work, the <var>UserStatistics</var> class		Intended for performance work, the <var>UserStatistics</var> class
	is designed to replace $~~STAT~~ and similar tools that return the		is designed to replace <var>$Stat</var> and similar tools that return the
	values for selected <var class="product">Model 204</var> User statistics.		values for selected <var class="product">Model 204</var> User statistics.

	The <var>[[New_(UserStatistics_constructor)\|New]]</var> constructor takes a snapshot of the user stat block at the time the constructor is invoked. You then use the <var>UserStatistics</var> methods		The <var>[[New_(UserStatistics_constructor)\|New]]</var> constructor takes a snapshot of the user stat block at the time the constructor is invoked. You then use the <var>UserStatistics</var> methods to extract the statistical data from the instantiated object.
	to extract the statistical data from the instantiated object.

	The <var>UserStatistics</var> class is new as of <var class="product">Sirius Mods</var> version 7.3.		The <var>UserStatistics</var> class is new as of <var class="product">Sirius Mods</var> version 7.3.
Line 13:		Line 12:
	The object holds two types of user statistics: '''Login''' and '''Request'''.		The object holds two types of user statistics: '''Login''' and '''Request'''.
	<ul>		<ul>
	<li><div id="login"></div>Login statistics (also called “Final”) are those that keep data per user since the user's most recent login. The statistics available to the <var class="product">Model 204</var> <var>$Stat</var> function, as well as the OBJSWAP statistic for <var class="product">[[Janus SOAP]]</var> objects, are valid.		<li><div id="login"></div>Login statistics (also called “Final”) are those that keep data per user since the user's most recent login. The statistics available to the <var class="product">Model 204</var> <var>$Stat</var> function, as well as the <var>OBJSWAP</var> statistic for <var class="product">[[Janus SOAP]]</var> objects, are valid.

	<li><div id="request"></div>Request statistics are a combination of:		<li><div id="request"></div>Request statistics are a combination of:
	<ul>		<ul>
	<li>Statistics that keep the		<li>Statistics that keep the current highwater marks for some work tables per user.
	current ~~high-water~~ marks for some work tables per user.		<var class="product">Model 204</var> documentation includes these with "since last" statistics.
	<var class="product">Model 204</var> documentation includes these with ~~“~~since last~~”~~ statistics.

	<li>Since last statistics, which keep data per user comprising		<li>Since last statistics, which keep data per user comprising
Line 27:		Line 25:
	</ul>		</ul>

	Login and Request statistics are not mutually exclusive.		Login and Request statistics are not mutually exclusive. Both Login and Request data are kept for some activities, so many
	Both Login and Request data are kept for some activities, so many
	statistics appear in lists of both types and are valid in all methods		statistics appear in lists of both types and are valid in all methods
	that are restricted to one type or the other.		that are restricted to one type or the other.

	The <i>[http://www.rocketsoftware.com/m204/products/index/documentation/v7r4/M204-System-Mgr/view Rocket Model 204 System Manager's Guide]</i> and the <var class="product">[[SirMon]]</var> documentation are good sources of information about the		The <i>[http://www.rocketsoftware.com/m204/products/index/documentation/v7r4/M204-System-Mgr/view Rocket Model 204 System Manager's Guide]</i> and the <var class="product">[[SirMon]]</var> documentation are good sources of information about the
	available statistics; note that not all <var class="product">SirMon</var> statistics		available statistics (note that not all <var class="product">SirMon</var> statistics
	are included in a <var>UserStatistics</var> object.		are included in a <var>UserStatistics</var> object).
	Where they occasionally differ in spelling the name of a statistic,		Where they occasionally differ in spelling the name of a statistic,
	the ''Model 204 System Manager's Guide'' is more likely to have what the <var>UserStatistics</var>		the <var class="product">Rocket Model 204 System Manager's Guide</var> is more likely to have what the <var>UserStatistics</var>
	methods require.		methods require.

Line 44:		Line 41:
	</p>		</p>

	This displays all of		This displays all of the Login statistics followed by all the Request statistics.
	the Login statistics followed by all the Request statistics.
	<br>'''Note:'''		<br>'''Note:'''
	The <var>ToString</var> method shown above can be applied implicitly:		The <var>ToString</var> method shown above can be applied implicitly:
	simply ~~print~~ or ~~audit~~ an object variable, and		simply <var>Print</var> or <var>Audit</var> an object variable, and
	the <var>ToString</var> method is automatically applied to the object.		the <var>ToString</var> method is automatically applied to the object.
	<code>Print %statObject</code> is equivalent to <code>Print %statObject:ToString</code>.		<code>Print %statObject</code> is equivalent to <code>Print %statObject:ToString</code>.

	==Example==		==Example==
	The following is a simple example that		The following is a simple example that shows how much CPU a request uses and how many <var>DKRD</var>s it did:
	shows how much CPU a request uses and how many ~~DKRDs~~ it did:
	<p class="code">b		<p class="code">b
	%statStart is object userStatistics		%statStart is object userStatistics

JAL at 21:10, 20 November 2012

2012-11-20T21:10:38Z

JAL2 at 00:36, 24 December 2011

2011-12-24T00:36:50Z

← Older revision		Revision as of 00:36, 24 December 2011
Line 5:		Line 5:
	The <var>[[New_(UserStatistics_constructor)\|New]]</var> constructor takes a snapshot of the user stat block at the time the constructor is invoked. You then use the <var>UserStatistics</var> methods		The <var>[[New_(UserStatistics_constructor)\|New]]</var> constructor takes a snapshot of the user stat block at the time the constructor is invoked. You then use the <var>UserStatistics</var> methods
	to extract the statistical data from the instantiated object.		to extract the statistical data from the instantiated object.

			The <var>UserStatistics</var> class is new as of <var class="product">Sirius Mods</var> version 7.3.

	__TOC__		__TOC__

JAL2: /* Example */

2011-12-24T00:36:33Z

Example

← Older revision		Revision as of 00:36, 24 December 2011
Line 51:		Line 51:
	The following is a simple example that		The following is a simple example that
	shows how much CPU a request uses and how many DKRDs it did:		shows how much CPU a request uses and how many DKRDs it did:
	<~~pre~~>		<p class="code">b
	b		%statStart is object userStatistics
	%statStart is object userStatistics		%statEnd is object userStatistics
	%statEnd is object userStatistics		%statStart = new
	%statStart = new		... processing
	... processing		%statEnd = new
	%statEnd = new		printText CPU: {%statEnd:[[Difference(UserStatistics function)\|difference]](%statStart, 'CPU')}
	printText CPU: {%statEnd:[[Difference(UserStatistics function)\|difference]](%statStart, 'CPU')}		printText DKRDs: {%statEnd:difference(%statStart, 'DKRD')}
	printText DKRDs: {%statEnd:difference(%statStart, 'DKRD')}		end
	end		</p>
	</~~pre~~>

	Specifying a statistic that is not a User statistic, or that is not the type		Specifying a statistic that is not a User statistic, or that is not the type
	of statistic (Login or Request) that a method calls for,		of statistic (Login or Request) that a method calls for,
	triggers an <var>[[UnknownStatistic class\|UnknownStatistic]]</var> exception.		triggers an <var>[[UnknownStatistic class\|UnknownStatistic]]</var> exception.

	~~The <var>UserStatistics</var> class is new as of <var class="product">Sirius Mods</var> version 7.3.~~

	==List of UserStatistics methods==		==List of UserStatistics methods==

JAL2 at 00:35, 24 December 2011

2011-12-24T00:35:08Z

← Older revision		Revision as of 00:35, 24 December 2011
Line 2:		Line 2:
	is designed to replace $STAT and similar tools that return the		is designed to replace $STAT and similar tools that return the
	values for selected <var class="product">Model 204</var> User statistics.		values for selected <var class="product">Model 204</var> User statistics.

	~~The methods in this class are listed in [[List of UserStatistics methods\|"List of UserStatistics methods"]].~~

	The <var>[[New_(UserStatistics_constructor)\|New]]</var> constructor takes a snapshot of the user stat block at the time the constructor is invoked. You then use the <var>UserStatistics</var> methods		The <var>[[New_(UserStatistics_constructor)\|New]]</var> constructor takes a snapshot of the user stat block at the time the constructor is invoked. You then use the <var>UserStatistics</var> methods
	to extract the statistical data from the instantiated object.		to extract the statistical data from the instantiated object.

			__TOC__

	The object holds two types of user statistics:		==About the UserStatistics statistics==
	'''Login''' and '''Request'''.		The object holds two types of user statistics: '''Login''' and '''Request'''.
	<ul>		<ul>
	<li><div id="login"></div>Login statistics (also called “Final”) are those that keep data per user since the user's most recent login. The statistics available to the <var class="product">Model 204</var> <var>$Stat</var> function, as well as the OBJSWAP statistic for <var class="product">[[Janus SOAP]]</var> objects, are valid.		<li><div id="login"></div>Login statistics (also called “Final”) are those that keep data per user since the user's most recent login. The statistics available to the <var class="product">Model 204</var> <var>$Stat</var> function, as well as the OBJSWAP statistic for <var class="product">[[Janus SOAP]]</var> objects, are valid.
Line 37:		Line 37:
	You can also view all the individual statistics contained in a <var>UserStatistics</var>		You can also view all the individual statistics contained in a <var>UserStatistics</var>
	object by applying the <var>[[ToString (UserStatistics function)\|ToString]]</var> method to it, as follows:		object by applying the <var>[[ToString (UserStatistics function)\|ToString]]</var> method to it, as follows:
	<~~pre~~>		<p class="code">Print %statObject:ToString(Zeros=true)
	Print %statObject:ToString(Zeros=true)		</p>
	</~~pre~~>

	This displays all of		This displays all of
Line 48:		Line 47:
	the <var>ToString</var> method is automatically applied to the object.		the <var>ToString</var> method is automatically applied to the object.
	<code>Print %statObject</code> is equivalent to <code>Print %statObject:ToString</code>.		<code>Print %statObject</code> is equivalent to <code>Print %statObject:ToString</code>.

			==Example==
	The following is a simple example that		The following is a simple example that
	shows how much CPU a request uses and how many DKRDs it did:		shows how much CPU a request uses and how many DKRDs it did:
Line 68:		Line 68:

	The <var>UserStatistics</var> class is new as of <var class="product">Sirius Mods</var> version 7.3.		The <var>UserStatistics</var> class is new as of <var class="product">Sirius Mods</var> version 7.3.

			==List of UserStatistics methods==
			The [[List of UserStatistics methods\|"List of UserStatistics methods"]] shows all the class methods.

	[[Category:System classes]]		[[Category:System classes]]

← Older revision		Revision as of 18:12, 13 September 2016
Line 4:		Line 4:

	The <var>[[New_(UserStatistics_constructor)\|New]]</var> constructor takes a snapshot of the user stat block at the time the constructor is invoked. You then use the <var>UserStatistics</var> methods to extract the statistical data from the instantiated object.		The <var>[[New_(UserStatistics_constructor)\|New]]</var> constructor takes a snapshot of the user stat block at the time the constructor is invoked. You then use the <var>UserStatistics</var> methods to extract the statistical data from the instantiated object.

	~~The <var>UserStatistics</var> class is new as of <var class="product">Sirius Mods</var> version 7.3.~~

	__TOC__		__TOC__
Line 12:		Line 10:
	The object holds two types of user statistics: '''Login''' and '''Request'''.		The object holds two types of user statistics: '''Login''' and '''Request'''.
	<ul>		<ul>
	<li><div id="login"></div>Login statistics (also called ~~“~~Final~~”~~) are those that keep data per user since the user's most recent login. The statistics available to the <var class="product">Model 204</var> <var>$Stat</var> function, as well as the <var>OBJSWAP</var> statistic for ~~<var class="product">~~[[~~Janus SOAP~~]]~~</var> objects~~, are valid.		<li><div id="login"></div>Login statistics (also called "Final") are those that keep data per user since the user's most recent login. The statistics available to the <var class="product">Model 204</var> <var>$Stat</var> function, as well as the <var>OBJSWAP</var> statistic for [[Object oriented programming in SOUL\|SOUL objects]], are valid.

	<li><div id="request"></div>Request statistics are a combination of:		<li><div id="request"></div>Request statistics are a combination of:
	<ul>		<ul>
	<li>Statistics that keep the current highwater marks for some work tables per user.		<li>Statistics that keep the current highwater marks for some work tables per user.
	<var class="product">Model 204</var> documentation includes these with "since last" statistics.		<var class="product">Model 204</var> documentation includes these with "since last" statistics.

	<li>Since last statistics, which keep data per user comprising		<li>Since last statistics, which keep data per user comprising
Line 30:		Line 28:

	The [[Using system statistics]] topic and the <var class="product">[[SirMon]]</var> documentation are good sources of information about the		The [[Using system statistics]] topic and the <var class="product">[[SirMon]]</var> documentation are good sources of information about the
	available statistics (note that not all <var class="product">SirMon</var> statistics		available statistics (note that not all <var class="product">SirMon</var> statistics are included in a <var>UserStatistics</var> object).
	are included in a <var>UserStatistics</var> object).
	Where they occasionally differ in spelling the name of a statistic,		Where they occasionally differ in spelling the name of a statistic,
	"Using system statistics" is more likely to have what the <var>UserStatistics</var>		"Using system statistics" is more likely to have what the <var>UserStatistics</var>
Line 42:		Line 39:

	This displays all of the Login statistics followed by all the Request statistics.		This displays all of the Login statistics followed by all the Request statistics.
	<br>'''Note:'''		<p class="note">'''Note:'''
	The <var>ToString</var> method shown above can be applied implicitly:		The <var>ToString</var> method shown above can be applied implicitly:
	simply <var>Print</var> or <var>Audit</var> an object variable, and		simply <var>Print</var> or <var>Audit</var> an object variable, and
	the <var>ToString</var> method is automatically applied to the object.		the <var>ToString</var> method is automatically applied to the object.
	<code>Print %statObject</code> is equivalent to <code>Print %statObject:ToString</code>.		<code>Print %statObject</code> is equivalent to <code>Print %statObject:ToString</code>. </p>

	==Example==		==Example==

← Older revision		Revision as of 21:10, 20 November 2012
Line 14:		Line 14:
	<ul>		<ul>
	<li><div id="login"></div>Login statistics (also called “Final”) are those that keep data per user since the user's most recent login. The statistics available to the <var class="product">Model 204</var> <var>$Stat</var> function, as well as the OBJSWAP statistic for <var class="product">[[Janus SOAP]]</var> objects, are valid.		<li><div id="login"></div>Login statistics (also called “Final”) are those that keep data per user since the user's most recent login. The statistics available to the <var class="product">Model 204</var> <var>$Stat</var> function, as well as the OBJSWAP statistic for <var class="product">[[Janus SOAP]]</var> objects, are valid.

	<li><div id="request"></div>Request statistics are a combination of:		<li><div id="request"></div>Request statistics are a combination of:
	<ul>		<ul>
Line 19:		Line 20:
	current high-water marks for some work tables per user.		current high-water marks for some work tables per user.
	<var class="product">Model 204</var> documentation includes these with “since last” statistics.		<var class="product">Model 204</var> documentation includes these with “since last” statistics.

	<li>Since last statistics, which keep data per user comprising		<li>Since last statistics, which keep data per user comprising
	only the user's most recent work unit (like compilation or evaluation);		only the user's most recent work unit (like compilation or evaluation);
Line 30:		Line 32:
	that are restricted to one type or the other.		that are restricted to one type or the other.

	The [http://www.~~cca-int~~.com/~~custsupp~~/documentation/~~catalog.html~~ Model 204 System Manager's Guide] and the <var class="product">[[SirMon]]</var> documentation are good sources of information about the		The <i>[http://www.rocketsoftware.com/m204/products/index/documentation/v7r4/M204-System-Mgr/view Rocket Model 204 System Manager's Guide]</i> and the <var class="product">[[SirMon]]</var> documentation are good sources of information about the
	available statistics; note that not all <var class="product">SirMon</var> statistics		available statistics; note that not all <var class="product">SirMon</var> statistics
	are included in a <var>UserStatistics</var> object.		are included in a <var>UserStatistics</var> object.
Line 59:		Line 61:
	... processing		... processing
	%statEnd = new		%statEnd = new
	printText CPU: {%statEnd:[[Difference(UserStatistics function)\|difference]](%statStart, 'CPU')}		printText CPU: {%statEnd:[[Difference (UserStatistics function)\|difference]](%statStart, 'CPU')}
	printText DKRDs: {%statEnd:difference(%statStart, 'DKRD')}		printText DKRDs: {%statEnd:difference(%statStart, 'DKRD')}
	end		end