sltest.testmanager.TestResultReport class

Пакет: sltest.testmanager

Настройте сгенерированный отчет результатов

Описание

sltest.testmanager.TestResultReport класс, который позволяет вам настроить генерацию отчета результата менеджера по Тесту. Можно вывести класс и заменить различные методы, чтобы настроить отчет. Путем настройки методов можно изменить заголовок отчета, графики, таблицы, заголовки, значки и т.д.

Для получения дополнительной информации и примеры при настройке отчетов, смотрите, Настраивают Отчеты Результатов испытаний.

sltest.testmanager.TestResultReport классом является handle класс.

Атрибуты класса

HandleCompatible
true

Для получения информации об атрибутах класса см. Атрибуты класса.

Создание

Obj = sltest.testmanager.TestResultReport(resultObjects,reportFilePath) создает объект генерации отчета.

Чтобы использовать этот класс, необходимо наследоваться классу. Используйте следующий код в качестве первых линий в вашем коде определения класса, чтобы наследоваться классу.

% class definition
classdef CustomReport < sltest.testmanager.TestResultReport
    %
    % Report customization code here
    %
end

Входные параметры

развернуть все

Набор результатов возражает, чтобы получить результаты в виде sltest.testmanager.ResultSet объект.

Имя файла и путь сгенерированного отчета. Путь к файлу должен иметь расширение файла PDF, docx, или zip, которые являются единственными поддерживаемыми типами файлов.

Пример: 'C:\MATLAB\Report.pdf'

Свойства

развернуть все

Атрибуты:

SetAccess
public
GetAccess
public
Dependent
true
NonCopyable
true

Цвет шрифта текста абзаца тела в виде вектора символов.

Пример: 'Red'

Атрибуты:

SetAccess
protected
GetAccess
public
Dependent
true
NonCopyable
true

Стиль шрифта текста абзаца тела называет в виде вектора символов.

Пример: 'Times New Roman'

Атрибуты:

SetAccess
protected
GetAccess
public
Dependent
true
NonCopyable
true

Размер шрифта текста абзаца тела, заданный в точках как вектор символов.

Пример: '14pt'

Атрибуты:

SetAccess
protected
GetAccess
public
Dependent
true
NonCopyable
true

Первая ширина добавления отступа раздела уровня, заданная в миллиметрах как вектор символов.

Пример: '5mm'

Атрибуты:

SetAccess
protected
GetAccess
public
Dependent
true
NonCopyable
true

Вторая ширина добавления отступа раздела уровня, заданная в миллиметрах как вектор символов.

Пример: '8mm'

Атрибуты:

SetAccess
protected
GetAccess
public
Dependent
true
NonCopyable
true

Третья ширина добавления отступа раздела уровня, заданная в миллиметрах как вектор символов.

Пример: '10mm'

Атрибуты:

SetAccess
protected
GetAccess
public
Dependent
true
NonCopyable
true

Имя файла и путь к Microsoft® Файл шаблона Word для настройки отчетов в виде вектора символов. Для получения дополнительной информации об использовании файлов шаблона смотрите, Генерируют Отчеты Используя Шаблоны. Использование этого аргумента допустимо только доступное, если у вас есть MATLAB® Лицензия Report Generator™.

Пример: 'C:\MATLAB\CustomReportTemplate.dotx'

Атрибуты:

SetAccess
public
GetAccess
public
Dependent
true
NonCopyable
true

Шрифт текста заголовка раздела окрашивает в виде вектора символов.

Пример: 'blue'

Атрибуты:

SetAccess
protected
GetAccess
public
Dependent
true
NonCopyable
true

Текстовый стиль шрифта заголовка раздела называет в виде вектора символов.

Пример: 'Times New Roman'

Атрибуты:

SetAccess
protected
GetAccess
public
Dependent
true
NonCopyable
true

Цвет шрифта текста заголовка раздела, заданный в точках как вектор символов.

Пример: '16pt'

Атрибуты:

SetAccess
protected
GetAccess
public
Dependent
true
NonCopyable
true

Имя файла и путь значка отображают для отключенного результата испытаний в виде вектора символов. Файл значка задал, заменяет изображение значка по умолчанию. Изображение значка уменьшается до 16x16 пикселей.

Пример: 'C:\MATLAB\disabled_test_icon.png'

Атрибуты:

SetAccess
protected
GetAccess
public
Dependent
true
NonCopyable
true

