LoadParameterInfo (XmlDoc subroutine) - Revision history

JAL: /* Examples */

2014-03-03T20:42:05Z

Examples

← Older revision		Revision as of 20:42, 3 March 2014
Line 61:		Line 61:
	</parameter>		</parameter>
	</p>		</p>
	<b>Note:</b>		<p class="note"><b>Note:</b>
	The above result displays the <var>XmlDoc</var> format from a <var class="product">[[Sirius Mods]]</var> Version 7.6 request. Prior to Version 7.6, the parameter name was the name of a document <var>Element</var>, and the parameter description was the <var>Element</var>'s text.		The above result displays the <var>XmlDoc</var> format from a <var class="product">[[Sirius Mods]]</var> Version 7.6 request. Prior to Version 7.6, the parameter name was the name of a document <var>Element</var>, and the parameter description was the <var>Element</var>'s text. </p>

	==See also==		==See also==
	{{Template:XmlDoc:LoadParameterInfo footer}}		{{Template:XmlDoc:LoadParameterInfo footer}}

JAL2 at 15:54, 1 June 2011

2011-06-01T15:54:04Z

← Older revision		Revision as of 15:54, 1 June 2011
Line 1:		Line 1:
	{{Template:XmlDoc:LoadParameterInfo subtitle}}		{{Template:XmlDoc:LoadParameterInfo subtitle}}
	<var>LoadParameterInfo</var> loads an <var>XmlDoc</var> with information about <var class="product">Model 204</var> parameters in Rocket and Sirius products. A "pattern" argument lets you select parameters		<var>LoadParameterInfo</var> loads an <var>XmlDoc</var> with information about <var class="product">Model 204</var> parameters in Rocket M204 and Sirius products. A "pattern" argument lets you select parameters
	from one or both product families.		from one or both product families.

	This method is primarily intended for User Language products delivered by Sirius Software, and the schema of the returned document may change from release to release.		This method is primarily intended for <var class="product">User Language</var> products delivered by Sirius Software, and the schema of the returned document may change from release to release.

	==Syntax==		==Syntax==
Line 37:		Line 37:

	==Examples==		==Examples==
	~~<ol><li>~~		The following request displays all Sirius parameters beginning with <code>A</code> and resettable by the system manager. The <var>[[SelectNodes_(XmlDoc/XmlNode_function)\|SelectNodes]]</var> method finds the <code>reset</code> nodes that have <code>System manager</code> descendants; the <var>Print</var> method displays the parents of those found nodes:
	The following request displays all Sirius parameters beginning with <code>A</code> and resettable by the system manager. The <var>[[SelectNodes_(XmlDoc/XmlNode_function)\|~~selectNodes~~]]</var> method finds the <code>reset</code> nodes that have <code>System manager</code> descendants; the <var>Print</var> method displays the parents of those found nodes:
	<p class="code">begin		<p class="code">begin
	%d is object xmldoc		%d is object xmldoc
Line 64:		Line 63:
	<b>Note:</b>		<b>Note:</b>
	The above result displays the <var>XmlDoc</var> format from a <var class="product">[[Sirius Mods]]</var> Version 7.6 request. Prior to Version 7.6, the parameter name was the name of a document <var>Element</var>, and the parameter description was the <var>Element</var>'s text.		The above result displays the <var>XmlDoc</var> format from a <var class="product">[[Sirius Mods]]</var> Version 7.6 request. Prior to Version 7.6, the parameter name was the name of a document <var>Element</var>, and the parameter description was the <var>Element</var>'s text.
	~~</ol>~~

	==See also==		==See also==
	{{Template:XmlDoc:LoadParameterInfo footer}}		{{Template:XmlDoc:LoadParameterInfo footer}}

JALWiccan: 1 revision

2011-05-24T17:27:02Z

1 revision

← Older revision	Revision as of 17:27, 24 May 2011
(No difference)

Goff: edits, tags and links

2011-05-24T17:27:01Z

edits, tags and links

