ProcedureInfo class - Revision history

JAL: misc formatting

2017-06-20T19:24:27Z

misc formatting

← Older revision		Revision as of 19:24, 20 June 2017
Line 45:		Line 45:
	==Example==		==Example==
	The following example uses many of the <var>ProcedureInfo</var> methods:		The following example uses many of the <var>ProcedureInfo</var> methods:
	<p class="code">OPENC SIRIUS		<p class="code">OPENC SIRIUS
	b		b
	%procInfo is object procedureInfo		%procInfo is object procedureInfo
Line 52:		Line 52:

	%procList = %(procedureInfo):list(name='SSL*', in='GROUP SIRIUS')		%procList = %(procedureInfo):list(name='SSL*', in='GROUP SIRIUS')

	printText {~} = {%procList:count}		printText {~} = {%procList:count}
	%procList:sort(descending(lastUpdateTimeMilliseconds))		%procList:sort(descending(lastUpdateTimeMilliseconds))
	for %i from 1 to %procList:count		for %i from 1 to %procList:count
	%procInfo = %procList(%i)		%procInfo = %procList(%i)
	printText {%procInfo:filename:left(8)} {%procInfo:name:left(16)} {%procInfo:bytes:left(8)} -		printText {%procInfo:filename:left(8)} {%procInfo:name:left(16)} {%procInfo:bytes:left(8)} -
	{%procInfo:lastUpdateUser:left(10)} {%procInfo:lastUpdateTime}		{%procInfo:lastUpdateUser:left(10)} {%procInfo:lastUpdateTime}
	end for		end for
	end		end
	</p>		</p>
	This is a sample result:		This is a sample result:
	<p class="code">%procList:count = 7		<p class="code">%procList:count = 7
	SIRIUS SSLP-REQ 30846 ALAN 2011071509461684		SIRIUS SSLP-REQ 30846 ALAN 2011071509461684
	SIRIUS SSLP-PROCS 25888 ALAN 2011071509461681		SIRIUS SSLP-PROCS 25888 ALAN 2011071509461681
Line 84:		Line 83:
	$list equivalents. If fewer than 10% of the procedures are selected, a <var>ProcedureInfoList</var>		$list equivalents. If fewer than 10% of the procedures are selected, a <var>ProcedureInfoList</var>
	would be faster than the $list equivalent. If 5% are selected, then the <var>ProcedureInfoList</var> approach would be twice as fast. The reasons for the speed improvement are for internal technical reasons.		would be faster than the $list equivalent. If 5% are selected, then the <var>ProcedureInfoList</var> approach would be twice as fast. The reasons for the speed improvement are for internal technical reasons.
	<p class="note">'''Note:''' Because the object-oriented infrastructure is a considerably "heavier weight" than a simple unstructured $list containing procedure information, using a <var>ProcedureInfoList</var> can be a factor of 3 to 5 times slower than equivalent $list (or <var>Stringlist</var>) processing. This includes procedure list extraction and possibly sorting.		<blockquote class="note">
			<p>'''Note:''' Because the object-oriented infrastructure is a considerably "heavier weight" than a simple unstructured $list containing procedure information, using a <var>ProcedureInfoList</var> can be a factor of 3 to 5 times slower than equivalent $list (or <var>Stringlist</var>) processing. This includes procedure list extraction and possibly sorting. </p>
			<p>
	However, except for extremely large lists (more than 100,000 procedures), this is likely to be a minor cost (along the order of a few hundred milliseconds or less on a fast processor).		However, except for extremely large lists (more than 100,000 procedures), this is likely to be a minor cost (along the order of a few hundred milliseconds or less on a fast processor).
	And, for such large lists, it is quite likely that the I/O time for reading the procedure dictionary (which will be quite large and so likely to not all be in the buffer pool) will dominate.</p></li>		And, for such large lists, it is quite likely that the I/O time for reading the procedure dictionary (which will be quite large and so likely to not all be in the buffer pool) will dominate.</p>
			</blockquote>
			</li>
	</ul>		</ul>