Имя файла и путь значка отображают для не пройдено результата испытаний в виде вектора символов. Файл значка задал, заменяет изображение значка по умолчанию. Изображение значка уменьшается до 16x16 пикселей.

Пример: 'C:\MATLAB\failed_test_icon.png'

Атрибуты:

SetAccess
protected
GetAccess
public
Dependent
true
NonCopyable
true

Имя файла и путь значка отображают для неполного результата испытаний в виде вектора символов. Файл значка задал, заменяет изображение значка по умолчанию. Изображение значка уменьшается до 16x16 пикселей.

Пример: 'C:\MATLAB\incomplete_test_icon.png'

Атрибуты:

SetAccess
protected
GetAccess
public
Dependent
true
NonCopyable
true

Имя файла и путь значка отображают для неправильно выровненного результата испытаний в виде вектора символов. Файл значка задал, заменяет изображение значка по умолчанию. Изображение значка уменьшается до 16x16 пикселей.

Пример: 'C:\MATLAB\misaligned_test_icon.png'

Атрибуты:

SetAccess
protected
GetAccess
public
Dependent
true
NonCopyable
true

Имя файла и путь значка отображают для переданного результата испытаний в виде вектора символов. Файл значка задал, заменяет изображение значка по умолчанию. Изображение значка уменьшается до 16x16 пикселей.

Пример: 'C:\MATLAB\passed_test_icon.png'

Атрибуты:

SetAccess
protected
GetAccess
public
Dependent
true
NonCopyable
true

Имя файла и путь значка отображают для результата теста в виде вектора символов. Файл значка задал, заменяет изображение значка по умолчанию. Изображение значка уменьшается до 16x16 пикселей.

Пример: 'C:\MATLAB\test_case_result_icon.png'

Атрибуты:

SetAccess
protected
GetAccess
public
Dependent
true
NonCopyable
true

Имя файла и путь значка отображают для результата тестового файла в виде вектора символов. Файл значка задал, заменяет изображение значка по умолчанию. Изображение значка уменьшается до 16x16 пикселей.

Пример: 'C:\MATLAB\test_file_result_icon.png'

Атрибуты:

SetAccess
protected
GetAccess
public
Dependent
true
NonCopyable
true

Имя файла и путь значка отображают для результата итерации в виде вектора символов. Файл значка задал, заменяет изображение значка по умолчанию. Изображение значка уменьшается до 16x16 пикселей.

Пример: 'C:\MATLAB\iteration_result_icon.png'

Атрибуты:

SetAccess
protected
GetAccess
public
Dependent
true
NonCopyable
true

Имя файла и путь значка отображают для результата тестового набора в виде вектора символов. Файл значка задал, заменяет изображение значка по умолчанию. Изображение значка уменьшается до 16x16 пикселей.

Пример: 'C:\MATLAB\test_suite_result_icon.png'

Атрибуты:

SetAccess
protected
GetAccess
public
Dependent
true
NonCopyable
true

Имя файла и путь значка отображают для модели - ссылки в отчете покрытия в виде вектора символов. Файл значка задал, заменяет изображение значка по умолчанию. Изображение значка уменьшается до 16x16 пикселей.

Пример: 'C:\MATLAB\model_reference_icon.png'

Атрибуты:

SetAccess
protected
GetAccess
public
Dependent
true
NonCopyable
true

Имя файла и путь значка отображают для модели верхнего уровня в отчете покрытия в виде вектора символов. Файл значка задал, заменяет изображение значка по умолчанию. Изображение значка уменьшается до 16x16 пикселей.

Пример: 'C:\MATLAB\top_level_model_icon.png'

Атрибуты:

SetAccess
protected
GetAccess
public
Dependent
true
NonCopyable
true

Включайте графики сравнения сигнала в отчете в виде true или false.

Атрибуты:

SetAccess
public
GetAccess
public
Dependent
true
NonCopyable
true

Включайте результаты покрытия в отчет в виде true или false.

Атрибуты:

SetAccess
public
GetAccess
public
Dependent
true
NonCopyable
true

Включайте сообщения об ошибке в отчет в виде true или false.

Атрибуты:

SetAccess
public
GetAccess
public
Dependent
true
NonCopyable
true

Включайте версию MATLAB, используемого, чтобы запустить тесты в отчете в виде true или false.

Атрибуты:

SetAccess
public
GetAccess
public
Dependent
true
NonCopyable
true

