Parameterfile1 - Revision history

Boerner: /* Parsing logic */

2021-01-04T10:08:01Z

Parsing logic

← Older revision		Revision as of 10:08, 4 January 2021
Line 50:		Line 50:
	In the above example nested elements {{cc\|<nest_1>}} and {{cc\|<nest_2>}} maybe optional or compulsory, but both are automatic, that is {{lmt}} will evaluate them only if the are present. Element {{cc\|<x>}}, nested in element {{cc\|<nest_2>}}, is automatic and may be optional or compulsory as well. However, elements {{cc\|<y>}} and {{cc\|<z>}} are nominated and therefore compulsory. The nomination is triggered by providing key string {{cc\|other: y,z}} where the variable {{cc\|y,z}} provides a comma-separated list of names of the nominated elements. That is, after evaluating key string {{cc\|others: y,z}} {{lmt}} will search for elements {{cc\|<y>}} and {{cc\|<z>}}, and their absence will cause an error stop.		In the above example nested elements {{cc\|<nest_1>}} and {{cc\|<nest_2>}} maybe optional or compulsory, but both are automatic, that is {{lmt}} will evaluate them only if the are present. Element {{cc\|<x>}}, nested in element {{cc\|<nest_2>}}, is automatic and may be optional or compulsory as well. However, elements {{cc\|<y>}} and {{cc\|<z>}} are nominated and therefore compulsory. The nomination is triggered by providing key string {{cc\|other: y,z}} where the variable {{cc\|y,z}} provides a comma-separated list of names of the nominated elements. That is, after evaluating key string {{cc\|others: y,z}} {{lmt}} will search for elements {{cc\|<y>}} and {{cc\|<z>}}, and their absence will cause an error stop.

	Note that ~~key strings and nested elements which are not required for the task are ignored. That is,~~ non-sense and wrongly named key ~~stings~~ and elements will '''NOT''' cause an error stop as long as the parameter file content yields a sound description of the task and provides all necessary ingredients. Further, {{cc\|automatic-optional}} elements are evaluated even if they are not required for the task. This can lead to an ~~un-neccesary~~ high demand for hard-ware resources ~~like cpu-power~~ and ~~RAM~~. See [[Parameter_file_elements#.3CH.3E\|here]] for an example.		Note that non-sense and wrongly named key strings and elements will '''NOT''' cause an error stop as long as the parameter file content yields a sound description of the task and provides all necessary ingredients. Further, {{cc\|automatic-optional}} elements are evaluated even if they are not required for the task. This can lead to an unneccesary high demand for hard-ware resources and a substantially increased processing time. See [[Parameter_file_elements#.3CH.3E\|here]] for an example.

	== Group of mutually exclusive information sources ==		== Group of mutually exclusive information sources ==

Boerner: /* Parsing logic */

2021-01-04T10:06:06Z

Parsing logic

← Older revision		Revision as of 10:06, 4 January 2021
Line 50:		Line 50:
	In the above example nested elements {{cc\|<nest_1>}} and {{cc\|<nest_2>}} maybe optional or compulsory, but both are automatic, that is {{lmt}} will evaluate them only if the are present. Element {{cc\|<x>}}, nested in element {{cc\|<nest_2>}}, is automatic and may be optional or compulsory as well. However, elements {{cc\|<y>}} and {{cc\|<z>}} are nominated and therefore compulsory. The nomination is triggered by providing key string {{cc\|other: y,z}} where the variable {{cc\|y,z}} provides a comma-separated list of names of the nominated elements. That is, after evaluating key string {{cc\|others: y,z}} {{lmt}} will search for elements {{cc\|<y>}} and {{cc\|<z>}}, and their absence will cause an error stop.		In the above example nested elements {{cc\|<nest_1>}} and {{cc\|<nest_2>}} maybe optional or compulsory, but both are automatic, that is {{lmt}} will evaluate them only if the are present. Element {{cc\|<x>}}, nested in element {{cc\|<nest_2>}}, is automatic and may be optional or compulsory as well. However, elements {{cc\|<y>}} and {{cc\|<z>}} are nominated and therefore compulsory. The nomination is triggered by providing key string {{cc\|other: y,z}} where the variable {{cc\|y,z}} provides a comma-separated list of names of the nominated elements. That is, after evaluating key string {{cc\|others: y,z}} {{lmt}} will search for elements {{cc\|<y>}} and {{cc\|<z>}}, and their absence will cause an error stop.

	Note that key strings and nested elements which are not required for the task are ignored. That is, non-sense and wrongly named key stings and elements will '''NOT''' cause an error stop as long as the parameter file content yields a sound description of the task and provides all necessary ingredients. Further, {{cc\|automatic-optional}} elements are evaluated even if they are not required for the task. This can lead to an un-neccesary high demand for hard-ware resources like cpu-power and RAM. See [[Parameter_file_elements#.3CH.3E]] for an example.		Note that key strings and nested elements which are not required for the task are ignored. That is, non-sense and wrongly named key stings and elements will '''NOT''' cause an error stop as long as the parameter file content yields a sound description of the task and provides all necessary ingredients. Further, {{cc\|automatic-optional}} elements are evaluated even if they are not required for the task. This can lead to an un-neccesary high demand for hard-ware resources like cpu-power and RAM. See [[Parameter_file_elements#.3CH.3E\|here]] for an example.

	== Group of mutually exclusive information sources ==		== Group of mutually exclusive information sources ==

Boerner: /* Parsing logic */

2021-01-04T10:02:52Z

Parsing logic

← Older revision		Revision as of 10:02, 4 January 2021
Line 50:		Line 50:
	In the above example nested elements {{cc\|<nest_1>}} and {{cc\|<nest_2>}} maybe optional or compulsory, but both are automatic, that is {{lmt}} will evaluate them only if the are present. Element {{cc\|<x>}}, nested in element {{cc\|<nest_2>}}, is automatic and may be optional or compulsory as well. However, elements {{cc\|<y>}} and {{cc\|<z>}} are nominated and therefore compulsory. The nomination is triggered by providing key string {{cc\|other: y,z}} where the variable {{cc\|y,z}} provides a comma-separated list of names of the nominated elements. That is, after evaluating key string {{cc\|others: y,z}} {{lmt}} will search for elements {{cc\|<y>}} and {{cc\|<z>}}, and their absence will cause an error stop.		In the above example nested elements {{cc\|<nest_1>}} and {{cc\|<nest_2>}} maybe optional or compulsory, but both are automatic, that is {{lmt}} will evaluate them only if the are present. Element {{cc\|<x>}}, nested in element {{cc\|<nest_2>}}, is automatic and may be optional or compulsory as well. However, elements {{cc\|<y>}} and {{cc\|<z>}} are nominated and therefore compulsory. The nomination is triggered by providing key string {{cc\|other: y,z}} where the variable {{cc\|y,z}} provides a comma-separated list of names of the nominated elements. That is, after evaluating key string {{cc\|others: y,z}} {{lmt}} will search for elements {{cc\|<y>}} and {{cc\|<z>}}, and their absence will cause an error stop.

	Note that key strings and nested elements which are not required for the task are ignored. That is, non-sense and wrongly named key stings and elements will '''NOT''' cause an error stop as long as the parameter file content yields a sound description of the task and provides all necessary ingredients. Further, {{cc\|automatic-optional}} elements are evaluated even if they are not required for the task. This can lead to an un-neccesary high demand for hard-ware resources like cpu-power and RAM. See [[Parameter_file_elements#H]] for an example.		Note that key strings and nested elements which are not required for the task are ignored. That is, non-sense and wrongly named key stings and elements will '''NOT''' cause an error stop as long as the parameter file content yields a sound description of the task and provides all necessary ingredients. Further, {{cc\|automatic-optional}} elements are evaluated even if they are not required for the task. This can lead to an un-neccesary high demand for hard-ware resources like cpu-power and RAM. See [[Parameter_file_elements#.3CH.3E]] for an example.

	== Group of mutually exclusive information sources ==		== Group of mutually exclusive information sources ==

Boerner: /* Parsing logic */

2021-01-04T10:01:20Z

Parsing logic

← Older revision		Revision as of 10:01, 4 January 2021
Line 50:		Line 50:
	In the above example nested elements {{cc\|<nest_1>}} and {{cc\|<nest_2>}} maybe optional or compulsory, but both are automatic, that is {{lmt}} will evaluate them only if the are present. Element {{cc\|<x>}}, nested in element {{cc\|<nest_2>}}, is automatic and may be optional or compulsory as well. However, elements {{cc\|<y>}} and {{cc\|<z>}} are nominated and therefore compulsory. The nomination is triggered by providing key string {{cc\|other: y,z}} where the variable {{cc\|y,z}} provides a comma-separated list of names of the nominated elements. That is, after evaluating key string {{cc\|others: y,z}} {{lmt}} will search for elements {{cc\|<y>}} and {{cc\|<z>}}, and their absence will cause an error stop.		In the above example nested elements {{cc\|<nest_1>}} and {{cc\|<nest_2>}} maybe optional or compulsory, but both are automatic, that is {{lmt}} will evaluate them only if the are present. Element {{cc\|<x>}}, nested in element {{cc\|<nest_2>}}, is automatic and may be optional or compulsory as well. However, elements {{cc\|<y>}} and {{cc\|<z>}} are nominated and therefore compulsory. The nomination is triggered by providing key string {{cc\|other: y,z}} where the variable {{cc\|y,z}} provides a comma-separated list of names of the nominated elements. That is, after evaluating key string {{cc\|others: y,z}} {{lmt}} will search for elements {{cc\|<y>}} and {{cc\|<z>}}, and their absence will cause an error stop.

	Note that key strings and nested elements which are not required for the task are ignored. That is, non-sense and wrongly named key stings and elements will '''NOT''' cause an error stop as long as the parameter file content yields a sound description of the task and provides all necessary ingredients.		Note that key strings and nested elements which are not required for the task are ignored. That is, non-sense and wrongly named key stings and elements will '''NOT''' cause an error stop as long as the parameter file content yields a sound description of the task and provides all necessary ingredients. Further, {{cc\|automatic-optional}} elements are evaluated even if they are not required for the task. This can lead to an un-neccesary high demand for hard-ware resources like cpu-power and RAM. See [[Parameter_file_elements#H]] for an example.

	== Group of mutually exclusive information sources ==		== Group of mutually exclusive information sources ==

Boerner: /* Parsing logic */

2021-01-04T09:53:18Z

Parsing logic

← Older revision		Revision as of 09:53, 4 January 2021
Line 50:		Line 50:
	In the above example nested elements {{cc\|<nest_1>}} and {{cc\|<nest_2>}} maybe optional or compulsory, but both are automatic, that is {{lmt}} will evaluate them only if the are present. Element {{cc\|<x>}}, nested in element {{cc\|<nest_2>}}, is automatic and may be optional or compulsory as well. However, elements {{cc\|<y>}} and {{cc\|<z>}} are nominated and therefore compulsory. The nomination is triggered by providing key string {{cc\|other: y,z}} where the variable {{cc\|y,z}} provides a comma-separated list of names of the nominated elements. That is, after evaluating key string {{cc\|others: y,z}} {{lmt}} will search for elements {{cc\|<y>}} and {{cc\|<z>}}, and their absence will cause an error stop.		In the above example nested elements {{cc\|<nest_1>}} and {{cc\|<nest_2>}} maybe optional or compulsory, but both are automatic, that is {{lmt}} will evaluate them only if the are present. Element {{cc\|<x>}}, nested in element {{cc\|<nest_2>}}, is automatic and may be optional or compulsory as well. However, elements {{cc\|<y>}} and {{cc\|<z>}} are nominated and therefore compulsory. The nomination is triggered by providing key string {{cc\|other: y,z}} where the variable {{cc\|y,z}} provides a comma-separated list of names of the nominated elements. That is, after evaluating key string {{cc\|others: y,z}} {{lmt}} will search for elements {{cc\|<y>}} and {{cc\|<z>}}, and their absence will cause an error stop.

	Note that key strings and nested elements which are not required for the task are ignored. That is, non-sense and wrongly named key stings and elements will '''NOT'' cause an error stop as long as the parameter file content yields a sound description of the task and provides all necessary ingredients.		Note that key strings and nested elements which are not required for the task are ignored. That is, non-sense and wrongly named key stings and elements will '''NOT''' cause an error stop as long as the parameter file content yields a sound description of the task and provides all necessary ingredients.

	== Group of mutually exclusive information sources ==		== Group of mutually exclusive information sources ==

Boerner: /* Parsing logic */

2021-01-04T09:53:03Z

Parsing logic

← Older revision		Revision as of 09:53, 4 January 2021
Line 49:		Line 49:

	In the above example nested elements {{cc\|<nest_1>}} and {{cc\|<nest_2>}} maybe optional or compulsory, but both are automatic, that is {{lmt}} will evaluate them only if the are present. Element {{cc\|<x>}}, nested in element {{cc\|<nest_2>}}, is automatic and may be optional or compulsory as well. However, elements {{cc\|<y>}} and {{cc\|<z>}} are nominated and therefore compulsory. The nomination is triggered by providing key string {{cc\|other: y,z}} where the variable {{cc\|y,z}} provides a comma-separated list of names of the nominated elements. That is, after evaluating key string {{cc\|others: y,z}} {{lmt}} will search for elements {{cc\|<y>}} and {{cc\|<z>}}, and their absence will cause an error stop.		In the above example nested elements {{cc\|<nest_1>}} and {{cc\|<nest_2>}} maybe optional or compulsory, but both are automatic, that is {{lmt}} will evaluate them only if the are present. Element {{cc\|<x>}}, nested in element {{cc\|<nest_2>}}, is automatic and may be optional or compulsory as well. However, elements {{cc\|<y>}} and {{cc\|<z>}} are nominated and therefore compulsory. The nomination is triggered by providing key string {{cc\|other: y,z}} where the variable {{cc\|y,z}} provides a comma-separated list of names of the nominated elements. That is, after evaluating key string {{cc\|others: y,z}} {{lmt}} will search for elements {{cc\|<y>}} and {{cc\|<z>}}, and their absence will cause an error stop.

			Note that key strings and nested elements which are not required for the task are ignored. That is, non-sense and wrongly named key stings and elements will '''NOT'' cause an error stop as long as the parameter file content yields a sound description of the task and provides all necessary ingredients.

	== Group of mutually exclusive information sources ==		== Group of mutually exclusive information sources ==

Boerner: /* Escaping element content formatting rules */

2021-01-04T09:45:30Z

Escaping element content formatting rules

← Older revision		Revision as of 09:45, 4 January 2021
Line 57:		Line 57:

	As pointed out above [[#Key strings\|key strings]] are the only accept element content beside nested elements, and key strings must comply with a formatting rule. However, it is sometimes desirable to supply other information in an element where that information may not comply with the formatting rule. In order to do so the element content can be globally escaped by adding an [https://www.tutorialspoint.com/xml/xml_attributes attribute] to the opening tag. However, this implies that by providing an attribute the whole element content is escaped, not just a single line.		As pointed out above [[#Key strings\|key strings]] are the only accept element content beside nested elements, and key strings must comply with a formatting rule. However, it is sometimes desirable to supply other information in an element where that information may not comply with the formatting rule. In order to do so the element content can be globally escaped by adding an [https://www.tutorialspoint.com/xml/xml_attributes attribute] to the opening tag. However, this implies that by providing an attribute the whole element content is escaped, not just a single line.

			For example
			<syntaxhighlight lang="xml" line>
			<root>
			<nest_1 attribute="eligible_attribute">
			you and me
			</nest_1>
			</root>
			</syntaxhighlight>
			the content of {{cc\|nest_1}} does not comply with the formatting rule {{cc\|keyword:variable}} as there is a colon missing. However, due to the attribute no error stop will occur.

Boerner: /* Escaping element content formatting rules */

2021-01-04T09:41:27Z

Escaping element content formatting rules

← Older revision		Revision as of 09:41, 4 January 2021
Line 56:		Line 56:
	== Escaping element content formatting rules ==		== Escaping element content formatting rules ==

	As pointed out [[#Key strings\|~~above~~]] are the only accept element content beside nested elements, and key strings must comply with a formatting rule. However, it is sometimes desirable to supply other information in an element where that information may not comply with the formatting rule. In order to do so the element content can be globally escaped by adding an [https://www.tutorialspoint.com/xml/xml_attributes attribute] to the opening tag. However, this implies that by providing an attribute the whole element content is escaped, not just a single line.		As pointed out above [[#Key strings\|key strings]] are the only accept element content beside nested elements, and key strings must comply with a formatting rule. However, it is sometimes desirable to supply other information in an element where that information may not comply with the formatting rule. In order to do so the element content can be globally escaped by adding an [https://www.tutorialspoint.com/xml/xml_attributes attribute] to the opening tag. However, this implies that by providing an attribute the whole element content is escaped, not just a single line.

Boerner: /* Group of mutually exclusive information sources */

2021-01-04T09:40:38Z

Group of mutually exclusive information sources

← Older revision		Revision as of 09:40, 4 January 2021
Line 52:		Line 52:
	== Group of mutually exclusive information sources ==		== Group of mutually exclusive information sources ==

	For the sake of flexibility the user can supply the same information in several different ways to {{lmt}}. For instance, information can be embedded in an element or provided via a file where ~~the variable of~~ key string variable contains the file name . In such a case, the key string and the element form a '''Group of mutually exclusive information sources (GIS)'''. The name already implies that {{lmt}} will accept only one source of information and if it finds more than one source will stop with an error message.		For the sake of flexibility the user can supply the same information in several different ways to {{lmt}}. For instance, information can be embedded in an element or provided via a file where a key string variable contains the file name, e.g. {{cc\| file: filename}}. In such a case, the key string and the element form a '''Group of mutually exclusive information sources (GIS)'''. The name already implies that {{lmt}} will accept only one source of information and if it finds more than one source will stop with an error message.

	== Escaping element content formatting rules ==		== Escaping element content formatting rules ==

	As pointed out [[#Key strings\|above]] are the only accept element content beside nested elements, and key strings must comply with a formatting rule. However, it is sometimes desirable to supply other information in an element where that information may not comply with the formatting rule. In order to do so the element content can be globally escaped by adding an [https://www.tutorialspoint.com/xml/xml_attributes attribute] to the opening tag. However, this implies that by providing an attribute the whole element content is escaped, not just a single line.		As pointed out [[#Key strings\|above]] are the only accept element content beside nested elements, and key strings must comply with a formatting rule. However, it is sometimes desirable to supply other information in an element where that information may not comply with the formatting rule. In order to do so the element content can be globally escaped by adding an [https://www.tutorialspoint.com/xml/xml_attributes attribute] to the opening tag. However, this implies that by providing an attribute the whole element content is escaped, not just a single line.

Boerner: /* Parsing logic */

2021-01-04T09:36:42Z

Parsing logic

← Older revision		Revision as of 09:36, 4 January 2021
Line 28:		Line 28:
	== Parsing logic ==		== Parsing logic ==

	{{lmt}} parse the parameter file starting at the compulsory {{cc\|<root>}} element. Nested elements can be either automatic-compulsory, automatic-optional ~~and~~ nominated. Automatic-optional elements will be searched for by default and are evaluated if they are present. Their absence will not ~~case~~ an error message at parsing time. However, that does not mean that the information they should provide is not necessary later on and it's absence may cause an error stop. Automatic-compulsory elements will be searched for by default and their absence will cause an error stop. Nominated elements are always compulsory but are only searched for if they have been nominated by a key string variable, where the key string variable becomes the element name.		{{lmt}} parse the parameter file starting at the compulsory {{cc\|<root>}} element. Nested elements can be either {{cc\|automatic-compulsory}}, {{cc\|automatic-optional}} or {{cc\|nominated}}. {{cc\|Automatic-optional}} elements will be searched for by default and are evaluated if they are present. Their absence will not cause an error message at parsing time. However, that does not mean that the information they should provide is not necessary later on and it's absence may cause an error stop. {{cc\|Automatic-compulsory}} elements will be searched for by default and their absence will cause an error stop. {{cc\|Nominated}} elements are always compulsory but are only searched for if they have been nominated by a key string variable, where the key string variable becomes the element name.

	Depending on the host element key strings can be optional or compulsory.		Depending on the host element key strings can be optional or compulsory.