testconsole.Results

Gets results from test console simulations

Description

The getResults method of the Error Rate Test Console returns an instance of a testconsole.Results object containing simulation results data. You use methods of the results object to retrieve and plot simulations results data.

Properties

A testconsole.Results object has the properties shown on the following table. All properties are writable except for the ones explicitly noted otherwise.

Property	Description
TestConsoleName	Error Rate Test Console. This property is not writable.
System Under Test Name	Name of the system under test for which the Error Rate Test Console obtained results. This property is not writable.
IterationMode	Iteration mode the Error Rate Test Console used for obtaining results. This property is not writable.
TestPoint	Specify the name of the registered test point for which the results object parses results. The getData, plot, and semilogy methods of the Results object return data or create a plot for the test point that the TestPoint property specifies.
Metric	Specify the name of the test metric for which the results object parses results. The getData, plot, and semilogy methods of the Results object returns data or creates a plot for the metric that the Metric property specifies.
TestParameter1	Specifies the name of the first independent variable for which the results object parses results.
TestParameter2	Specifies the name of the second independent variable for which the results object parses results.

Methods

A testconsole.Results object has the following methods.

getData

d = getData(r) returns results data matrix, d, available in the results object r. The returned results correspond to the test point currently specified in the TestPoint property of r, and to the test metric currently specified in the Metric property of r.

If IterationMode is 'Combinatorial' then d is a matrix containing results for all the sweep values available in the test parameters specified in the TestParameter1 and TestParameter2 properties. The rows of the matrix correspond to results for all the sweep values available in TestParameter1. The columns of the matrix correspond to results for all sweep values available in TestParameter2. If more than two test parameters are registered to the Error Rate Test Console, d contains results corresponding to the first value in the sweep vector of all parameters that are not TestParameter1 or TestParameter2.

If IterationMode is 'Indexed', then d is a vector of results corresponding to each indexed combination of all the test parameter values registered to the Error Rate Test Console.

plot

plot(r) creates a plot for the results available in the results object r. The plot corresponds to the test point and test metric, specified by the TestPoint and Metric properties of r

If IterationMode is 'Combinatorial' then the plot contains a set of curves. The sweep values in TestParameter1 control the x-axis and the number of sweep values for TestParameter2 specifies how many curves the plot contains. If more than two test parameters are registered to the Error Rate Test Console, the curves correspond to results obtained with the first value in the sweep vector of all parameters that are not TestParameter1, or TestParameter2.

No plots are available when 'IterationMode' is 'Indexed'.

semilogy

semilogy(...) is the same as plot(...), except that the Y-Axis uses a logarithmic (base 10) scale.

surf

surf(r) creates a 3-D, color, surface plot for the results available in the results object, r. The surface plot corresponds to following items:

• The test point you specify using the TestPoint property of the results object

• The test metric currently you specify in the Metric property of the results object

You can specify parameter/value pairs for the results object, which establishes additional properties of the surface plot.

When you select 'Combinatorial' for the IterationMode, the sweep values available in the test parameter you specify for the TestParameter1 property control the x-axis of the surface plot. The sweep values available in the test parameter you specify for the TestParameter2 property control the y-axis.

If more than two test parameters are registered to the test console, the surface plot corresponds to the results obtained with the parameter sweep values previously specified with the setParsingValues method of the results object.

You display the current parsing values by calling the getParsingValues method of the results object. The parsing values default to the first value in the sweep vector of each test parameter. By default, the surf method ignores the parsing values for any parameters currently set as TestParameter1 or TestParameter2.

No surface plots are available if the IterationMode is 'Indexed', when less than two registered test parameters exist, or TestParameter2 is set to 'None'.

setParsingValues

setParsingValues(R,'ParameterName1', 'Value1', ... 'ParameterName2', 'Value2', ...) sets the parsing values to the values you specify using the parameter-value pairs. Parameter name inputs must correspond to names of registered test parameters, and value inputs must correspond to a valid test parameter sweep value.

You use this method for specifying single sweep values for test parameters that differ from the values for TestParameter1 and TestParameter2. When you define this method, the results object returns the data values or plots corresponding to the sweep values you set for the setParsingValues method. The parsing values default to the first value in the sweep vector of each test parameter.

You display the current parsing values by calling the getParsingValues method of the results object. You may set parsing values for parameters in TestParameter1 and TestParameter2, but the results object ignores the values when getting data or returning plots.

Parsing values are irrelevant when IterationMode is 'Indexed'.

getParsingValues

getParsingValues displays the current parsing values for the Error Rate Test Console.

s = getParsingValues(r) returns a structure, s, with field names equal to the registered test parameter names and with values corresponding to the current parsing values.

Parsing values are irrelevant when IterationMode is 'Indexed'.