<?xml version="1.0"?>
<?xml-stylesheet type="text/xsl" href="xsl/pts-definitions-viewer.xsl" ?>
<PhoronixTestSuite>
	<Definitions>
		<Define>
			<Name>P_RESULTS_PARSER_MATCH_TO_TEST_ARGUMENTS</Name>
			<Value>PhoronixTestSuite/ResultsParser/MatchToTestArguments</Value>
			<Description>If there are multiple ResulsParser sections within the XML file and this tag is set, the Phoronix Test Suite will see if this string appears within the PTS_TEST_ARGUMENTS in determining if this is the ResultsParser section to use for parsing the results.</Description>
		</Define>
		<Define>
			<Name>P_RESULTS_PARSER_TEMPLATE</Name>
			<Value>PhoronixTestSuite/ResultsParser/OutputTemplate</Value>
			<Description>The section of the test output to look for the result(s) within.</Description>
		</Define>
		<Define>
			<Name>P_RESULTS_PARSER_RESULT_KEY</Name>
			<Value>PhoronixTestSuite/ResultsParser/ResultKey</Value>
			<Description>The key to look for when parsing the OutputTemplate to find where the result should be stored. If this tag is not implemented, the default key will be used.</Description>
		</Define>
		<Define>
			<Name>P_RESULTS_PARSER_LINE_HINT</Name>
			<Value>PhoronixTestSuite/ResultsParser/LineHint</Value>
			<Description>A unique string to search the test result output for to indicate this is the line that contains the result value.</Description>
		</Define>
		<Define>
			<Name>P_RESULTS_PARSER_LINE_BEFORE_HINT</Name>
			<Value>PhoronixTestSuite/ResultsParser/LineBeforeHint</Value>
			<Description>The LineBeforeHint tag is similar to LineHint but is used to indicate the line before where the test results appear, in the event the LineHint tag cannot be used reliably.</Description>
		</Define>
		<Define>
			<Name>P_RESULTS_PARSER_LINE_AFTER_HINT</Name>
			<Value>PhoronixTestSuite/ResultsParser/LineAfterHint</Value>
			<Description>The LineAfterHint tag is similar to LineBeforeHint but is used to indicate the line after where the test results appear, in the event the LineHint or LineBeforeHint tags cannot be used reliably.</Description>
		</Define>
		<Define>
			<Name>P_RESULTS_PARSER_RESULT_BEFORE_STRING</Name>
			<Value>PhoronixTestSuite/ResultsParser/ResultBeforeString</Value>
			<Description>The ResultBeforeString tag is optional and can be used if there is a consistient string following the reporting of the result, in the event the result's location is not static within the line string.</Description>
		</Define>
		<Define>
			<Name>P_RESULTS_PARSER_STRIP_FROM_RESULT</Name>
			<Value>PhoronixTestSuite/ResultsParser/StripFromResult</Value>
			<Description>Any string that should be searched for and removed from the result value anywhere within the value string.</Description>
		</Define>
		<Define>
			<Name>P_RESULTS_PARSER_STRIP_RESULT_POSTFIX</Name>
			<Value>PhoronixTestSuite/ResultsParser/StripResultPostfix</Value>
			<Description>This is similar to the StripFromResult tag but will only look at the end of the value string for this string to be removed. (I.e. if a unit such as 'ms' or 'FPS' is appended to the result by the test without a space.)</Description>
		</Define>
		<Define>
			<Name>P_RESULTS_PARSER_MULTI_MATCH</Name>
			<Value>PhoronixTestSuite/ResultsParser/MultiMatch</Value>
			<Description>If the result value should be found multiple times within the result file and then some mathematical operation carried out, it should be set using this tag. Setting the value to AVERAGE will find all matches and then calculate the average value based upon matches. While not required, setting the value to NONE will use the default code-path of only looking for one result value.</Description>
		</Define>
		<Define>
			<Name>P_RESULTS_PARSER_DIVIDE_BY</Name>
			<Value>PhoronixTestSuite/ResultsParser/DivideResultBy</Value>
			<Description>If the result value should be divided by some constant (to convert the result to a different unit), the value should be supplied in this tag.</Description>
		</Define>
		<Define>
			<Name>P_RESULTS_PARSER_MULTIPLY_BY</Name>
			<Value>PhoronixTestSuite/ResultsParser/MultiplyResultBy</Value>
			<Description>If the result value should be multiplied by some constant (to convert the result to a different unit), the value should be supplied in this tag.</Description>
		</Define>
		<Define>
			<Name>P_IMAGE_PARSER_MATCH_TO_TEST_ARGUMENTS</Name>
			<Value>PhoronixTestSuite/ImageParser/MatchToTestArguments</Value>
			<Description>If there are multiple ResulsParser sections within the XML file and this tag is set, the Phoronix Test Suite will see if this string appears within the PTS_TEST_ARGUMENTS in determining if this is the ResultsParser section to use for parsing the results.</Description>
		</Define>
		<Define>
			<Name>P_IMAGE_PARSER_SOURCE_IMAGE</Name>
			<Value>PhoronixTestSuite/ImageParser/SourceImage</Value>
			<Description>If the test profile is for an image quality comparison, the ImageFile tag should contain the file/path of the source file.</Description>
		</Define>
		<Define>
			<Name>P_IMAGE_PARSER_IMAGE_X</Name>
			<Value>PhoronixTestSuite/ImageParser/ImageX</Value>
			<Description>If the test profile is for an image quality comparison, the ImageX should be the X coordinate of where to begin cropping the source file.</Description>
		</Define>
		<Define>
			<Name>P_IMAGE_PARSER_IMAGE_Y</Name>
			<Value>PhoronixTestSuite/ImageParser/ImageY</Value>
			<Description>If the test profile is for an image quality comparison, the ImageX should be the Y coordinate of where to begin cropping the source file.</Description>
		</Define>
		<Define>
			<Name>P_IMAGE_PARSER_IMAGE_WIDTH</Name>
			<Value>PhoronixTestSuite/ImageParser/ImageWidth</Value>
			<Description>If the test profile is for an image quality comparison, the ImageWidth should be the produced image width.</Description>
		</Define>
		<Define>
			<Name>P_IMAGE_PARSER_IMAGE_HEIGHT</Name>
			<Value>PhoronixTestSuite/ImageParser/ImageHeight</Value>
			<Description>If the test profile is for an image quality comparison, the ImageHeight should be the produced image height.</Description>
		</Define>
		<Define>
			<Name>P_MONITOR_PARSER_SENSOR</Name>
			<Value>PhoronixTestSuite/SystemMonitor/Sensor</Value>
			<Description>If the test profile is to monitor any system sensors during the testing process, the name of the sensor (via the Phodevi name; i.e. cpu.usage) should be supplied. While not a Phodevi sensor, if passing sys.time as the sensor value, the time it takes to execute the test will be recorded.</Description>
		</Define>
		<Define>
			<Name>P_MONITOR_PARSER_FREQUENCY</Name>
			<Value>PhoronixTestSuite/SystemMonitor/PollingFrequency</Value>
			<Description>If the test profile is to monitor any system sensors during the testing process, how often the matched sensor is to be polled (in seconds) should be supplied. Floating values are supported.</Description>
		</Define>
		<Define>
			<Name>P_MONITOR_PARSER_REPORT</Name>
			<Value>PhoronixTestSuite/SystemMonitor/Report</Value>
			<Description>If the test profile is to monitor any system sensors during the testing process, this tag provides how the monitored results should be reported. Supported values include MAX, MIN, AVG, and ALL.</Description>
		</Define>
	</Definitions>
</PhoronixTestSuite>