← Older revision		Revision as of 17:27, 24 May 2011
Line 63:		Line 63:
	</p>		</p>
	<b>Note:</b>		<b>Note:</b>
	The above result displays the <var>XmlDoc</var> format from a <var class="product">[[Sirius Mods~~\|"Sirius Mods"~~]]</var> Version 7.6 request. Prior to Version 7.6, the parameter name was the name of a document <var>Element</var>, and the parameter description was the <var>Element</var>'s text.		The above result displays the <var>XmlDoc</var> format from a <var class="product">[[Sirius Mods]]</var> Version 7.6 request. Prior to Version 7.6, the parameter name was the name of a document <var>Element</var>, and the parameter description was the <var>Element</var>'s text.
	</ol>		</ol>

	==See also==		==See also==
	{{Template:XmlDoc:LoadParameterInfo footer}}		{{Template:XmlDoc:LoadParameterInfo footer}}

Goff: edits, tags and links

2011-05-19T10:22:32Z

edits, tags and links

← Older revision		Revision as of 10:22, 19 May 2011
Line 1:		Line 1:
	{{Template:XmlDoc:LoadParameterInfo subtitle}}		{{Template:XmlDoc:LoadParameterInfo subtitle}}
			<var>LoadParameterInfo</var> loads an <var>XmlDoc</var> with information about <var class="product">Model 204</var> parameters in Rocket and Sirius products. A "pattern" argument lets you select parameters
	~~This method~~ loads an <var>XmlDoc</var> with information about <var class="product">Model 204</var> parameters
	in ~~CCA~~ and Sirius products.
	A "pattern" argument lets you select parameters
	from one or both product families.		from one or both product families.

	This method is primarily intended for User Language products delivered		This method is primarily intended for User Language products delivered by Sirius Software, and the schema of the returned document may change from release to release.
	by Sirius Software, and the schema of the returned document may change
	from release to release.
	==Syntax==		==Syntax==
	{{Template:XmlDoc:LoadParameterInfo syntax}}		{{Template:XmlDoc:LoadParameterInfo syntax}}
Line 14:		Line 10:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>doc</th>		<tr><th>doc</th>
	<td>An expression that points to the <var>XmlDoc</var> to contain the selected parameter information. This <var>XmlDoc</var> instance must be empty. </td></tr>		<td>An expression that points to the <var>XmlDoc</var> to contain the selected parameter information. This <var>XmlDoc</var> instance must be empty.</td></tr>
	<tr><th>paramOrFam</th>		<tr><th>paramOrFam</th>
	<td>An optional argument that is a complement of, and that may be specified before or after, the <var class="term">famOrParam</var> argument. This is a string (case ignored, leading and trailing blanks ignored, default null) that represents either of two options, which have the following forms:		<td>An optional argument that is a complement of, and that may be specified before or after, the <var class="term">famOrParam</var> argument. This is a string (case ignored, leading and trailing blanks ignored, default null) that represents either of two options, which have the following forms:
Line 21:		Line 17:
	<td>This selects, from the sources specified or implied in the method's second argument, all system parameters that match the specified pattern.		<td>This selects, from the sources specified or implied in the method's second argument, all system parameters that match the specified pattern.

	Patterns are formed using an asterisk () as a wildcard character, where the asterisk stands for one or more characters before or after a specified character string (<code>A</code> or <code>A</code>), or between two specified character strings (<code>ABC</code>). A solitary asterisk selects all parameters (qualified by <var class="term">familyString</var>).		Patterns are formed using an asterisk () as a wildcard character, where the asterisk stands for one or more characters before or after a specified character string (<code>A</code> or <code>A</code>), or between two specified character strings (<code>ABC</code>). A solitary asterisk selects all parameters (qualified by <var class="term">familyString</var>).
	If you omit the <var class="term">paramOrFam</var> argument, the default for the <var class="term">paramPattern</var> option is to select all parameters. </td></tr>		If you omit the <var class="term">paramOrFam</var> argument, the default for the <var class="term">paramPattern</var> option is to select all parameters. </td></tr>
	<tr><th>familyString</th>		<tr><th>familyString</th>
	<td>Either or both of the strings: <code>Base</code> and <code>Sirius</code>. <code>Base</code> means the <var class="product">Model 204</var> core product; <code>Sirius</code> means the Sirius-added parameters.		<td>Either, or both, of the strings: <code>Base</code> and <code>Sirius</code>. <code>Base</code> means the <var class="product">Model 204</var> core product; <code>Sirius</code> means the Sirius-added parameters.

	If you omit the <var class="term">paramOrFam</var> argument, the default for the <var class="term">familyString</var> option is to select from both <code>Base</code> and <code>Sirius</code> parameters. </td></tr>		If you omit the <var class="term">paramOrFam</var> argument, the default for the <var class="term">familyString</var> option is to select from both <code>Base</code> and <code>Sirius</code> parameters. </td></tr>