Включайте метаданные симуляции в отчет в виде true или false. Метаданные включают: Simulink® версия, версия модели, автор модели, дата, идентификатор пользователя модели, модель path, имя машины, имя решателя, тип решателя, зафиксированный размер шага, время начала симуляции, время остановки симуляции и платформа.

Атрибуты:

SetAccess
public
GetAccess
public
Dependent
true
NonCopyable
true

Включайте сигнал симуляции выходные графики в отчете в виде true или false.

Атрибуты:

SetAccess
public
GetAccess
public
Dependent
true
NonCopyable
true

Включайте тестовые требования, соединенные с тестовым файлом, тестовым набором или тестом в отчете в виде true или false.

Атрибуты:

SetAccess
public
GetAccess
public
Dependent
true
NonCopyable
true

Включайте все или подмножество результатов испытаний в отчете. Можно выбрать все переданные и не пройдено результаты в виде значения 0, выбор только передал результаты в виде значения 1, или избранные только отказавшие результаты в виде значения 2.

Атрибуты:

SetAccess
public
GetAccess
public
Dependent
true
NonCopyable
true

Откройте отчет, когда он будет закончен, генерируя в виде булева значения, true или не открыть отчет, false.

Атрибуты:

SetAccess
public
GetAccess
public
Dependent
true
NonCopyable
true

Заголовок отчета в виде вектора символов

Пример: 'Test Case Report'

Атрибуты:

SetAccess
public
GetAccess
public
Dependent
true
NonCopyable
true

Разрядка между разделами, заданными в миллиметрах как вектор символов.

Пример: '5mm'

Атрибуты:

SetAccess
protected
GetAccess
public
Dependent
true
NonCopyable
true

Постройте высоту, заданную в пикселях как вектор символов.

Пример: '500px'

Атрибуты:

SetAccess
protected
GetAccess
public
Dependent
true
NonCopyable
true

Постройте ширину, заданную в пикселях как вектор символов.

Пример: '400px'

Атрибуты:

SetAccess
protected
GetAccess
public
Dependent
true
NonCopyable
true

Табличный цвет шрифта в виде вектора символов.

Пример: 'blue'

Атрибуты:

SetAccess
protected
GetAccess
public
Dependent
true
NonCopyable
true

Табличный стиль шрифта называет в виде вектора символов.

Пример: 'Times New Roman'

Атрибуты:

SetAccess
protected
GetAccess
public
Dependent
true
NonCopyable
true

Табличный размер шрифта, заданный в точках как вектор символов.

Пример: '10pt'

Атрибуты:

SetAccess
protected
GetAccess
public
Dependent
true
NonCopyable
true

Цвет шрифта заголовка в виде вектора символов.

Пример: 'blue'

Атрибуты:

SetAccess
protected
GetAccess
public
Dependent
true
NonCopyable
true

Стиль шрифта заголовка называет в виде вектора символов.

Пример: 'Times New Roman'

Атрибуты:

SetAccess
protected
GetAccess
public
Dependent
true
NonCopyable
true

Размер шрифта заголовка, заданный в точках как вектор символов.

Пример: '20pt'

Атрибуты:

SetAccess
protected
GetAccess
public
Dependent
true
NonCopyable
true

Методы

развернуть все

Примеры

свернуть все

% class definition
classdef CustomReport < sltest.testmanager.TestResultReport
    % This custom class used by Test Manager 
    % adds a custom message in the title page

    % Class constructor
    methods
        function this = CustomReport(resultObjects, reportFilePath)
            this@sltest.testmanager.TestResultReport...
               (resultObjects,reportFilePath);
        end
    end

    methods(Access=protected)
        function addTitlePage(obj)
            import mlreportgen.dom.*;

            % Call the superclass method to get the default behavior
            addTitlePage@sltest.testmanager.TestResultReport(obj);

            % Add a custom message
            label = Text('Some custom content can be added here');
            append(obj.TitlePart,label);
        end
    end
end
% import existing results or use sltest.testmanager.run to run tests
% and collect results
result = sltest.testmanager.importResults('testResults.mldatx');
filePath = 'testreport.zip';
sltest.testmanager.report(result,filePath,...
			'Author','User',...
			'Title','Test',...
			'IncludeMLVersion',true,...
			'IncludeTestResults',int32(0),...
			'CustomReportClass','CustomReport',...
			'LaunchReport',true);
Введенный в R2016a
Для просмотра документации необходимо авторизоваться на сайте