Visual paradigm методичка

МИНИСТЕРСТВО ОБРАЗОВАНИЯ И НАУКИ РФ
Бийский технологический институт (филиал)
федерального государственного бюджетного образовательного учреждения высшего образования
«Алтайский государственный технический университет им. И.И. Ползунова»
Ю.Н. Ложкова
ПРЕДМЕТНО-ОРИЕНТИРОВАННЫЕ ЭКОНОМИЧЕСКИЕ
ИНФОРМАЦИОННЫЕ СИСТЕМЫ
Методические рекомендации по выполнению лабораторных работ по дисциплине «Предметно-ориентированные экономические информационные системы» для студентов, обучающихся по направлению подготовки 38.03.05 «Бизнес-информатика»
Бийск
Издательство Алтайского государственного технического университета им. И.И. Ползунова
2017

УДК 004.4:338.22(076)
ББК 32.973.26-018.2:65.050.2
Л71
Рецензент: Н.Ю. Ануфриева, к.т.н., доцент кафедры ЭП БТИ АлтГТУ
Л71
Ложкова Ю.Н.
Предметно-ориентированные экономические информационные системы: методические рекомендации по выполнению лабораторных работ по дисциплине «Предметно-ориентированные экономические информационные системы» для студентов, обучающихся по направлению подготовки 38.03.05 «Бизнес-информатика» / Ю.Н. Ложкова; Алт. гос. техн. ун-т, БТИ. – Бийск: Изд-во Алт. гос. техн. ун-та, 2017. – 45 с.
Методические указания к лабораторным работам подготовлены на кафедре
«Экономика предпринимательства» предназначены для студентов всех форм обучения направления бакалавриата 38.03.05
«Бизнес-информатика» и являются руководством к выполнению их студентами. В дальнейшем могут быть использованы в ходе дипломного проектирования, также они могут быть полезны преподавателям смежных дисциплин и разработчикам программного обеспечения.
УДК 004.4:338.22(076)
ББК 32.973.26-018.2:65.050.2
Методические рекомендации издаются в авторской редакции.
Рассмотрены и одобрены на заседании кафедры ЭП
Протокол № 169 от 01.09.2017 г.
© Ложкова Ю.Н., 2017
© БТИ АлтГТУ, 2017

СОДЕРЖАНИЕ
ВВЕДЕНИЕ ……………………………………………………………………………………………….. 4 1 ЛАБОРАТОРНАЯ РАБОТА № 1. ЗНАКОМСТВО С CASE-СРЕДСТВОМ
VISUAL PARADIGM FOR UML. РАЗРАБОТКА ДИАГРАММЫ
ВАРИАНТОВ ИСПОЛЬЗОВАНИЯ ……………………………………………………………. 5 2 ЛАБОРАТОРНАЯ РАБОТА № 2. РАЗРАБОТКА ДИАГРАММЫ
КЛАССОВ ……………………………………………………………………………………………….. 14 3 ЛАБОРАТОРНАЯ РАБОТА № 3. РАЗРАБОТКА ДИАГРАММЫ
СОСТОЯНИЙ ………………………………………………………………………………………….. 25 4 ЛАБОРАТОРНАЯ РАБОТА № 4. РАЗРАБОТКА ДИАГРАММЫ
ДЕЯТЕЛЬНОСТЕЙ ………………………………………………………………………………….. 29 5 ЛАБОРАТОРНАЯ РАБОТА № 5. РАЗРАБОТКА ДИАГРАММ
ВЗАИМОДЕЙСТВИЯ ………………………………………………………………………………. 32 6 ЛАБОРАТОРНАЯ РАБОТА 6. РАЗРАБОТКА ДИАГРАММЫ
КОМПОНЕНТОВ …………………………………………………………………………………….. 36 7 ЛАБОРАТОРНАЯ РАБОТА № 7. РАЗРАБОТКА ДИАГРАММЫ
РАЗМЕЩЕНИЯ ……………………………………………………………………………………….. 39 8 ПЕРЕЧЕНЬ ПРИМЕРНЫХ ВАРИАНТОВ ИНДИВИДУАЛЬНЫХ
ЗАДАНИЙ НА ЛАБОРАТОРНЫЕ РАБОТЫ ……………………………………………. 42
ЛИТЕРАТУРА …………………………………………………………………………………………. 43

4
ВВЕДЕНИЕ
Лабораторные работы по учебной дисциплине имеют своей целью:
− закрепление, углубление и расширение знаний студентов в процессе выполнения конкретных практических задач;
− овладение практическими приемами по учебной дисциплине на современном уровне;
− развитие у студентов профессиональных навыков, а также практическое овладение методами автоматизированной обработки данных;
− приобретение умений и навыков использования средств вычислительной техники при обработке данных.
Правила техники безопасности и охраны труда по комплексу
лабораторных работ: соответствуют правилам работы с электрическими приборами.
Общие правила к оформлению отчетов о работах: на первой странице пишется заглавие, указывается цель и объем работы в часах, ф.и.о. студента, группа, дата выполнения. Работа оформляется в последовательности, приведенной в методических указаниях. Текст работы оформляется на
ПЭВМ с использованием средств текстового процессора и выводится на принтер на листах формата А4 с соблюдением ГОСТ 2.105, ГОСТ 8.417 и
ГОСТ 7.1.
Лабораторные работы по дисциплине «Предметно-ориентированные экономические информационные системы» проходят в компьютерном классе с использованием case-средства визуального UML моделирования Visual
Paradigm for UML (VP-UML).
VP-UML предлагает объектно-ориентированный подход к анализу и проектированию систем различной сложности и позволяет создавать UML- диаграммы в полностью визуализированной среде разработки посредством простых drag&drop операций.
Основная цель методических указаний – способствовать получению студентами практических навыков в области проектирования информационных систем с использованием объектно-ориентированного подхода (с применением методологии UML).

5
1 ЛАБОРАТОРНАЯ РАБОТА № 1. ЗНАКОМСТВО С CASE-
СРЕДСТВОМ VISUAL PARADIGM FOR UML. РАЗРАБОТКА
ДИАГРАММЫ ВАРИАНТОВ ИСПОЛЬЗОВАНИЯ
Цель лабораторной работы: в ходе выполнения лабораторной работы студент должен ознакомиться с возможностями case-средства Visual
Paradigm for UML 7.1, освоить основные принципы создания диаграмм вариантов использования.
Задачи:
Изучить среду case-средства Visual Paradigm for UML 7.1.
Получить навыки создания диаграммы вариантов использования.
Общие сведения. Описание потоков событий и разработка вариантов
использования
На рисунке 1.1 показан пример диаграммы вариантов использования для предметной области «Поликлиника». На данной диаграмме человеческие фигурки обозначают действующих лиц (актеры/актанты), овалы – варианты использования (функции, реализуемые системой), а линии и стрелки — различные связи между актерами и вариантами использования.
Однако, для того чтобы фактически разработать систему, потребуются более конкретные детали. Эта детали описываются в документе, называемом
«поток событий» (flow of events). Целью потока событий является документирование процесса обработки данных, реализуемого в рамках варианта использования. Этот документ подробно описывает, что будут делать пользователи системы и что — собственно система. Хотя поток событий и описывается подробно, он не должен зависеть от реализации. Цель
– описать то, что (а не как) будет делать система.
Обычно поток событий включает:
− краткое описание;
− предусловия (pre-conditions);
− основной поток событий;
− альтернативный поток событий;
− постусловия (post-conditions).

