Документация

Отображение блока по умолчанию

Когда вы генерируете пользовательский блок из файла компонента Simscape™, имени блока и параметра, и имена переменных в диалоговом окне блока выведены из элементов файла компонента. Значок блока по умолчанию является прямоугольником, отображающим имя блока. Порты основаны на узлах, входных параметрах и выходных параметрах, заданных в файле компонента.

Следующий пример показывает файл компонента, названный spring.ssc, и получившийся библиотечный блок и диалоговое окно.

component spring
  nodes
    r = foundation.mechanical.rotational.rotational;
    c = foundation.mechanical.rotational.rotational;
  end
  parameters
    k = { 10, 'N*m/rad' };
  end
  variables
    theta = { 0, 'rad' };
    t = { 0, 'N*m' };
    w = { 0, 'rad/s' };
  end
  branches
    t : r.t -> c.t;
  end
  equations
    assert(k>0)
    w == r.w - c.w;
    t == k * theta;
    w == theta.der;
  end
end

Если вы щелкаете по ссылке Source code, spring.ssc файл открывается в окне Editor MATLAB^®.

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

Настройте имя блока

Чтобы обеспечить более описательное имя для блока, чем имя файла компонента, поместите его на отдельную строку с комментариями чуть ниже component объявление. Строка с комментариями должна начаться с % символ. Целое содержимое этой линии, после % символ, интерпретирован как имя блока и появляется точно как этот в значке блока и наверху диалогового окна блока.

Например, если у вас есть следующий файл компонента:

component spring
%Rotational Spring
...
end

это получившийся значок блока и диалоговое окно:

Опишите цель блока

Предыдущий раздел описывает как строка с комментариями сразу после component объявление интерпретировано как имя блока. Любые дополнительные комментарии ниже той линии интерпретированы как описание блока. У вас может быть больше чем одна линия комментариев описания. Каждая линия больше не должна быть, чем 80 символов и должна начаться с % символ. Целое содержимое комментариев описания появится в диалоговом окне блока и в Браузере Библиотеки.

Например, если у вас есть следующий файл компонента:

component spring
%Rotational Spring
% This block implements a simple rotational spring.
...
end

это - получившееся диалоговое окно блока:

Чтобы создать конец абзаца в описании блока, используйте пробел, прокомментировала линия:

% end of one paragraph
% 
% beginning of the next paragraph

Задайте понятные имена для параметров блоков и переменных

Можно задать имя параметров блоков, способ, которым вы хотите, чтобы оно появилось в диалоговом окне блока как комментарий сразу после объявления параметра. Это может быть расположено на той же линии или на отдельной линии. Комментарий должен начаться с % символ.

Например, если у вас есть следующий файл компонента:

component spring
%Rotational Spring
% This block implements a simple rotational spring.
...
 parameters
    k = { 10, 'N*m/rad' }; % Spring rate
 end
...
end

это - получившееся диалоговое окно блока:

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

Например, если у вас есть следующий файл компонента:

component spring
%Rotational Spring
% This block implements a simple rotational spring.
...
  variables
    theta = { value = { 0 , 'rad' }, priority = priority.high }; % Deformation
    t = { 0, 'N*m' };   % Torque
    w = { 0, 'rad/s' }; % Angular velocity
  end
...
end

получившаяся вкладка Variables диалогового окна блока выглядит так:

Группа и параметры блоков переупорядочивания Используя аннотацию

По умолчанию пользовательский блок, сгенерированный от компонента, имеет все параметры компонента с ExternalAccess=modify перечисленный в объявлении заказывают в одной вкладке, названном Parameters. Если существуют переменные с ExternalAccess=modify, диалоговое окно блока также содержит отдельную вкладку Variables. Точно так же в Property Inspector, параметры и переменные перечислены в порядке объявления в двух отдельных древовидных узлах, Parameters и Variables.

Для комплексных компонентов с большими количествами параметров можно улучшить удобство пользования блока путем группировки параметров на основе их функции или на эффекте, который они моделируют. Например, можно разделить электрические и механические параметры для двигателя или поместить все температурно-зависимые параметры в отдельную группу. Вы делаете это при помощи аннотации блочного расположения, UILayout.

UILayout аннотация позволяет вам задать названные группы параметров компонента, порядок этих групп и порядок параметров в каждой группе. Когда вы развертываете компонент как пользовательский блок Simscape, эти группы переводят во вкладки диалогового окна (и в узлы дерева Property Inspector).

Синтаксис аннотации блочного расположения:

  annotations
    UILayout = [UIGroup("Title 1",p1,p2)
                UIGroup("Title 2",p3)]
  end

Следующие правила применяются:

Используйте аннотацию блочного расположения для:

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

Настройте названия и местоположение портов блока

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

Существует два способа управлять меткой порта и местоположением в значке блока:

  nodes
    p = foundation.electrical.electrical; % +
    n = foundation.electrical.electrical; % -  
  end

  inputs
     PS; %
  end

  nodes
    H = foundation.thermal.thermal;
    p = foundation.electrical.electrical; % +
    n = foundation.electrical.electrical; % -
  end
  annotations
    H : Side = top;
    p : Side = left;
    n : Side = right;
  end

    r = foundation.mechanical.rotational.rotational; % :top

nodes
   r = foundation.mechanical.rotational.rotational; 
   c = foundation.mechanical.rotational.rotational; 
end 

nodes
   r = foundation.mechanical.rotational.rotational; % rod
   c = foundation.mechanical.rotational.rotational; % case
end 

nodes
   r = foundation.mechanical.rotational.rotational; 
   c = foundation.mechanical.rotational.rotational; % c:right
end 

nodes
   r = foundation.mechanical.rotational.rotational; % rod
   c = foundation.mechanical.rotational.rotational; % case:right
end 

nodes
   r = foundation.mechanical.rotational.rotational; % rod
   c = foundation.mechanical.rotational.rotational; % :right
end 

nodes
   r = foundation.mechanical.rotational.rotational; % 
   c = foundation.mechanical.rotational.rotational; % case:right
end 

Настройте значок блока

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

Существует два способа задать значок пользовательского блока:

  annotations
    Icon = 'custom_spring.jpg';
  end

  annotations
    Icon = '../../block_icons/custom_spring.jpg';
  end

component MyPipe
  parameters
    thermal_variant = false; % Model thermal effects?
  end
  if thermal_variant 
  % Use icon with additional thermal port
    annotations
       Icon = 'pipe_thermal.jpg';
    end
  else
  % Use regular icon, with two fluid ports
    annotations
       Icon = 'pipe.jpg';
    end
  end
  [...] % Other parameters, variables, nodes, branches, equations
end

component name
% [ CustomName [ : scale [ : rotation ] ] ] 
...

component spring
% Rotational Spring : 0.5 : fixed