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

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

Когда вы генерируете авторский блок из файла компонента 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 диалогового окна блока выглядит так:

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

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

Чтобы управлять меткой порта и местоположением в значке блока, добавьте комментарий сразу после соответствующего узла, введите или выведите объявление. Это может быть на той же строке или на отдельной строке. Комментарий должен начаться с символа % и быть формата label:location, где label является строкой, соответствующей имени входного порта в блок-схеме, и location является одной из следующих строк: left, right, top, bottom. Можно определить местоположение всех портов или на одной стороне блока или на двух противоположных сторонах, например, левых и правых, или верхних и нижних. Можно не использовать местоположение, если вы хотите сохранить местоположение по умолчанию порта (на левой стороне).

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

    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