6
Рисунок 1.1 – Диаграмма вариантов использования «Поликлиники»
Краткое описание
Каждый вариант использования должен иметь краткое описание того, что он будет делать. Например, вариант использования «Осуществить прием пациента» может содержать следующее описание:
Вариант использования «Осуществить прием пациента» позволяет врачу поставить диагноз осматриваемому пациенту, определить и назначить лечение, выписать в случае необходимости рецепт и/или листок по потере трудоспособности; медсестре занести информацию приема в личную карточку пациента; пациенту посетить в назначенное время врача.
Предусловия
Предусловия варианта использования – это такие условия, которые должны быть выполнены, прежде чем вариант использования начнет выполняться сам. Например, таким условием может быть выполнение другого варианта использования или наличие у пользователя прав доступа, требуемых для запуска данного. Не у всех вариантов использования бывают предусловия. С помощью предусловий можно документировать порядок выполнения диаграмм использования. Так, предусловием одного варианта использования может быть то, что в это время должен выполняться другой.
Предусловием варианта использования «Осуществить прием пациента» является выполнение вариантов использования «Оформить карточку

7 пациента», «Зарегистрировать страховой полис» и «Оформить талон на прием к врачу».
Основной и альтернативный потоки событий
Конкретные детали вариантов использования описываются в основном и альтернативных потоках событий. Поток событий поэтапно описывает, что должно происходить во время выполнения заложенной в варианты использования функциональности. Поток событий уделяет внимание тому, что будет делать система, а не как она будет делать это, причем описывает все это с точки зрения пользователя. Основной и альтернативный потоки событий включают следующее описание: каким образом запускается вариант использования; различные пути выполнения варианта использования; нормальный, или основной, поток событий варианта использования; отклонения от основного потока событий
(так называемые альтернативные потоки); потоки ошибок; каким образом завершается вариант использования.
Например, поток событий варианта использования «Осуществить прием пациента» может выглядеть следующим образом:
Основной поток
Вариант использования начинается, когда пациент приходит на прием к врачу.
Пациент должен передать врачу талон на прием. Если талон отсутствует, то выполняется альтернативный поток событий А1.
Врач уточняет у пациента, является ли прием первым. Если прием повторный, то врач просматривает результаты проведенных анализов.
Врач выслушивает жалобы пациента.
Врач/медсестра вносит сведения в личную карточку пациента.
Полученных сведений достаточно для постановки диагноза. Если информации недостаточно, то альтернативный поток событий А2.
Врач ставит диагноз пациенту.
Врач определяет вид лечения для пациента.
Врач назначает лекарство пациенту. Если на лекарство требуется рецепт, то выполняется альтернативный поток событий А3.
Врач уточняет необходимость открытия листка потери трудоспособности. Если такая необходимость существует, то выполняется альтернативный поток событий А4.
Вариант использования завершается.
Альтернативный поток А1. Пациент не оформил талон на прием к врачу
Врач информирует пациента о том, что обязательным условием посещения врача является наличие талона амбулаторного пациента, оформляемого в регистратуре.
Врач возвращает пациенту медицинскую карточку.

8
Вариант использования завершается.
Альтернативный поток А2. Информации для постановки диагноза недостаточно
Врач выписывает направления на анализы.
Медицинская карточка пациента остается у лечащего врача.
Вариант использования завершается.
Альтернативный поток А3. Требуется рецепт на лекарство
На специальном бланке за подписью и печатью врача, с указанием даты, выписывается рецепт на требуемое лекарство.
Вариант использования завершается.
Альтернативный поток A4. Врач открывает листок по потере трудоспособности
1. На бланке строгой отчетности врач указывает дату открытия документа.
На основании поставленного диагноза определяется срок потери трудоспособности.
Листок потери трудоспособности регистрируется в регистратуре.
Вариант использования завершается.
Постусловия
Постусловиями называются такие условия, которые, если они существуют в потоке событий, всегда должны быть выполнены после завершения варианта использования. например, в конце варианта использования можно пометить флажком какой-нибудь переключатель.
Информация такого типа вводит в состав постусловий. Как и для предусловий, с помощью постусловий можно вводить информацию о порядке выполнения вариантов использования системы. Если, например, после одного из вариантов использования должен всегда выполняться другой, это можно описать как постусловие. Такие условия имеются не у каждого варианта использования.
Постусловием варианта использования «Осуществить прием пациента» является выполнение варианта использования «Пройти назначенное лечение».
Разработка диаграммы вариантов использования в Visual Paradigm for
UML
Visual Paradigm for UML (VP-UML) представляет собой case-средство визуального
UML-моделирования.
VP предлагает объектно- ориентированный подход к анализу и проектированию систем различной сложности и позволяет создавать множество типов диаграмм в полностью визуализированной среде разработки посредством простых drag&drop операций.
При запуске VP-UML предложит открыть существующий проект или выбрать тип вновь создаваемой диаграммы (рисунок 1.2).

9
Рассмотрим подробнее некоторые особенности создания диаграмм в
Visual Paradigm for UML.
Диаграммы в VP-UML можно создавать как в оконном, так и в полноэкранном режиме.
Переключение в полноэкранный режим производится выбором в меню «View» команды «Full Screen» или нажатием клавиши «F11». Повторное выполнение команды возвращает оконный режим проектирования.
Рисунок 1.2 – Стартовое окно Visual Paradigm for UML 7.1 Community Edition
VP-UML позволяет создавать элементы диаграмм и связи графическим способом с помощью мыши. Для этого в программе существуют определенные графические знаки – «жесты», рисуя которые, пользователь может получить необходимую фигуру в области построения простым движением мыши, не прибегая к использованию панели элементов и прочих меню. Чтобы получить таким образом элемент, нужно зажать правую кнопку мыши и нарисовать один из графических знаков.
Для создания новой диаграммы вариантов использования нужно выбрать соответствующую строку в списке вновь создаваемых диаграмм (в нашем случае – «New Use Case Diagram»).
После создания новой диаграммы определится её имя (см. рисунок 1.3).
Рисунок 1.3 – Назначение нового имени

10
Для создания элемента следует выбрать его в панели объектов диаграммы щелчком мыши, затем, вторым щелчком на области построения элемент может быть добавлен в диаграмму (рисунок 1.4).
Рисунок 1.4 – Создание актера
После создания очередного элемента, ему присваивается имя по умолчанию, которое может быть изменено сразу или впоследствии, по двойному щелчку на элементе. Имя (и другие свойства) также можно задать в панели свойств объектов (Property) в левой части окна программы (рисунок
1.5).
Рисунок 1.5 – Окно свойств «Создание связей»
Для создания новой связи выберите тип связи в панели объектов, щелкните на объекте-источнике, далее – на связываемом с ним объекте.

11
При построении связей следует учитывать, что в VP-UML имеется функция автоматической проверки синтаксиса UML, которая не позволяет создавать неверные связи между объектами (см. рисунок 1.6).
Рисунок 1.6 – Процесс проверки
Каждый существующий объект диаграммы имеет ресурсоориентированный интерфейс, позволяющий создавать новый, связанный с ним, объект или связь (рисунок 1.7).
Рисунок 1.7 – Создание нового варианта использования
Для каждой связи можно установить собственный стиль. Для этого необходимо в контекстном меню связи выбрать Styles and Formatting –
Connector Style и в появившемся списке выбрать один из шести предложенных типов.
В этом же меню задается стиль отображения подписи связи (только по горизонтали, По горизонтали и вертикали, Параллельно линии связи и т. д.)
(рисунок 1.8).

12
Рисунок 1.8 – Определение стиля (первый вариант)
Второй способ задания стиля отображения связи – через панель свойств объектов диаграммы. Сначала в области диаграммы выбирается связь, затем, в панели свойств, определяется ее стиль (рисунок 1.9).
Рисунок 1.9 – Определение стиля (второй вариант)
Экспорт диаграммы
Готовую диаграмму можно полностью или частично копировать в формате изображения JDG или EMF в буфер обмена для экспорта в другое приложение. Для этого следует выделить нужные объекты или всю диаграмму (Ctrl+A) и в контекстном меню выбрать команду «Copy – Copy to