JAL: minor formatting

2016-01-25T23:33:52Z

minor formatting

← Older revision		Revision as of 23:33, 25 January 2016
Line 1:		Line 1:
	The <var>ProcedureInfo</var> class provides information about the procedures in a procedure file or group. The class is an object-oriented alternative to		The <var>ProcedureInfo</var> class provides information about the procedures in a procedure file or group. The class is an object-oriented alternative to
	<var>$~~LSTPROC~~</var>, <var>[[$Proc_List]]</var>, <var>[[$Proc_ListG]]</var>, <var>[[$PrcLEx]]</var>, and <var>[[$PrcLExG]]</var>, and it is a more structured alternative to the <var>Stringlist</var> class <var>[[AppendProcedureList (Stringlist function)\|AppendProcedureList]]</var> method.		<var>[[$LstProc]]</var>, <var>[[$Proc_List]]</var>, <var>[[$Proc_ListG]]</var>, <var>[[$PrcLEx]]</var>, and <var>[[$PrcLExG]]</var>, and it is a more structured alternative to the <var>Stringlist</var> class <var>[[AppendProcedureList (Stringlist function)\|AppendProcedureList]]</var> method.

	A <var>ProcedureInfo</var> object provides information such as the size of a		A <var>ProcedureInfo</var> object provides information such as the size of a
Line 9:		Line 9:

	==Creating ProcedureInfo objects==		==Creating ProcedureInfo objects==

	===Using New===		===Using New===
	One way of creating a <var>ProcedureInfo</var> object is with the <var>[[New (ProcedureInfo constructor)\|New]]</var> method. <var>New</var> takes two named input parameters that indicate the name of the procedure and of its procedure file or group:		One way of creating a <var>ProcedureInfo</var> object is with the <var>[[New (ProcedureInfo constructor)\|New]]</var> method. <var>New</var> takes two named input parameters that indicate the name of the procedure and of its procedure file or group:
