slmetric.metric.createNewMetricClass

Пакет: slmetric.metric

Создайте новый метрический класс для пользовательской метрики модели

Описание

пример

slmetric.metric.createNewMetricClass(class_name) создает slmetric.metric.Metric класс в текущей рабочей папке. Новый метрический класс используется, чтобы задать пользовательскую метрику модели и поддерживает следующий Advisor.component.Types:

  • Model

  • SubSystem

  • ModelBlock

  • Chart

  • MATLABFunction

Примеры

свернуть все

В этом примере показано, как создать новый метрический класс my_metric.

Вызовите функцию и обеспечьте имя для нового метрического класса:

slmetric.metric.createNewMetricClass('my_metric')

Функция создает my_metric.m файл в текущей рабочей папке.

slmetric.metric.createNewMetricClass('my_metric')

Файл содержит определение класса для my_metric, который включает конструктора и пустой метрический algorithm метод.

classdef my_metric < slmetric.metric.Metric
		% my_metric Summary of this metric class goes here
		%   Detailed explanation goes here
    	properties
    	end

		methods
			function this = my_metric()
				this.ID = 'my_metric';
				this.Description = '';
				this.ComponentScope = [Advisor.component.Types.Model, ...
					Advisor.component.Types.SubSystem];
				this.AggregationMode = slmetric.AggregationMode.Sum;
				this.CompileContext = 'None';
				this.Version = 1;
			end

			function res = algorithm(this, component)
				res = slmetric.metric.Result();	
				res.ComponentID = component.ID;
				res.MetricID = this.ID;
				res.Value = 0;
			end
		end
end

Напишите свой пользовательский метрический алгоритм в algorithm.

Когда ваш пользовательский метрический класс будет работать и протестированный, укажите свою метрику с помощью slmetric.metric.registerMetric.

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

свернуть все

Имя нового метрического класса вы создаете для пользовательской метрики.

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

Введенный в R2016a

Для просмотра документации необходимо авторизоваться на сайте