13
Clipboard as Image». Данная команда дублируется комбинацией клавиш
Ctrl+Alt+C. После выполненных действий изображение диаграммы готово к вставке в другом приложении.
Иногда, если диаграмма слишком большая, возникает необходимость ориентироваться в ней. Для этого в VP-UML предназначена панель просмотра области диаграммы (Diagram Overview), расположенная в виде вкладки, соседней по отношению к вкладке свойств объектов диаграммы.
Панель просмотра показывает всю область построения диаграммы, выделяя ту ее часть, которую видит в данный момент пользователь.
Сохранение проекта
В рамках одного проекта можно создавать множество диаграмм различных типов. Доступ к диаграммам проекта осуществляется c помощью
Навигатора (Diagram Navigator), представляющего собой иерархический список в левой части окна программы.
Для сохранения вашего проекта выберите пункт меню File – Save Project, открывающий диалог сохранения проекта.
Содержание работы
Ознакомиться с теоретическими вопросами построения диаграммы вариантов использования.
Построить с помощью программного средства Visual Paradigm for UML
7.1 диаграмму вариантов использования для предметной области
«Поликлиника».
Осуществить построение диаграммы вариантов использования согласно индивидуальному заданию.
Подготовить отчет по созданным диаграммам.
Требования к отчету
Отчет по лабораторной работе оформляется в печатном виде. Защита лабораторной работы включает в себя проверку знания студентом теоретического материала, а также практической части лабораторной работы.
Отчет должен включать: название работы, ее задачи и описание последовательности выполнения; документ «Поток событий»; диаграмму вариантов использования для предметной области согласно выданному индивидуальному заданию.

14
2 ЛАБОРАТОРНАЯ РАБОТА № 2.
РАЗРАБОТКА ДИАГРАММЫ КЛАССОВ
Цель работы: Изучить теоретические основы создания диаграммы классов. Освоить принципы построения диаграммы классов в Visual Paradigm for UML 7.1.
Задачи:
− Научиться создавать классы.
− Изучить основные стереотипы классов.
− Научиться устанавливать отношения между классами.
− Разработка диаграммы классов
Диаграмма классов определяет типы классов системы и различного рода статические связи, которые существуют между ними. На диаграммах классов изображаются также атрибуты классов, операции классов и ограничения, которые накладываются на связи между классами.
Класс описывает группу объектов системы, имеющих одинаковые свойства (атрибуты), схожее поведение (операции), типы отношений с другими объектами и семантику.
Стереотипы – это механизм, позволяющий разделять классы на категории. В языке UML основными стереотипами являются:
Boundary (граничный класс) – это классы, объекты которых расположены на границе системы и окружающей среды. Они включают все формы, отчеты, интерфейсы с аппаратурой (такой, как принтеры или сканеры) и другими системами.
Entity (классы-сущности) моделируют основные понятия (абстракции) предметной области, содержащие долгоживущую, нередко сохраняемую информацию. Обычно для каждого класса-сущности создают таблицу в базе данных.
Control (управляющие классы) отвечают за координацию, порядок последовательности, взаимодействия других классов. Обычно у каждого варианта использования имеется один управляющий класс, контролирующий последовательность событий этого варианта использования.
Диаграмма классов предметной области «Поликлиника» показана на рисунке 2.1.

15
Рисунок 2.1 – Диаграмма классов предметной области «Поликлиника»
Класс «Пациенты» предназначен для хранения в нем информации о пациентах, прикрепленных к поликлинике. В нижней части класса содержатся операции, выполняемые над его объектами (атрибутами), в данном случае – над сведениями о пациентах. Класс «Врачи» содержит информацию о врачах поликлиники. В классе «Лечение» содержатся сведения о лечении каждого конкретного пациента. Классы «Вид лечения» и
«Тип врача» имеют стереотип «Enumeration» (перечисление).
Класс «Отделения» служит для хранения в нем справочной информации об отделениях поликлиники. Класс «Участок» предназначен для хранения в нем справочной информации об участках города, обслуживаемых поликлиникой. Классы «Больничные листы», «Талоны» и «Рецепты» связаны связью агрегации с классом «Прием пациентов». Класс «Тумба» является граничным классом. Класс «Платные услуги» является дочерним класса
«Услуги».
Разработка диаграммы классов в Visual Paradigm for UML
1. Для создания диаграммы классов средствами VP-UML в новом проекте необходимо в списке диаграмм (UML Diagrams), находящемся в правой части стартовой страницы проекта выбрать строку New Class Diagram. Для

16 добавления новой диаграммы в существующий (открытый) проект достаточно в меню File New Diagram UML Diagrams выбрать тип создаваемой диаграммы или нажать соответствующую диаграмме кнопку панели инструментов Diagram (см. рисунок 2.2).
2. Задаем имя созданной диаграмме классов: «Поликлиника».
Рисунок 2.2 – Окно создания новой диаграммы классов
3. Построение диаграммы начнем с создания класса «Прием пациентов».
Для этого, в панели объектов, необходимо щелчком мыши выбрать элемент «Class», затем вторым щелчком на области построения диаграммы добавить элемент в диаграмму и определить ему имя «Приём пациентов».
Созданный класс имеет стандартный, прямоугольный вид (рисунок 2.3).
Рисунок 2.3 – Класс «Прием пациентов»
Класс «Приём пациентов» содержит атрибуты и операции согласно рисунку 2.3. Для добавления атрибута выберите пункт контекстного меню класса Add – Attribute или, выделив класс, нажмите Alt+Shift+A.

17
Примечание. Атрибуты класса могут иметь определенный тип (типы атрибутов класса аналогичны основным типам переменных в программировании), который задается свойством Type атрибута в инспекторе свойств (рисунок 2.4).
Рисунок 2.4 – Задание типов атрибутов
Добавить операцию в класс можно выбрав в контекстном меню класса команду Add – Operation, или комбинацией Shift+Alt+O (элемент должен быть предварительно выделен).
4. Следующий шаг – создание класса «Пациент». Воспользуемся для этого встроенным меню класса «Приём пациентов», которое доступно после выделения элемента мышью. В меню кликните по иконке, соответствующей команде создания нового элемента (Generic Resource) (рисунок 2.5).
Рисунок 2.5 – Команды создания нового связанного элемента

18
Для создания нового класса, связанного с существующим посредством ассоциации, выберите команду Association – Class меню создания элемента
(рисунок 2.6).
Рисунок 2.6 – Окно создания ассоциации
Результатом выполнения команд является новый класс диаграммы, связанный с классом «Приѐм пациентов» посредством ассоциации (рисунок
2.7).
Рисунок 2.7 – Создание класса «Пациент», связанного с классом «Прием пациентов»

19
Задайте новому классу имя «Пациент».
Примечание. Для каждого элемента диаграммы можно выбрать способ привязки маркера связи. Способ привязки определяется в окне «Выбор стиля маркера связи» (Select Connection Point Style), доступ к которому осуществляется командой Styles and Formatting –– Connection Point… контекстного меню элемента или группы элементов диаграммы. В окне можно выбрать один из стилей — привязка по контуру элемента (Round the shape) или привязка к центру (Follow center) (рисунок 2.8).
Рисунок 2.8 – Окно выбора способа привязки маркера связи
Примечание. Привязку связи элемента (группы элементов) можно настроить и в инспекторе свойств левой части окна программы (рисунок 2.9) или вручную, перетаскивая и «прикрепляя» связь к элементу нажатием специальной кнопки (рисунок 2.10).
Рисунок 2.9 – Определение типа привязки в инспекторе свойств

