slmetric.metric.Result class

Пакет: slmetric.metric
Суперклассы:

Метрические данные для заданного компонента модели и метрический алгоритм

Описание

Экземпляры slmetric.metric.Result содержите метрические данные для заданного компонента модели и метрический алгоритм.

Конструкция

metric_result = slmetric.metric.Result создает указатель на метрический объект результатов.

Свойства

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

Уникальный числовой идентификатор для метрического объекта результата. Это свойство доступно только для чтения.

Типы данных: uint64

Уникальный идентификатор объекта компонента, для которого вычисляется метрика. Используйте ComponentID прослеживать сгенерированный объект результата до анализируемого компонента. Установите ComponentID или ComponentPath свойства при помощи algorithm метод.

Это свойство является чтением-записью.

Типы данных: char

Путь компонента, для которого вычисляется метрика. Используйте ComponentPath как альтернатива установке ComponentID свойство. Метрический механизм преобразует ComponentPath к ComponentID. Установите ComponentID или ComponentPath свойства при помощи algorithm метод.

Это свойство является чтением-записью.

Типы данных: char

Метрический идентификатор для Метрик Модели или пользовательских метрик модели, которые вы создаете. Можно получить метрические идентификаторы путем вызова slmetric.metric.getAvailableMetrics.

Это свойство является чтением-записью.

Типы данных: char

Метрическое скалярное значение, сгенерированное алгоритмом для метрики, задано MetricID и компонент задан ComponentID.

Если алгоритм не задает метрическое скалярное значение, значением по умолчанию является NaN. Например, предположите, что вы собираете метрические данные для модели, которая содержит диаграмму Stateflow. Для StateflowChartObjectCount метрика, Value свойство модели slmetric.metric.Result объектом является NaN потому что сама модель не может иметь объектов Stateflow. AggregatedValue свойство модели slmetric.metric.Result объект содержит общее количество объектов Stateflow в графике.

Это свойство является чтением-записью.

Типы данных: double

Метрическое значение агрегировано через иерархию модели. Метрический механизм неявно агрегировал метрические значения на основе AggregationMode. Не устанавливайте это свойство. Если метрическим скалярным значением является NaN для всех компонентов, AggregatedValue нуль.

Это свойство доступно только для чтения.

Типы данных: double

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

Установите свойство при помощи slmetric.metric.Metric.algorithm метод. Это свойство является чтением-записью.

Типы данных: double

Метрика измеряет значение, агрегированное через иерархию модели. Метрический механизм неявно агрегировал метрические значения меры на основе AggregationMode. Не устанавливайте это свойство.

Это свойство доступно только для чтения.

Типы данных: double

Детали о том, что метрический механизм значит Value свойство

Это свойство является чтением-записью.

Метрические значения данных попадают в одну из этих четырех категорий:

  • Совместимый — Метрические данные, которые находятся в допустимом диапазоне.

  • Предупреждение — Метрические данные, которые требуют анализа.

  • NonCompliant — Метрические данные, которые требуют, чтобы вы изменили свою модель.

  • Некатегоризированный — Метрические данные, которым не установили пороговые значения.

Это свойство доступно только для чтения.

Доступ к метрической категории данных и областям значений, которые соответствуют каждой категории. Это свойство пусто, если никакие пороговые значения не установлены.

Пользовательские данные опционально обеспечиваются метрическим алгоритмом.

Это свойство является чтением-записью.

Типы данных: char

Примеры

свернуть все

Соберитесь и модель доступа метрические данные для модели sldemo_mdlref_basic.

Создайте slmetric.Engine объект и набор корень в модели для анализа.

metric_engine = slmetric.Engine();

% Include referenced models and libraries in the analysis, 
%     these properties are on by default
metric_engine.ModelReferencesSimulationMode = 'AllModes';
metric_engine.AnalyzeLibraries = 1;

setAnalysisRoot(metric_engine, 'Root',  'sldemo_mdlref_basic');

Соберите метрические данные модели

execute(metric_engine, 'mathworks.metrics.ExplicitIOCount');

Получите метрические данные модели, которые возвращают массив slmetric.metric.ResultCollection объекты, res_col.

res_col = getMetrics(metric_engine, 'mathworks.metrics.ExplicitIOCount');

Отобразите результаты для mathworks.metrics.ExplicitIOCount метрика.

for n=1:length(res_col)
    if res_col(n).Status == 0
        result = res_col(n).Results;
        
        for m=1:length(result)
            disp(['MetricID: ',result(m).MetricID]);
            disp(['  ComponentPath: ', result(m).ComponentPath]);
            disp(['  Value: ', num2str(result(m).Value)]);
            disp(['  AggregatedValue: ', num2str(result(m).AggregatedValue)]);
            disp(['  Measures: ', num2str(result(m).Measures)]);
            disp(['  AggregatedMeasures: ', num2str(result(m).AggregatedMeasures)]);
        end
    else
        disp(['No results for:', result(n).MetricID]);
    end
    disp(' ');
end

Вот результаты:

MetricID: mathworks.metrics.ExplicitIOCount
  ComponentPath: sldemo_mdlref_basic
  Value: 3
  AggregatedValue: 4
  Measures: 0  3
  AggregatedMeasures: 3  3
MetricID: mathworks.metrics.ExplicitIOCount
  ComponentPath: sldemo_mdlref_basic/More Info
  Value: 0
  AggregatedValue: 0
  Measures: 0  0
  AggregatedMeasures: 0  0
MetricID: mathworks.metrics.ExplicitIOCount
  ComponentPath: sldemo_mdlref_counter
  Value: 4
  AggregatedValue: 4
  Measures: 3  1
  AggregatedMeasures: 3  1

Для ComponentPath: sldemo_mdlref_basic, значением является 3 потому что существует 3 выходные параметры . Эти три выходных параметров в своей стихии Measures массив. slmetric.metric.AggregationMode Max, так AggregatedValue 4 который является количеством вводов и выводов к sldemo_mdlref_counter. AggregratedMeasures массив содержит максимальное количество вводов и выводов для компонента или субкомпонента.

Введенный в R2016a