Line 24:		Line 25:

	The <var>List</var> method has one required, named parameter (<var>In</var> for the containing procedure file or group, and one optional, named parameter (<var>Name</var>) to identify the procedures to be returned, with wildcards allowed.		The <var>List</var> method has one required, named parameter (<var>In</var> for the containing procedure file or group, and one optional, named parameter (<var>Name</var>) to identify the procedures to be returned, with wildcards allowed.
	These wildcards are the <var class="product">~~User Language~~</var> standard, non-regex, wildcards.		These wildcards are the <var class="product">SOUL</var> standard, non-regex, wildcards.

	For example:		For example:
Line 31:		Line 32:
	%procInfoList = %(procedureInfo):List(In='MYPROCFILE', Name='MY*')		%procInfoList = %(procedureInfo):List(In='MYPROCFILE', Name='MY*')
	for %i from 1 to %procInfoList:count		for %i from 1 to %procInfoList:count
	printText {%procInfoList(%i):name} {%procInfoList(%i):bytes} {%procInfoList(%i):lastUpdateTime}		printText {%procInfoList(%i):name} {%procInfoList(%i):bytes} {%procInfoList(%i):lastUpdateTime}
	end for		end for
	</p>		</p>
Line 40:		Line 41:
	<p class="code">%procInfoList is type procedureInfoList</p>		<p class="code">%procInfoList is type procedureInfoList</p>

	'''Note:''' The keyword <var>Type</var> is required.		<p class="note">'''Note:''' The keyword <var>Type</var> is required. </p>

	==Example==		==Example==
Line 55:		Line 56:
	%procList:sort(descending(lastUpdateTimeMilliseconds))		%procList:sort(descending(lastUpdateTimeMilliseconds))
	for %i from 1 to %procList:count		for %i from 1 to %procList:count
	%procInfo = %procList(%i)		%procInfo = %procList(%i)
	printText {%procInfo:filename:left(8)} {%procInfo:name:left(16)} {%procInfo:bytes:left(8)} -		printText {%procInfo:filename:left(8)} {%procInfo:name:left(16)} {%procInfo:bytes:left(8)} -
	{%procInfo:lastUpdateUser:left(10)} {%procInfo:lastUpdateTime}		{%procInfo:lastUpdateUser:left(10)} {%procInfo:lastUpdateTime}
	end for		end for
Line 83:		Line 84:
	$list equivalents. If fewer than 10% of the procedures are selected, a <var>ProcedureInfoList</var>		$list equivalents. If fewer than 10% of the procedures are selected, a <var>ProcedureInfoList</var>
	would be faster than the $list equivalent. If 5% are selected, then the <var>ProcedureInfoList</var> approach would be twice as fast. The reasons for the speed improvement are for internal technical reasons.		would be faster than the $list equivalent. If 5% are selected, then the <var>ProcedureInfoList</var> approach would be twice as fast. The reasons for the speed improvement are for internal technical reasons.
	<p>		<p class="note">'''Note:''' Because the object-oriented infrastructure is a considerably "heavier weight" than a simple unstructured $list containing procedure information, using a <var>ProcedureInfoList</var> can be a factor of 3 to 5 times slower than equivalent $list (or <var>Stringlist</var>) processing. This includes procedure list extraction and possibly sorting.
	'''Note:''' Because the object-oriented infrastructure is a considerably "heavier weight" than a simple unstructured $list containing procedure information, using a <var>ProcedureInfoList</var> can be a factor of 3 to 5 times slower than equivalent $list (or <var>Stringlist</var>)
	processing. This includes procedure list extraction and possibly sorting.
	However, except for extremely large lists (more than 100,000 procedures), this is likely to be a minor cost (along the order of a few hundred milliseconds or less on a fast processor).		However, except for extremely large lists (more than 100,000 procedures), this is likely to be a minor cost (along the order of a few hundred milliseconds or less on a fast processor).
	And, for such large lists, it is quite likely that the I/O time for reading		And, for such large lists, it is quite likely that the I/O time for reading the procedure dictionary (which will be quite large and so likely to not all be in the buffer pool) will dominate.</p></li>
	the procedure dictionary (which will be quite large and so likely to not
	all be in the buffer pool) will dominate.</p>
	</ul>		</ul>

	==List of ProcedureInfo methods==		==List of ProcedureInfo methods==
	The [[List of ProcedureInfo methods~~\|"List of ProcedureInfo methods"~~]] contains a complete list of the class methods.		The [[List of ProcedureInfo methods]] contains a complete list of the class methods.

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

JDamon: Removed this duplicated line in the sample code: %procInfo = %procList(%i)

2014-04-17T22:53:04Z

Removed this duplicated line in the sample code: %procInfo = %procList(%i)

← Older revision		Revision as of 22:53, 17 April 2014
Line 55:		Line 55:
	%procList:sort(descending(lastUpdateTimeMilliseconds))		%procList:sort(descending(lastUpdateTimeMilliseconds))
	for %i from 1 to %procList:count		for %i from 1 to %procList:count
	~~%procInfo = %procList(%i)~~
	%procInfo = %procList(%i)		%procInfo = %procList(%i)
	printText {%procInfo:filename:left(8)} {%procInfo:name:left(16)} {%procInfo:bytes:left(8)} -		printText {%procInfo:filename:left(8)} {%procInfo:name:left(16)} {%procInfo:bytes:left(8)} -

Dme: /* Using New */

2013-02-10T18:50:22Z

Using New

← Older revision		Revision as of 18:50, 10 February 2013
Line 10:		Line 10:
	==Creating ProcedureInfo objects==		==Creating ProcedureInfo objects==
	===Using New===		===Using New===
	One way of creating a <var>ProcedureInfo</var> object is with the <var>[[New (ProcedureInfo ~~function~~)\|New]]</var> method. <var>New</var> takes two named input parameters that indicate the name of the procedure and of its procedure file or group:		One way of creating a <var>ProcedureInfo</var> object is with the <var>[[New (ProcedureInfo constructor)\|New]]</var> method. <var>New</var> takes two named input parameters that indicate the name of the procedure and of its procedure file or group:
	<p class="code">%procInfo is object procedureInfo		<p class="code">%procInfo is object procedureInfo
	...		...
Line 18:		Line 18:

	<var>New</var> returns a <var>Null</var> object if the procedure is not found.		<var>New</var> returns a <var>Null</var> object if the procedure is not found.

	===Using List===		===Using List===
	Probably the most common way of creating <var>ProcedureInfo</var> objects is using		Probably the most common way of creating <var>ProcedureInfo</var> objects is using

JAL2 at 22:34, 13 August 2012

2012-08-13T22:34:46Z

@@ Line 2: / Line 2: @@
 <var>$LSTPROC</var>, <var>[[$Proc_List]]</var>, <var>[[$Proc_ListG]]</var>, <var>[[$PrcLEx]]</var>, and <var>[[$PrcLExG]]</var>, and it is a more structured alternative to the <var>Stringlist</var> class <var>[[AppendProcedureList (Stringlist function)|AppendProcedureList]]</var> method.
-<var>ProcedureInfo</var>
+A <var>ProcedureInfo</var> object provides information such as the size of a
 objects are easily gathered into an <var>ArrayList</var>, so they offer the advantage of the sorting, finding, and subsetting facilities of collections.
 The <var>ProcedureInfo</var> class is available as of <var class="product">Sirius Mods</var> Version 7.8.
 ==Creating ProcedureInfo objects==

JAL2: /* The information accessing methods */

2012-07-22T22:11:51Z

The information accessing methods

← Older revision		Revision as of 22:11, 22 July 2012
Line 18:		Line 18:

	<tr><td><var>[[Name (ProcedureInfo function)\|Name]]</var></td>		<tr><td><var>[[Name (ProcedureInfo function)\|Name]]</var></td>
	<td>The ~~global/session~~ name ~~associated with~~ the ~~object~~.</td></tr>		<td>The name of the procedure.</td></tr>

	<tr><td><var>[[LastUpdateTime (ProcedureInfo function)\|LastUpdateTime]]</var></td>		<tr><td><var>[[LastUpdateTime (ProcedureInfo function)\|LastUpdateTime]]</var></td>

JAL2: /* The information accessing methods */

2012-06-22T14:51:10Z

The information accessing methods

← Older revision		Revision as of 14:51, 22 June 2012
Line 21:		Line 21:

	<tr><td><var>[[LastUpdateTime (ProcedureInfo function)\|LastUpdateTime]]</var></td>		<tr><td><var>[[LastUpdateTime (ProcedureInfo function)\|LastUpdateTime]]</var></td>
	<td>The time the procedure was last updated (~~YYYYMMDDHHMISSXXX~~ format).		<td>The time the procedure was last updated (user-specified format).

	<tr><td><var>[[LastUpdateTimeMilliseconds (ProcedureInfo function)\|LastUpdateTimeMilliseconds]]</var></td>		<tr><td><var>[[LastUpdateTimeMilliseconds (ProcedureInfo function)\|LastUpdateTimeMilliseconds]]</var></td>

JAL2: /* ProcedureInfo advantages */

2012-06-21T22:30:56Z

ProcedureInfo advantages

← Older revision		Revision as of 22:30, 21 June 2012
Line 109:		Line 109:
	'''Note:''' Because the object-oriented infrastructure is a considerably "heavier weight" than a simple unstructured $list containing procedure information, using a <var>ProcedureInfoList</var> can be a factor of 3 to 5 times slower than equivalent $list (or <var>Stringlist</var>)		'''Note:''' Because the object-oriented infrastructure is a considerably "heavier weight" than a simple unstructured $list containing procedure information, using a <var>ProcedureInfoList</var> can be a factor of 3 to 5 times slower than equivalent $list (or <var>Stringlist</var>)
	processing. This includes procedure list extraction and possibly sorting.		processing. This includes procedure list extraction and possibly sorting.
	However, except for extremely large lists (>100,000 procedures), this is likely to be a minor cost (along the order of a few hundred milliseconds or less on a fast processor).		However, except for extremely large lists (more than 100,000 procedures), this is likely to be a minor cost (along the order of a few hundred milliseconds or less on a fast processor).
	And, for such large lists, it is quite likely that the I/O time for reading		And, for such large lists, it is quite likely that the I/O time for reading
	the procedure dictionary (which will be quite large and so likely to not		the procedure dictionary (which will be quite large and so likely to not

JAL2: /* Example */

2012-06-21T22:29:39Z

Example

← Older revision		Revision as of 22:29, 21 June 2012
Line 79:		Line 79:
	%procInfo = %procList(%i)		%procInfo = %procList(%i)
	%procInfo = %procList(%i)		%procInfo = %procList(%i)
	printText {%procInfo:filename:left(8)} {%procInfo:~~firstPageNumber~~:left(10)} {%procInfo:~~name~~:left(24)} -		printText {%procInfo:filename:left(8)} {%procInfo:name:left(16)} {%procInfo:bytes:left(8)} -
	~~{%procInfo:bytes:left(8)}~~ {%procInfo:lastUpdateUser:left(10)} {%procInfo:lastUpdateTime}		{%procInfo:lastUpdateUser:left(10)} {%procInfo:lastUpdateTime}
	end for		end for
	end		end
Line 86:		Line 86:
	This is a sample result:		This is a sample result:
	<p class="code">%procList:count = 7		<p class="code">%procList:count = 7
	SIRIUS ~~04000773~~ SSLP-REQ 30846 ALAN 2011071509461684		SIRIUS SSLP-REQ 30846 ALAN 2011071509461684
	SIRIUS ~~0400076E~~ SSLP-PROCS 25888 ALAN 2011071509461681		SIRIUS SSLP-PROCS 25888 ALAN 2011071509461681
	SIRIUS ~~04000593~~ SSLP-SIGN 22908 ALAN 2008062010244706		SIRIUS SSLP-SIGN 22908 ALAN 2008062010244706
	SIRIUS ~~04000259~~ SSLP-RECV 25827 ALAN 2008062010244218		SIRIUS SSLP-RECV 25827 ALAN 2008062010244218
	SIRIUS ~~040002AB~~ SSLP-FILES 7201 ALAN 2008062010243551		SIRIUS SSLP-FILES 7201 ALAN 2008062010243551
	SIRIUS ~~04000237~~ SSLN-START 10115 ALAN 2008062010243273		SIRIUS SSLN-START 10115 ALAN 2008062010243273
	SIRIUS ~~04000566~~ SSLN-END 3632 ALAN 2008062010242969		SIRIUS SSLN-END 3632 ALAN 2008062010242969
	</p>		</p>

JAL2: /* The information accessing methods */

2012-06-21T22:20:47Z

The information accessing methods

← Older revision		Revision as of 22:20, 21 June 2012
Line 16:		Line 16:
	<tr><td><var>[[Filename (ProcedureInfo function)\|Filename]]</var></td>		<tr><td><var>[[Filename (ProcedureInfo function)\|Filename]]</var></td>
	<td>The name of the file that contains the procedure. </td></tr>		<td>The name of the file that contains the procedure. </td></tr>

	~~<tr><td><var>[[FirstPageNumber (ProcedureInfo function)\|FirstPageNumber]]</var></td>~~
	~~<td>The internal page number of the first page of the procedure; intended for debugging. </td></tr>~~

	<tr><td><var>[[Name (ProcedureInfo function)\|Name]]</var></td>		<tr><td><var>[[Name (ProcedureInfo function)\|Name]]</var></td>