Line 35:		Line 31:

	==Usage notes==		==Usage notes==
			<ul><li>The parameters that your argument pattern selects are unsorted XML elements in <var class="term">doc</var>, the <var>XmlDoc</var> method object. The information for each parameter currently includes:
			<ul><li>As XML attributes: two or more XML attributes that specify where to locate the parameter within internal data structures, maximum and minimum values (if applicable), and possibly other parameter-specific values.
			<li>As XML child or grandchild elements: a text description of the parameter, where the parameter is set, whether it is a system or user parameter, and whether it is displayed as character, numeric, or hexadecimal.
			</ul></ul>

	~~The parameters that your argument pattern selects are unsorted XML elements~~		==Examples==
	~~in <var class~~=~~"term">doc</var>, the <var>XmlDoc</var> method object.~~		<ol><li>
	~~The information for each parameter currently includes:~~		The following request displays all Sirius parameters beginning with <code>A</code> and resettable by the system manager. The <var>[[SelectNodes_(XmlDoc/XmlNode_function)\|selectNodes]]</var> method finds the <code>reset</code> nodes that have <code>System manager</code> descendants; the <var>Print</var> method displays the parents of those found nodes:
	<ul>		<p class="code">begin
	<li>~~As XML attributes:~~		%d is object xmldoc
	~~two or more XML attributes that specify where to locate the parameter within~~		%d = new
	~~internal data structures, maximum and minimum values (if applicable),~~		%d:loadParameterInfo('A*', 'Sirius')
	~~and possibly other parameter-specific values.~~		%l object xmlNodelist
	~~<li>As XML child or grandchild elements: a text description of the parameter,~~		%l = %d:[[SelectNodes_(XmlDoc/XmlNode_function)\|selectNodes]]('//reset[.="System manager"]')
	~~where the parameter is set,~~		%i float
	~~whether it is a system or user parameter, and whether it is displayed~~		for %i from 1 to %l:count
	~~as character, numeric, or hexadecimal.~~		%l:[[Item_(XmlNodelist_function)\|item]](%i):print('..')
	~~</ul>~~		end for
			end
	~~===Example===~~

	The following request displays all Sirius parameters beginning
	with <code>A</code> and resettable by the system manager.
	The ~~SelectNodes~~ method finds the <code>reset</code> nodes that have
	<code~~><var~~>System~~</var>~~ manager</code> descendants; the Print method displays
	the parents of those found nodes:
	<p class="code">~~Begin~~
	%d is ~~Object Xmldoc~~
	%d = new
	%d:~~LoadParameterInfo~~('A*', 'Sirius')
	%l ~~Object XmlNodelist~~
	%l = %d:~~SelectNodes~~('//reset[.="System manager"]')
	%i ~~Float~~
	~~For~~ %i ~~From~~ 1 To %l:~~Count~~
	%l:~~Item~~(%i):~~Print~~('..')
	~~End For~~
	~~End~~
	</p>		</p>

	The example result follows (the long first line is wrapped for display purposes).		The example result follows (the long first line is wrapped for display purposes).
	<p class="output"><parameter name="ACTRDS" table="KZS" offset="036C"		<p class="output"><parameter name="ACTRDS" table="KZS" offset="036C"
