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

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

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

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

Используйте аннотацию размещения блоков для:

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

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

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

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

  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