20
Рисунок 2.10 – Настройка «вручную»
Теперь настроим кратность (multiplisity) ассоциации элементов «Приём пациентов» и «Пациент». Кратность настраивается определением ее параметров в окне «Свойства ассоциации» (Association Specification), открыть которое можно командой контекстного меню ассоциации «Open
Specification…», или выделив нужную ассоциацию и нажав клавишу «Enter».
В верхней части окна можно задать кратность ассоциации для источника
(свойство Multip случае кратность равна 1 (всегда только один объект).
В нижней части окна свойств ассоциации задается кратность для приемника (значение 1 для элемента «Пациент») (рисунок 2.11).
Рисунок 2.11 – Задание кратности для источника
В нижней части окна свойств ассоциации задается кратность для приемника (значение 1 для элемента «Пациент») (рисунок 2.12).

21
Рисунок 2.12 – Задание кратности для источника
Аналогично пп. 4 и 5, согласно рисунку 2.12, создайте классы:
«Участок», «Адреса» «Врач», «Отделение», «Кабинет», «График дежурств»,
«Лечение», «Рецепты», «Больничные листы», «Талоны» и «Платные услуги».
Определите созданным классам соответствующие атрибуты и операции.
Добавьте в диаграмму класс «Тип врача». В нашем случае, данный элемент имеет стереотип Enumeration (перечисление). В терминологии UML в основе понятия «стереотип» заложено расширение словаря UML, позволяющее разработчику создавать новые типы строительных блоков, порождая их от существующих.
Чтобы определить классу стереотип перечисления, выполните команду
«Stereotypes Stereotypes» контекстного меню элемента и примените к классу находящийся в списке слева стереотип «enumeration» (рисунок 2.13).

22
Рисунок 2.13 – Задание стереотипа
Закройте окно свойств класса нажатием кнопки «ОК».
Таким образом, класс приобрел стереотип перечисления, о чем свидетельствует метка << enumeration >> в его заголовке (рисунок 2.14).
Рисунок 2.14 – Назначение стереотипа << enumeration >> классу «Тип врача»
Процесс создания класса «Вид лечения» аналогичен созданию класса
«Тип врача».
Последний создаваемый класс в рамках данного задания – «Терминал».
Этот объект является граничным классом (boundary), то есть служит для моделирования взаимодействия между системой и ее актантами
(пользователями).
Для определения классу стереотипа Boundary выполните команду
Stereotypes boundary контекстного меню класса (см. рисунок 2.15).

23
Рисунок 2.15 – Присвоение стереотипа «Boundary»
В результате, класс «Терминал» приобретает следующий вид (рисунок
2.16).
Рисунок 2.16 – Класс «Терминал»
9. Для связывания родительского («Услуги») и дочернего («Платные услуги») класса выберите в панели элементов тип связи «Обобщение»
(Generalization), затем щелкните мышью на классе «Услуги» и, не отпуская клавиши, проведите связь к потомку. Задайте имя связи «наследует» (см. рисунок 2.17).
Рисунок 2.17 – Создание родительского и дочернего классов

24 10. Лечение не может быть назначено пациенту без предварительного осмотра его на приёме, поэтому между классами «Приём пациентов» и
«Лечение» необходимо определить композицию. Для этого выделите класс
«Приём пациентов» и выполните команду Composition – Class встроенного меню элемента (рисунок 2.18).
Рисунок 2.18 – Задание композиции
Выполнение команды откроет окно, где нужно ввести имя класса, к которому строиться связь. Если класс, который необходимо включить в композицию, уже создан в области построения, программа, после ввода первых символов имени, предложит выбрать его из списка (рисунок 2.19).
Рисунок 2.19 – Предлагаемый список классов для подстановки
Для построенной композиции определите имя – «создает».
Талоны, рецепты и больничные листы являются неотъемлемой частью приёма, но могут существовать и после его завершения. Поэтому класс
«Приём пациентов» связан с классами «Талоны», «Рецепты» и «Больничные листы» отношением агрегации.
Наконец, определите согласно рисунку 2.1, оставшиеся отношения между классами диаграммы, указав в случае необходимости их кратность.
Конечный вид построенной вами диаграммы классов должен соответствовать модели анализа, представленной на рисунке 2.1.
Сохраните диаграмму/проект.

25
Содержание работы
1. Ознакомиться с теоретическими вопросами построения диаграммы классов.
2. Построить с помощью программного средства Visual Paradigm for
UML диаграмму классов для предметной области «Поликлиника».
3. Осуществить построение диаграммы классов согласно индивидуальному заданию.
4. Продемонстрировать преподавателю созданные диаграммы.
Требования к отчету
Отчет по лабораторной работе оформляется в печатном виде. Защита работы включает в себя проверку знания студентом теоретического материала, а также практической части лабораторной работы.
Отчет должен включать:
− диаграмму классов для предметной области согласно выданному индивидуальному заданию;
− описание каждого класса (его назначение, описание атрибутов, операций);
− описание связей между классами.
Все примеры должны быть сохранены на сетевом диске или на диске студента.
3 ЛАБОРАТОРНАЯ РАБОТА № 3.
РАЗРАБОТКА ДИАГРАММЫ СОСТОЯНИЙ
Цель работы: Изучить теоретические основы создания диаграммы состояний. Освоить принципы построения диаграммы состояний в Visual
Paradigm for UML 7.1.
Задачи:
1. Изучить основные типы состояний.
2. Научиться создавать состояния.
3. Научиться создавать переходы.
4. Разработка диаграммы состояний
На рисунке 3.1 показана диаграмма состояний для класса «Врач». На рисунке 3.2 приводится пример диаграммы состояний для пациента, на которой можно наблюдать процесс перехода пациента из одного состояния в другое.
На диаграмме имеются два специальных состояния – начальное (start) и конечное (stop). На диаграмме состояний может быть одно и только одно начальное состояние. В тоже время может быть столько конечных состояний, сколько вам нужно, или их может не быть вообще. Когда объект находится в каком-то конкретном состоянии; могут выполняться различные процессы.
Процессы, происходящие в момент, когда объект находится в определенном состоянии, называются действиями (actions). Заключенное в квадратных

26 скобках условие (сторожевое условие, guard condition) определяет, когда может произойти переход из одного состояния в другое (рисунок 3.1).
Рисунок 3.1 – Диаграмма состояний для класса «Врач»
Рисунок 3.2 – Диаграмма состояний для класса «Пациент»
Разработка диаграммы состояний в Visual Paradigm for UML
1. Для создания диаграммы состояний в проекте VP-UML, выберите пункт State Machine Diagram стартового окна проекта, или выполните команду File New Diagram — UML Diagrams — State Machine Diagram главного меню существующего проекта. Выполнение команды откроет

27 соответствующую панель элементов и пустую область построения, разместив на ней начальное состояние
2. Построим диаграмму состояний для класса «Пациент».
Согласно рисунку 3.2, класс имеет состояния: «Незарегистрированный»,
«Зарегистрированный», «Записан на прием», «На приеме», «Лечится,
Вылечен». Вынесем на область построения элемент «Состояние» (State) и присвоим его имени значение «Незарегистрированный». Далее, свяжем созданный элемент с начальным состоянием (см. рисунок 3.3) посредством перехода (кнопка панели инструментов).
Рисунок 3.3 – Событие «Незарегистрированный»
Аналогично добавьте в диаграмму состояние «Зарегистрированный», при этом пациент может переходить в данное состояние как из начального, так и из состояния «Незарегистрированный». При переходе из состояния
«Незарегистрированный» обязательным условием перехода является сторожевое событие «Оформитъ карточку», что нужно учесть при задании имени перехода.
Далее, создайте состояние «Записан на приём». На рисунке 3.2 видно, что в данном состоянии происходят определенные действия. Добавить действия в элемент состояния можно посредством определения значений полей Entry,
Do и Exit Activity вкладки General окна свойств элемента (рисунок 3.4).
Рисунок 3.4 – Состояние «Записан на приём»
При нажатии кнопки «Edit» поля действия открывается окно его свойств, в котором определяются имя действия, а также пред- и постусловия, при их наличии (рисунок 3.5).

28
Рисунок 3.5 – Основные свойства действия состояния «Записан на приём»
Более удобный способ доступа к настройкам действий обеспечивает инспектор свойств элементов, расположенный в левой части окна программы.
Состояния «На приёме», «Лечится» и «Вылечен», с соответствующими событиями и условиями строятся аналогично описанным лабораторной работе № 2.
В итоге, диаграмма состояний класса «Пациент» имеет вид, представленный на рисунке 3.2.
Диаграмма состояний для моделирования поведения врача представлена на рисунке 3.1 и строится аналогично предыдущей диаграмме.
Отличительной особенностью данной диаграммы является наличие составных состояний, для создания которых достаточно в панели инструментов выбрать
Примечание. Графический способ построения позволяет создавать не только объекты диаграммы, но и связи между ее элементами. Для построения связи между существующими элементами в рамках любого вида диаграммы достаточно зажав правую клавишу мыши провести линию от исходного элемента к конечному.
Примечание. Дополнительно, функция позволяет создавать новые, связанные объекты. Такой элемент создается проведением графического маркера от существующего элемента в пустую область диаграммы, с последующим выбором в отобразившемся меню типа связи и вида связываемого объекта.
Примечание. В масштабе элементов функция реализует добавление атрибутов (направление линии — справа-налево) и операций (слева-направо).

29
Содержание работы
1. Ознакомиться с теоретическими вопросами построения диаграмм состояний.
2. Построить с помощью программного средства Visual Paradigm for
UML диаграмму состояний для предметной области «Поликлиника».
3. Осуществить построение диаграммы состояний согласно индивидуальному заданию.
Требования к отчету
Отчет по лабораторной работе оформляется в печатном виде. Защита работы включает в себя проверку знания студентом теоретического материала, а также практической части лабораторной работы.
Отчет должен включать:
− диаграмму состояний для предметной области согласно выданному индивидуальному заданию;
− описание разработанной диаграммы.
Все примеры должны быть сохранены на сетевом диске или на диске студента.
4 ЛАБОРАТОРНАЯ РАБОТА № 4.
РАЗРАБОТКА ДИАГРАММЫ ДЕЯТЕЛЬНОСТЕЙ
Цель работы: в ходе выполнения лабораторной работы студент должен освоить основные принципы создания диаграммы деятельностей.
Задачи:
1. Изучить основные компоненты диаграммы деятельностей.
2. Научиться создавать диаграмму деятельностей.
3. Разработка диаграммы деятельностей
Диаграммы деятельностей особенно полезны в описании поведения, включающего большое количество параллельных процессов. Самым большим достоинством диаграмм деятельностей является поддержка параллелизма. Самый большой их недостаток заключается в том, что связи между действиями и объектами просматриваются недостаточно четко.
На рисунке 4.1 представлена диаграмма деятельностей для сотрудника регистратуры. Деятельность сотрудника начинается, когда пациент впервые приходит в поликлинику для прохождения медицинского обслуживания.
Пациент обращается в регистратуру. Сотрудник регистратуры уточняет, зарегистрирован ли пациент в поликлинике. Если нет, то необходимо оформить пациенту новый бланк и внести в него паспортные сведения и данные страхового полиса. Затем сотрудник регистратуры по адресу прописки гражданина определяет номер участка пациента, тем самым, прикрепляя его за определенными врачами. Деятельность регистратора по оформлению пациента на прием к врачу начинается, когда пациент обращается в регистратуру с просьбой о приеме у определенного

30 специалиста. Регистратор определяет время работы нужного врача. Затем формирует пациенту талон амбулаторного больного. На этом деятельность завершается.
Рисунок 4.1 – Диаграмма деятельностей сотрудника регистратуры
Разработка диаграммы деятельностей в Visual Paradigm for UML
Нажатием соответствующей кнопки на панели Diagram создайте область построения для диаграммы деятельностей и присвойте ей имя «Деятельность сотрудника регистратуры». С помощью элементов диаграммы деятельности, представленной на рисунке 4.1, постройте диаграмму деятельностей сотрудника регистратуры, используя элементы (рисунок 4.2).

31
Рисунок 4.2 – Элементы диаграммы деятельностей в Visual Paradigm for UML
Содержание работы
1. Ознакомиться с теоретическими вопросами построения диаграмм деятельностей.
2. Построить с помощью программного средства Visual Paradigm for
UML диаграмму деятельностей для предметной области «Поликлиника».
3. Осуществить построение диаграммы деятельностей согласно индивидуальному заданию.
Требования к отчету
Отчет по лабораторной работе оформляется в печатном виде. Защита работы включает в себя проверку знания студентом теоретического материала, а также практической части лабораторной работы.
Отчет должен включать:
− диаграмму деятельностей для предметной области согласно выданному индивидуальному заданию;
− описание разработанной диаграммы;
− ответы на контрольные вопросы.
Все примеры должны быть сохранены на сетевом диске или на диске студента.

32
5 ЛАБОРАТОРНАЯ РАБОТА № 5
РАЗРАБОТКА ДИАГРАММ ВЗАИМОДЕЙСТВИЯ
Цель работы: Освоить технологию создания диаграмм взаимодействия.
Задачи:
1. Изучить основные компоненты диаграммы последовательности.
2. Научиться создавать диаграмму последовательности.
3. Научиться создавать диаграмму коммуникации.
4. Диаграммы взаимодействия
Диаграммы взаимодействия описывают поведение взаимодействующих групп объектов. Как правило, диаграмма взаимодействия охватывает поведение объектов в рамках только одного варианта использования. На такой диаграмме отображается ряд объектов и те сообщения, которыми они обмениваются между собой.
Для моделирования различных аспектов взаимодействия объектов в языке UML используются соответствующие диаграммы: взаимодействия объектов можно рассматривать во времени, тогда для представления временных особенностей передачи и приема сообщений между объектами используется диаграмма последовательности (sequence diagram); можно рассматривать структурные особенности взаимодействия объектов. Для представления структурных особенностей передачи и приема сообщений между объектами используется диаграмма коммуникации
(communication diagram). В нотации UML 1.x она носит название «диаграмма кооперации» (collaboration diagram).
Диаграмма последовательности
Диаграммы последовательности отражают поток событий, происходящих в рамках варианта использования. Нормальный сценарий оформления талона на прием показан на рисунке 5.1. Под сценарием понимается конкретный экземпляр потока событий.
Рисунок 5.1 – Фрагмент диаграммы последовательности

33
Разработка диаграммы последовательности в Visual Paradigm for UML
Для создания диаграммы последовательности выберите пункт New
Sequence Diagram стартового окна проекта, либо, в главном меню программы, пункт File New Diagram UML Diagrams Sequence Diagram.
Добавить новую диаграмму последовательности в проект также можно нажатием соответствующей кнопки (New Sequence Diagram) панели инструментов Diagram.
После создания области построения определите ей имя «Приём пациента».
Построение диаграммы начнем с последовательного размещения на ней объектов, с одновременным определением сообщений, которыми взаимосвязанные элементы системы обмениваются между собой в процессе своего функционирования.
Первым объектом последовательности является «Пациент».
«Пациент» — актант, инициирующий действия объектов системы. Для создания актера, выберите в панели элементов соответствующий объект – после чего щелкните мышью в области построения (по умолчанию, вместе с объектом создается принадлежащая ему линия жизни).
«Пациент» инициирует функционирование системы, отправляя
«сообщение» актеру «Сотрудник регистратуры». Для отображения сообщений в диаграмме последовательности используют линии-стрелки.
По аналогии с п.1 добавьте в диаграмму действующее лицо «Сотрудник регистратуры», расположив его правее созданного ранее.
Следующий объект проектируемой последовательности варианта использования – «Карточки пациентов». Добавить подобный элемент в диаграмму можно посредством выбора его в панели объектов
(прямоугольник со штрихпунктирной линией – стандартное отображение объекта в диаграмме последовательности), и последующим щелчком на области построения.
Элемент последовательности «Приём» добавляется в диаграмму аналогично предыдущему.
Наконец, создайте объект «Врач», представляющий собой, как и объект
«Пациент», актанта системы.
Пользуясь объектным меню и согласно Рисунок, создайте сообщения между актантами «Пациент» и «Сотрудник регистратуры».
Программа предложит список, из которого можно выбрать линию жизни объекта, принимающего сообщение (или создать новый объект – пункт New
LifeLine списка).
Примечание. Сообщения также могут быть созданы посредством выбора соответствующего объекта панели инструментов диаграммы.
После создания, сообщения можно перемещать по линиям жизни указателем мыши, устанавливая тем самым требуемое время выполнения операций.

34
Остальные сообщения последовательности создаются по аналогии.
Диаграмма коммуникации
Структура взаимодействия объектов проектируемой системы представлена на рисунке 5.2.
Рисунок 5.2 – Структура взаимодействия объектов системы
Разработка диаграммы коммуникации в Visual Paradigm for UML
Для создания диаграммы коммуникаций в открытом проекте достаточно выбрать в панели Diagram кнопку с соответствующей пиктограммой
(рисунок 5.3).
Рисунок 5.3 – Создание диаграммы коммуникаций
1. Для вновь созданной диаграммы введите имя «Приём пациентов».
Элементами диаграммы, в рамках данного задания, являются следующие объекты:
– актант, участвующий во взаимодействии;
– экземпляр конкретного классификатора взаимодействия.

35 2. Создайте объекты actor («Пациент», «Сотрудник регистратуры» и
«Врач») и LifeLine («Приём» и «Карточки пациентов»). Расположите их в области построения в соответствии с рисунком 5.2.
Примечание.
Добавление различных объектов в диаграмму коммуникации ничем не отличается от аналогичных рассмотренных выше процедур для объектов других диаграмм.
3. Определите связи между всеми объектами коммуникации (рисунок
5.4).
Рисунок 5.4 – Задание связей на диаграмме коопераций
4. Классификатор «Карточки пациентов» имеет дугу, означающую самоделегирование.
Примечание.
Самоделегирование распространено в объектно- ориентированных системах. Объекты предлагают ряд открытых сервисов
(открытых операций), которые могут быть вызваны клиентскими объектами.
Но, как правило, они также имеют и закрытые «вспомогательные» операции, разработанные специально для вызова самим объектом. В данном примере линия жизни «Карточки пациентов» посылает себе сообщение «Найти карточку», чтобы найти карту пациента, если таковая существует. Закрытые операции объекта могут быть вызваны только самим объектом средствами самоделегирования.
Для создания дуги выберите в панели элементов диаграммы, затем щелкните на объекте, для которого её следует определить («Карточки пациентов») и, удерживая клавишу мыши, завершите связь на том же объекте.
5. Для создания сообщения, выберите объект элементов, после чего щелкните на связи, через которую осуществляется передача сообщения
(например, между объектами «Пациент» и «Сотрудник регистратуры»).

36
После того, как связь создана, программа предложит ввести её имя. Все сообщения на диаграмме коммуникации автоматически нумеруются в порядке их отправления/получения. После создания сообщения, связь выглядит следующим образом.
Примечание. Графический символ сообщений (стрелку) и их заголовки можно свободно перемещать по области построения мышью, обеспечивая тем самым диаграмме необходимый внешний вид.
6. Сообщение-ответ создается выбором объекта панели инструментов и последующим щелчком мыши на связи между объектами взаимодействия.
Создайте сообщения для остальных участников коммуникации.
Сохраните проект.
Содержание работы
1. Ознакомиться с теоретическими вопросами построения диаграмм взаимодействия.
2. Построить с помощью программного средства Visual Paradigm for
UML диаграмму последовательности для предметной области
«Поликлиника».
3. Построить с помощью программного средства Visual Paradigm for
UML диаграмму коммуникации для предметной области «Поликлиника».
4. Осуществить построение диаграмм взаимодействия согласно индивидуальному заданию.
Требования к отчету
Отчет по лабораторной работе оформляется в печатном виде. Защита лабораторной работы включает в себя проверку знания студентом теоретического материала, а также практической части.
Отчет должен включать:
− диаграмму последовательности для предметной области согласно выданному индивидуальному заданию;
− диаграмму коммуникации предметной области согласно индивидуальному заданию; описание разработанных диаграмм.
Все примеры должны быть сохранены на сетевом диске или на диске студента.
6 ЛАБОРАТОРНАЯ РАБОТА 6

Загрузите последнюю версию Visual Paradigm

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

Шаги по рисованию диаграммы активности

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

• Найдите системные актеры, классы и варианты использования

• Определите ключевые сценарии для вариантов использования системы

• Объедините схему, описанную на диаграмме действий, для создания комплексного рабочего процесса.

• Когда рабочий процесс вызывает поведение важного объекта, добавьте поток объектов на диаграмму.

• Рабочий процесс пересекает технические границы и использует дорожки для отображения действий

• Подобно сложным расширенным действиям, вложенные диаграммы действий

Создать диаграмму активности

1. Нажмите «Создать»> «Новая диаграмма» на панели инструментов.

   

2. В окне «Новая диаграмма» выберите «Диаграмма активности» и нажмите «Далее». Вы можете использовать строку поиска выше, чтобы отфильтровать диаграмму.

   

3. Дайте диаграмме имя и нажмите «ОК». В этом руководстве диаграмма будет называться «Учебник по диаграмме действий». Затем вы увидите пустой график.

   

4. Выберите вертикальную дорожку и щелкните любую пустую область на диаграмме.

   

   Если вы не можете найти вертикальный коридор, попробуйте щелкнуть маленький треугольник рядом с горизонтальной полосой движения, и тогда вы увидите вертикальную полосу движения.

   

5. Вы можете переименовать раздел, дважды щелкнув имя каждого раздела. Первые два участника этого руководства — это клиент и продавец.

   

6. Чтобы создать дополнительные перегородки, щелкните правой кнопкой мыши любую пустую область коридора и выберите «Добавить вертикальную перегородку».

   

7. Повторите шаг 6 для других разделов.

8. Создайте начальный узел, выбрав «Начальный узел» и щелкнув по участнику, с которым вы хотите начать действие. В этом руководстве мы хотим, чтобы действие началось с участников-клиентов.

   

9. Чтобы создать операцию, щелкните начальный узел, нажмите и удерживайте кнопку ресурса и перетащите в нужное место. Когда вы отпустите кнопку, выберите «Поток управления»> «Действие». Вы можете переименовать операцию, дважды щелкнув.

   

   

10. Используйте шаг 9, чтобы создать больше событий.

11. При создании узла решения щелкните операцию, которую хотите подключить (в данном примере «Заказ на комментарий агента по контракту»), нажмите и удерживайте кнопку ресурса, затем перетащите ее в нужное место и отпустите. Во всплывающем окне выберите Control Flow> Decision Node. Вы можете перетащить и переместить заголовок узла решения.

    

    

12. Повторите шаг 11 при создании дополнительных узлов решений.

13. Чтобы создать конечный узел события, выберите последнюю операцию (в данном случае «Отправка журнала»), нажмите кнопку ресурса, затем перетащите в нужное место и отпустите. Во всплывающем окне выберите Control Flow> Activity Final Node.

    

    

14. После заполнения графика вы увидите нечто подобное:

    

Загрузите последнюю версию Visual Paradigm

1.9.1. VP User Interface Nomenclature¶

In the following sections describing use of Visual Paradigm the various
parts of the user interface are identified using the names used in the
VP User Guide section
Getting Started > User Interface,
specifically the main parts of the interface as described in
Exploring Visual Paradigm user interface.
E.g. the top-most section of the screen containing tabs Dash, Project,
ITSM, Agile, Diagram, View, etc. is called the Toolbar.

Not mentioned in the above VP user guide pages are the tabs positioned, by
default, along left edge of main window, which give direct access to the
Diagram Navigator, Model Explorer, Property, Diagram Backlog and
Class Repository. These provide direct access to the same panels, or panes,
or trees, accessible from the View toolbar tab and pushing the
Panes button that shows the pull-down menu containing these items.

1.9.2. Using VP at Diamond¶

Diamond DAQ group have purchased the following VP floating licenses:

• 1 Enterprise

• 5 Standard

For comparison between the license types see
this Visual Paradigm page.

Visual Paradigm is installed under /dls_sw/apps/VisualParadigm. This is the
version used by the Jenkins documentation build job
GDA.master-documentation.manuals,
responsible for the nightly build and publishing of this documentation. It is
not currently known (February 2021) how well a VP installation behaves when
accessed simultaneously by multiple users, for this reason if you are planning
to use VP routinely, for anything other than auto-generation of class and
sequence diagrams (see section
Auto generation of Class and Sequence diagrams)
it is recommended to install a local version as detailed in the following
section. Doing this has no impact on Visual Paradigm licenses; the same number
and type of licenses are available irrespective of how many VP installations
are made.

$ ls -l /dls/science/groups/scisoft/VisualParadigm/
total 2012552
-rwxr-xr-x. 1 dos22317 dos22317 639651633 Sep 13  2019 Visual_Paradigm_16_0_20190906_Linux64.sh
-rwxrwxr-x. 1 dos22317 dos22317 690975610 Feb 26  2020 Visual_Paradigm_16_1_20200231_Linux64.sh
-rwxrwxr-x. 1 dos22317 dos22317 722126204 Oct 12 12:13 Visual_Paradigm_16_2_20201010_Linux64.sh

/dls/science/groups/scisoft/VisualParadigm/Visual_Paradigm_16_2_20201010_Linux64.sh

<path-to-VP-install-dir>/bin/Visual_Paradigm

1.9.3. VP GUI application vs Command-line¶

VP is most commonly used through its GUI application, started by running the
Visual_Paradigm script located in the VP installation bin/ directory,
e.g.:

<path-to-VP-install-dir>/bin/Visual_Paradigm

For software design and inspection of GDA source using a UML model the GUI
application must be used, however, the VP installation also includes a number
of scripts to enable use of VP capabilities from the command-line. All available
scripts can be found under the <path-to-VP-install-dir>/scripts directory.
Documentation for the majority of the scripts can be found in the
VP User Guide section
Command-line Interface.

The following sections of this page describe use of the VP GUI application,
for details of how the command-line tools may be used see section
Auto generation of Class and Sequence diagrams
section of this document.

1.9.4. Application Options¶

In order to make UML models created by one user accessible and usable by
others it is advised to set a VP User Path, this ensures the model
will not use absolute paths to files (that are probably dependent
upon user) but instead use a defined root directory. For example, this
ensures ${root}/gda-core.git/uk.ac.gda.core/src/gda is used instead of
/scratch/user/gda/workspace_git/gda-core.git/uk.ac.gda.core/src/gda.

To configure the root User Path do the following:

1. From Window toolbar tab select Application Options

2. On the displayed window, from the sidebar select User Path

3. Push button Add... and from displayed menu select User Path

4. In the displayed pop up in Name: text box enter root and in
   Path: text box enter the path to the directory containing the GDA source,
   e.g. workspace_git directory created after materialising GDA

5. Push button OK on Add User Path pop up and again on
   Application Options window.

The value of the root User Path can be modified at any time using
Edit... button on the Application Options window.

1.9.5. Importing Java source code into Visual Paradigm¶

Visual Paradigm (all licenses) contains a code engineering tool called
Instant Reverse. This can instantaneously make all GDA Java source
available for use inside Visual Paradigm using on-demand reverse
engineering, from the VP user guide:

Consider if you have a zip file that contains million of Java source file,
like the file src.zip of Java Development Kit (JDK), and now you want to
make the class java.util.Collection appear as UML class so that you can
extend it when developing your own collection framework. Now, if you try
to reverse the zip file it will take you a long time to complete the reverse
due to the amount of classes (and relationships) is just too many. With
on-demand reverse engineering, you will reverse the sources as indexes,
and obtain an index tree in class repository. No actual UML classes will be
reversed until you trigger the reverse manually. This reduces the
processing time significantly.

As explained, the advantage of using Instant Reverse is that it enables
the importing into VP of very large code bases without the significant time
over-head of creating a UML model at the same time as the import, as is done
during normal reverse engineering processing.

Instructions for use of Instant Reverse are given in the VP user guide section
How to generate UML from Java sources and classes.

A short description of the steps used to Instant Reverse the GDA Java source
is given below:

1. On the Tools toolbar tab under the Code pull-down menu select
   Instant Reverse as shown below
   

2. On the displayed Instant Reverse window push button
   Add Source Folder... and in the pop-up file navigation window navigate
   to and select the top-level directory containing the GDA source files, e.g.
   workspace_git and push button OK. This adds the directory to the list
   of instant reverse paths. The selected location will be displayed in
   window, e.g.:
   

3. Ensure check-box Reverse source on demand is checked (default)
   and press OK, the instantly reversed source will be presented in the
   Class Repository pane, expanding the workspace_git node will display the
   following (with workspace_git expanded):
   

4. To save the project select the Project toolbar tab and under the Save
   pull-down menu select Save as and use the pop-up Save Project window
   to select location and file name for the .vpp file.

1.9.6. Adding imported classes to model¶

As mentioned above Instant Reverse does not use the imported classes
to automatically create a UML model, thus selecting an individual class in
the Class Repository pane, right-clicking and creating a new class diagram,
will produce a diagram of limited use. Not until the imported classes/packages
are added to a model do their relationships become accessible.

The imported Java source classes and packages can be added to a model
incrementally, e.g. to add the source contained in
gda-core.git/uk.ac.gda.core/src do the following:

1. Navigate to the location in the Class Repository pane

2. Select the src folder, right-click and in menu follow
   Reverse “src” to > and select Class Repository

3. The pop-up Smart Reverse shows progress of the addition to the model

4. View the contents of the model using the Model Explorer pane, this
   can be accessed from View toolbar tab by
   selecting Panes and in drop-down menu selecting Model Explorer,
   it may also be accessible from the tabs displayed on left edge of VP
   window

The above can be repeated as required to add more classes to the model as
and when it is recognized doing so would be useful. The following shows
the Model Explorer pane after addition of gda-core.git/uk.ac.gda.core/src
and gda-core.git/uk.ac.gda.api/src to a model:

Once added to a model the imported classes can be used within VP to
generate class and sequence diagrams,
as described in following sections.

1.9.7. Class Diagrams¶

Following the import of the GDA Java source into VP using Instant Reverse
and addition of classes/packages to a model, as described in previous
sections
(Importing Java source code into Visual Paradigm
and
Adding imported classes to model),
class diagrams can be created.

For example the following ScanBase class diagram:

The above diagram uses the VP Project Options set as described in section
Project Options above and took approximately 5 minutes
to create as shown, including Instant Reverse process. No manual adjustment
of the diagram elements, e.g. resizing, positioning, etc. has been performed.

After Instant Reverse
the following was done to create the ScanBase class diagram shown:

1. Access the Class Repository pane (from View toolbar tab by
   selecting Panes and in drop-down menu selecting Class Repository, or
   if visible from the tabs displayed on left edge of VP window)

2. Use the repository browser to navigate to location of packages relevant
   for the class to be the main subject of the diagram, for the ScanBase
   class these are:

   • gda-core.git/uk.ac.gda.core/src

   • gda-core.git/uk.ac.gda.api/src

   Select each package (multiple packages can be selected using Shift or
   Ctrl key/mouse combinations), right-click and in pop-up follow
   Reverse “<resources>” to > and select Class Repository (this step
   is explained in further detail in section
   Adding imported classes to model above)

3. Now the required packages are in the model use the Class Repository
   pane to navigate to location of class(es) to be
   included in diagram, e.g. in GDA version 9.15 ScanBase is located in
   workspace_git/gda-core.git/uk.ac.gda.core/src/gda/scan/

4. Select class(es) and or complete directories (multiple classes/directories
   can be selected using Shift or Ctrl key/mouse combinations) and right-click,
   in pop-up follow Reverse “<className.java>” to > and select
   New Class Diagram

5. On the displayed Instant Reverse pop-up push button
   Show Fully Qualified Owner

6. The new class diagram is displayed. To change diagram name to something
   meaningful select the Property pane (either by selecting from Panes
   drop-down menu in View toolbar tab or if visible by selecting tab
   on left edge of VP window). Change the Name property to name required
   for class diagram.

7. To minimize area required to display the class diagram on the Diagram
   toolbar tab select Layout and from the pull-down menu select
   Auto Layout, or other layout suitable for best display of information.
   To reduce amount of space between diagram elements from same Layout
   menu select Customized and on Orthogonal tab reduce the
   Layout Grid Size, e.g. to 30 as shown below:
   

Depending on the class(es) selected for inclusion in the class diagram the
diagram created by the above steps may not be appropriate for inclusion in
the GDA documentation, e.g. too many associations, including too many classes
that make the diagram too big/complicated to be useful when not used within
the dynamic context of Visual Paradigm. To assist with creation of simple
diagrams, more appropriate for documentation, and to automatically create
diagrams from GDA Java source code, ensuring diagram always reflects the code,
a VP Plug-in and accompanying script have been developed, for details please
see section
Auto generation of Class and Sequence diagrams
below.

Once a diagram has been created it can be exported, e.g. for use in this
document, by selecting the Project toolbar tab, opening the Export
pull-down menu and selecting Active Diagram as Image…. Use the pop-up
Save window to select location, file name and file type. For diagrams
to be included in this document please use file name ending with
_ClassDiagram and file type .png.

1.9.8. Sequence Diagrams¶

Visual Paradigm can automatically create sequence diagrams from Java
source code.

For example, the following MultiScan sequence diagram, showing operation
of gda.scan.MultiScan.MultiScan(java.util.List):

Like the example ScanBase class diagram (shown in section
Class Diagrams) this uses the VP Project Options set as
described in section Project Options and took
approximately 5 minutes to create as shown, including Instant Reverse
process. No manual adjustment of the diagram elements, e.g. resizing,
positioning, etc. has been performed.

In order to create sequence diagrams the src directory, containing the
classes to be used must be included in the list of instant reverse paths.
I.e. the addition of only workspace_git to the list of Instant Reverse
Java resources, as described in section
Importing Java source code into Visual Paradigm,
is not sufficient to create the above sequence diagram. If an attempt is made
to create a diagram without the correct source directories the following
error pop-up will be displayed:

Therefore the process to create a sequence diagram starts by adding the
required source directories to the instant reverse path:

1. On the Tools toolbar tab under the Code pull-down menu select
   Instant Reverse

2. On the displayed Instant Reverse window push button
   Add Source Folder... and in the pop-up file navigation window navigate
   to and select the src directories, containing the Java class files
   relevant for the sequence diagram, to add them to the list of instant
   reverse paths (multiple directories can be selected using Shift/Ctrl
   mouse/key combinations). E.g. for the above sequence diagram the following
   directories were added:

   • gda-core.git/uk.ac.gda.api/src

   • da-core.git/uk.ac.gda.core/src

   Resulting in the following being displayed in the Instant Reverse window
   (with src directories expanded to show contents), note that the two added
   paths both end in src:
   
   Once all required directories have been added to the path push button
   OK

3. For the current example, as the above directories have already been added
   to our model, see section
   Adding imported classes to model, this
   does not need to be repeated. (The above step has just informed VP where to
   find the sources for the classes we’re interested in.)

4. Access the Model Explorer pane (from View toolbar tab by
   selecting Panes and in drop-down menu selecting Model Explorer, or
   if visible from the tabs displayed on left edge of VP window)

5. In the model browser navigate to the class containing the method that is
   to be the subject of the sequence diagram, expand the class, select the
   required method and right-click, on pull-right menu select
   Reverse “<MethodName>” > and select Sequence Diagram….
   For the example diagram the method selected is gda.scan.MultiScan.MultiScan
   as shown below:
   

6. On the displayed Instant Reverse Java to Sequence Diagram window,
   all default options can be left unchanged, e.g:
   
   Push button Finish to generate and display the diagram

Once a diagram has been created it can be exported, e.g. for use in this
document, by selecting the Project toolbar tab, opening the Export
pull-down menu and selecting Active Diagram as Image…. Use the pop-up
Save window to select location, file name and file type. For diagrams
to be included in this document please use file name ending with
_SeqDiagram and file type .png.

1.9.9. Python ‘Class’ Diagrams — Relation Diagrams¶

It is possible to create class diagrams for Python code from Visual Paradigm
using the Tools > Code > Instant Reverse, selecting
Python Source as the language and adding the path to the python source.

However it is important to note that Visual Paradigm only picks out the
classes contained within the Python files and so if a Python script only
contains functions, then it will not appear in the Class Repository.
In some cases this is undesirable as you may want to show the import structures
for a process and what they depend on which will not be captured by
Visual Paradigm. This is certainly the case for the MX Python scripts.

An alternative approach was taken. We use a script contained in the scripts
directory called
VisParMaker.py
to extract this information.
Each python script with <name> is considered the class and then the file
is parsed and all of the imports are picked out as dependencies. A python
file is output with all of the these and this can be used as the input file
for the Instant Reverse in Visual Paradigm (see
scripts section
for more details).

Once imported, the classes will appear in the Class Repository and can
be dragged into a New Class Diagram as needed.

NOTES

• IMPORTANT: The only thing that is captured here are the dependencies
  within the Python script therefore technically this is NOT a class diagram.
  Instead it is referred to as a Relation Diagram throughout this document.
  The Relation Diagram’s are identified by a light purple background
  (as in the example diagram below) to highlight that they are NOT
  class diagrams. The example shown below (captured for MX grid scan) shows
  that the lineScanStart_xml.py script imports factory, but it is not itself
  a class so the user should not go looking for a Python class of this name
  as it does not exist. Instead they should look for the lineScanStart_xml.py
  file.

  

• The VisParMaker has an extra feature in that it also picks out any classes
  that are contained in a Python source file. These are detailed in the diagram
  as attributes. For example, in the above diagram the script
  helical_zebra.py imports helical and is imported by factory so the
  relations between files are clearly demonstrated. But this diagram also shows
  that it itself contains two ‘real’ classes: ZebraHelicalLineScanRequestHandler
  and SmarGonZebraHeclicalLineScanRequestHandler which have been identified
  by the VisParMaker script. This is included as extra information for the user
  when interpreting these types of diagrams.