Line 82:		Line 63:
	</p>		</p>
	<b>Note:</b>		<b>Note:</b>
	The above result displays the <var>XmlDoc</var> format from a <var class="product">Sirius Mods</var> ~~version~~ 7.6 request.		The above result displays the <var>XmlDoc</var> format from a <var class="product">[[Sirius Mods\|"Sirius Mods"]]</var> Version 7.6 request. Prior to Version 7.6, the parameter name was the name of a document <var>Element</var>, and the parameter description was the <var>Element</var>'s text.
	Prior to ~~version~~ 7.6, the parameter name was the name of a document Element,		</ol>
	and the parameter description was the Element's text.

	==See also==		==See also==
	{{Template:XmlDoc:LoadParameterInfo footer}}		{{Template:XmlDoc:LoadParameterInfo footer}}

Dme at 03:14, 18 February 2011

2011-02-18T03:14:21Z

← Older revision		Revision as of 03:14, 18 February 2011
Line 21:		Line 21:
	<td>This selects, from the sources specified or implied in the method's second argument, all system parameters that match the specified pattern.		<td>This selects, from the sources specified or implied in the method's second argument, all system parameters that match the specified pattern.

	Patterns are formed using an asterisk () as a wildcard character, where the asterisk stands for one or more characters before or after a specified character string (<tt>A</tt> or <tt>A</tt>), or between two specified character strings (<tt>ABC</tt>). A solitary asterisk selects all parameters (qualified by <var class="term">familyString</var>).		Patterns are formed using an asterisk () as a wildcard character, where the asterisk stands for one or more characters before or after a specified character string (<code>A</code> or <code>A</code>), or between two specified character strings (<code>ABC</code>). A solitary asterisk selects all parameters (qualified by <var class="term">familyString</var>).
	If you omit the <var class="term">paramOrFam</var> argument, the default for the <var class="term">paramPattern</var> option is to select all parameters. </td></tr>		If you omit the <var class="term">paramOrFam</var> argument, the default for the <var class="term">paramPattern</var> option is to select all parameters. </td></tr>
	<tr><th>familyString</th>		<tr><th>familyString</th>
	<td>Either or both of the strings: <tt>Base</tt> and <tt>Sirius</tt>. <tt>Base</tt> means the <var class="product">Model 204</var> core product; <tt>Sirius</tt> means the Sirius-added parameters.		<td>Either or both of the strings: <code>Base</code> and <code>Sirius</code>. <code>Base</code> means the <var class="product">Model 204</var> core product; <code>Sirius</code> means the Sirius-added parameters.

	If you omit the <var class="term">paramOrFam</var> argument, the default for the <var class="term">familyString</var> option is to select from both <tt>Base</tt> and <tt>Sirius</tt> parameters. </td></tr>		If you omit the <var class="term">paramOrFam</var> argument, the default for the <var class="term">familyString</var> option is to select from both <code>Base</code> and <code>Sirius</code> parameters. </td></tr>

	</table>		</table>
Line 53:		Line 53:

	The following request displays all Sirius parameters beginning		The following request displays all Sirius parameters beginning
	with <tt>A</tt> and resettable by the system manager.		with <code>A</code> and resettable by the system manager.
	The SelectNodes method finds the <tt>reset</tt> nodes that have		The SelectNodes method finds the <code>reset</code> nodes that have
	<tt><var>System</var> manager</tt> descendants; the Print method displays		<code><var>System</var> manager</code> descendants; the Print method displays
	the parents of those found nodes:		the parents of those found nodes:
	<p class="code">Begin		<p class="code">Begin
Line 82:		Line 82:
	</p>		</p>
	<b>Note:</b>		<b>Note:</b>
	The above result displays the <var>XmlDoc</var> format from a <var class="product">Sirius Mods</var> ~~&Vsn.~~ 7.6 request.		The above result displays the <var>XmlDoc</var> format from a <var class="product">Sirius Mods</var> version 7.6 request.
	Prior to version 7.6, the parameter name was the name of a document Element,		Prior to version 7.6, the parameter name was the name of a document Element,
	and the parameter description was the Element's text.		and the parameter description was the Element's text.

