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

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

При создании пользовательского блока из файла 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

Если щелкнуть ссылку Исходный код, spring.ssc откроется в окне Редактор 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

это результирующее диалоговое окно блока:

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

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

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

итоговая вкладка «Переменные» диалогового окна блока выглядит следующим образом:

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

По умолчанию пользовательский блок, созданный из компонента, имеет все параметры компонента с ExternalAccess=modify в порядке объявления на одной вкладке с названием «Параметры». При наличии переменных с ExternalAccess=modifyдиалоговое окно блока также содержит отдельную вкладку «Переменные». Аналогично, в инспекторе свойств параметры и переменные перечисляются в порядке объявления в двух отдельных узлах дерева, «Параметры» и «Переменные».

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

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

Синтаксис аннотации компоновки блока:

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

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

Аннотация компоновки блока используется для:

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

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

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

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

  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