Dme at 03:10, 18 February 2011

2011-02-18T03:10:57Z

New page

{{Template:XmlDoc:LoadParameterInfo subtitle}}

This method loads an <var>XmlDoc</var> with information about <var class="product">Model 204</var> parameters
in CCA and Sirius products.
A "pattern" argument lets you select parameters
from one or both product families.

This method is primarily intended for User Language products delivered
by Sirius Software, and the schema of the returned document may change
from release to release.
==Syntax==
{{Template:XmlDoc:LoadParameterInfo syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>doc</th>
<td>An expression that points to the <var>XmlDoc</var> to contain the selected parameter information. This <var>XmlDoc</var> instance must be empty. </td></tr>
<tr><th>paramOrFam</th>
<td>An optional argument that is a complement of, and that may be specified before or after, the <var class="term">famOrParam</var> argument. This is a string (case ignored, leading and trailing blanks ignored, default null) that represents either of two options, which have the following forms:
<table class="syntaxNested">
<tr><th>paramPattern</th>
<td>This selects, from the sources specified or implied in the method's second argument, all system parameters that match the specified pattern.

Patterns are formed using an asterisk (*) as a wildcard character, where the asterisk stands for one or more characters before or after a specified character string (<tt>A*</tt> or <tt>*A</tt>), or between two specified character strings (<tt>A*BC</tt>). A solitary asterisk selects all parameters (qualified by <var class="term">familyString</var>).
If you omit the <var class="term">paramOrFam</var> argument, the default for the <var class="term">paramPattern</var> option is to select all parameters. </td></tr>
<tr><th>familyString</th>
<td>Either or both of the strings: <tt>Base</tt> and <tt>Sirius</tt>. <tt>Base</tt> means the <var class="product">Model 204</var> core product; <tt>Sirius</tt> means the Sirius-added parameters.

If you omit the <var class="term">paramOrFam</var> argument, the default for the <var class="term">familyString</var> option is to select from both <tt>Base</tt> and <tt>Sirius</tt> parameters. </td></tr>

</table>
</td></tr>
<tr><th>famOrParam</th>
<td>An optional argument that is a complement of, and that may be specified before or after, the <var class="term">paramOrFam</var> argument. This argument has the same constituent options as <var class="term">paramOrFam</var>, and it is interpreted as the alternative option type of the one you specify in <var class="term">paramOrFam</var>.</td></tr>
</table>

==Usage notes==

The parameters that your argument pattern selects are unsorted XML elements
in <var class="term">doc</var>, the <var>XmlDoc</var> method object.
The information for each parameter currently includes:
<ul>
<li>As XML attributes:
two or more XML attributes that specify where to locate the parameter within
internal data structures, maximum and minimum values (if applicable),
and possibly other parameter-specific values.
<li>As XML child or grandchild elements: a text description of the parameter,
where the parameter is set,
whether it is a system or user parameter, and whether it is displayed
as character, numeric, or hexadecimal.
</ul>

===Example===

The following request displays all Sirius parameters beginning
with <tt>A</tt> and resettable by the system manager.
The SelectNodes method finds the <tt>reset</tt> nodes that have
<tt><var>System</var> manager</tt> descendants; the Print method displays
the parents of those found nodes:
<p class="code">Begin
%d is Object Xmldoc
%d = new
%d:LoadParameterInfo('A*', 'Sirius')
%l Object XmlNodelist
%l = %d:SelectNodes('//reset[.="System manager"]')
%i Float
For %i From 1 To %l:Count
%l:Item(%i):Print('..')
End For
End
</p>

The example result follows (the long first line is wrapped for display purposes).
<p class="output"><parameter name="ACTRDS" table="KZS" offset="036C"
looseMin="-32,768" looseMax="32,767">
<description>ACTIVE RSA SUBTASKS</description>
<reset additional="EXEC PARM and User 0">
System manager
</reset>
<viewClass>system</viewClass>
<displayType>numeric</displayType>
</parameter>
</p>
<b>Note:</b>
The above result displays the <var>XmlDoc</var> format from a <var class="product">Sirius Mods</var> &Vsn. 7.6 request.
Prior to version 7.6, the parameter name was the name of a document Element,
and the parameter description was the Element's text.

==See also==
{{Template:XmlDoc:LoadParameterInfo footer}}

Wiccan: 1 revision

2011-02-08T16:43:33Z

1 revision

← Older revision	Revision as of 16:43, 8 February 2011
(No difference)

Dme: /* Example */

2011-02-08T16:43:32Z

Example

← Older revision		Revision as of 16:43, 8 February 2011
Line 20:		Line 20:
	<tr><th>paramPattern</th>		<tr><th>paramPattern</th>
	<td>This selects, from the sources specified or implied in the method's second argument, all system parameters that match the specified pattern.		<td>This selects, from the sources specified or implied in the method's second argument, all system parameters that match the specified pattern.
	~~<p class="code">~~Patterns are formed using an asterisk () as a wildcard character, where the asterisk stands for one or more characters before or after a specified character string (<tt>A</tt> or <tt>A</tt>), or between two specified character strings (<tt>ABC</tt>). A solitary asterisk selects all parameters (qualified by ''family<var>String</var>'').
			Patterns are formed using an asterisk () as a wildcard character, where the asterisk stands for one or more characters before or after a specified character string (<tt>A</tt> or <tt>A</tt>), or between two specified character strings (<tt>ABC</tt>). A solitary asterisk selects all parameters (qualified by ''family<var>String</var>'').
	If you omit the ''paramOrFam'' argument, the default for the ''paramPattern'' option is to select all parameters. </td></tr>		If you omit the ''paramOrFam'' argument, the default for the ''paramPattern'' option is to select all parameters. </td></tr>
	~~</p>~~
	<tr><th>family<var>String</var></th>		<tr><th>family<var>String</var></th>
	<td>Either or both of the strings: <tt>Base</tt> and <tt>Sirius</tt>. <tt>Base</tt> means the ''Model 204'' core product; <tt>Sirius</tt> means the Sirius-added parameters.		<td>Either or both of the strings: <tt>Base</tt> and <tt>Sirius</tt>. <tt>Base</tt> means the ''Model 204'' core product; <tt>Sirius</tt> means the Sirius-added parameters.
	~~<p class="code">~~If you omit the ''paramOrFam'' argument, the default for the ''family<var>String</var>'' option is to select from both <tt>Base</tt> and <tt>Sirius</tt> parameters. </td></tr>
	~~</p>~~		If you omit the ''paramOrFam'' argument, the default for the ''family<var>String</var>'' option is to select from both <tt>Base</tt> and <tt>Sirius</tt> parameters. </td></tr>

	</table>		</table>
	</td></tr>		</td></tr>

Dme: /* Example */

2011-02-07T16:29:15Z

Example

← Older revision		Revision as of 16:29, 7 February 2011
Line 57:		Line 57:
	the parents of those found nodes:		the parents of those found nodes:
	<p class="code">Begin		<p class="code">Begin
	%d is ~~<var>~~Object~~</var>~~ Xmldoc		%d is Object Xmldoc
	%d = new		%d = new
	%d:LoadParameterInfo('A*', 'Sirius')		%d:LoadParameterInfo('A*', 'Sirius')
Line 83:		Line 83:
	Prior to version 7.6, the parameter name was the name of a document Element,		Prior to version 7.6, the parameter name was the name of a document Element,
	and the parameter description was the Element's text.		and the parameter description was the Element's text.

	==See also==		==See also==
	{{Template:XmlDoc:LoadParameterInfo footer}}		{{Template:XmlDoc:LoadParameterInfo footer}}