Цели и задачи

Руководство программиста разрабатывают в трех случаях:

1. программный продукт по своему основному назначению является средой разработки или библиотекой (как Delphi или Qt);
2. комплекс или программный продукт служит платформой для разработки программ или систем определенного типа (как 1С или Axapta);
3. программа распространяется вместе с исходным кодом или постоянно модифицируется самими разработчиками.

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

Очевидная задача руководства программиста - снабдить разработчика информацией, которой ему будет достаточно для создания на базе нашего программного продукта собственных программ или систем. Еще один мотив создания такого документа - потребность разработчиков время от времени фиксировать состояние продукта, чтобы самим в нем не запутаться и не плодить в коллективе носителей «сакральных знаний».

Руководство программиста должно объяснять:

• Как устроен «мир», в который погружают разработчика. С какими объектами программист имеет дело, где они находятся, сколько времени существуют и как они взаимодействуют между собой. Какие из них он создает сам, а какие предоставлены ему изначально средой, фреймворком, библиотекой.
• Какие еще средства разработки (кроме нашего программного продукта) необходимы для того, чтобы создать приложение или систему. Например, если наш программный продукт - это библиотека, то программисту потребуются компилятор (возможно, вполне определенный), какая-то среда разработки и прочий инструментарий.
• В какой среде функционирует приложение или система? Какими будут его минимальные требования к системе? Понадобятся ли для его запуска какие-либо дополнительные программные средства: фреймворки, рантаймы, интерпретаторы.
• Что представляет собой минимальное работоспособное приложение или минимальная работоспособная система. Какие объекты в какой последовательности необходимо создать, и как их друг с другом соединить, чтобы приложение вывело хотя бы «Hello World» . Правда, бывают приложения, которые вообще не выводят текста, а управляют доменной печью или трафиком в сетях, но у них все равно обязательно есть какой-то свой минимальный вывод.
• Как (по шагам) скомпилировать работоспособное приложение или развернуть работоспособную систему.

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

Кроме теории руководство программиста должно содержать полные описания всех предусмотренных в программном продукте объектов. Если это функции, то должны быть приведены их синопсисы, если классы, то описания их интерфейсов и т. д.

Если программный продукт предполагает использование оригинального языка программирования и снабжен собственным компилятором или интерпретатором, в руководство программиста необходимо включить его описание. Однако, если оно получается достаточно объемным, его выносят в отдельный документ, который так и называется: описание языка (программирования).

Методика и стиль изложения

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

• При вводе нового понятия мы опираемся только на те понятия, которые были введены ранее явно или считаются заведомо знакомыми читателю. Как в учебнике математики.
• У читателя никогда не должно возникать ощущение, что автор плодит сущности без надобности. Ввод каждого понятия должен быть чем-то обоснован.

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

При описании объектов особое внимание следует уделять следующим аспектам:

• Что обязательно должно предшествовать созданию и использованию объекта.
• Каковы побочные эффекты обращения к объекту.
• Особенности интерпретации объектом передаваемых ему данных.
• Где «физически» (в каком файле, в какой библиотеке) находится объект.

Желательно по каждому объекту привести примеры использования, небольшие фрагменты кода, демонстрирующие:

• создание объекта (если перед использованием его необходимо создать);
• передачу объекту входных данных;
• получение выходных данных и их интерпретацию.

Описания объектов можно вынести в отдельный том или документ под названием «Справочник программиста». Хорошая мысль - сделать его гипертекстовым.

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

Типовая структура

Структура руководства программиста, зафиксированная в ГОСТ 19.504-79 , такова:

1. Назначение и условия применения программы.
2. Характеристика программы.
3. Обращение к программе.
4. Входные и выходные данные.
5. Сообщения.

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

Особенности

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

Руководство программиста может комплектоваться различными схемами, например, схемами базы данных, диаграммами классов, графами вызова функций (см. пример).

Примеры

АПК «Нострадамус». Руководство программиста

Аналитический программный комплекс «Нострадамус» предназначен для создания аналитических и отчетных банковских систем. Он содержит набор специализированных компонентов, из которых разработчик конструирует приложение в визуальной среде. Программный код в случае необходимости можно писать на языке Pascal (поэтому описание языка программирования не требуется). Программный комплекс разработан компанией «ПрограмБанк », а техническая документация «Философтом» по ее заказу. Кроме руководства программиста в комплект документации входит исчерпывающий справочник по всем компонентам АПК.

1. Общие сведения 1.1. Сокращения 1.2. Назначение 1.3. Функциональные возможности 1.4. Условия применения 1.5. Требования к квалификации разработчика 2. Прикладное решение и его компоненты 2.1. Архитектура АПК «Нострадамус». Понятие прикладного решения 2.2. Требования к прикладному решению 2.2.1. Базовые требования 2.2.2. Требования к входным данным 2.2.3. Требования к алгоритмам раcчета данных 2.2.4. Требования к отчетам и набору каждого из них 2.2.5. Требования к разграничению доступа и информационной безопасности 2.3. Компоненты прикладного решения 2.3.1. Структура базы данных 2.3.2. Загрузка исходных данных 2.3.3. Организация пользовательского интерфейса 2.3.4. Работа пользователя с данными 2.3.5. Обработка и расчет данных 2.3.6. Отображение данных 2.3.7. Средства автоматической загрузки и обработки данных. Системный агент 2.4. Разграничение прав доступа в прикладном решении 2.4.1. Роли пользователей 2.4.2. Профили пользователей 2.5. Жизненный цикл прикладного решения 3. Пример прикладного решения 3.1. Постановка задачи. Определение требований к прикладному решению 3.2. Проектирование прикладного решения 3.2.1. Проектирование структуры таблиц и процедур загрузки данных 3.2.2. Проектирование интерфейса пользователя 3.2.3. Проектирование процедур расчета и отчетов 3.3. Реализация прикладного решения 3.3.1. Авторизация в АПК «Нострадамус» 3.3.2. Создание категории решений 3.3.3. Создание таблиц 3.3.4. Создание процедур загрузки данных 3.3.5. Создание справочников и визуальных форм для них 3.3.6. Создание процедур расчета на языке хранимых процедур базы данных 3.3.7. Создание отчетов 3.3.8. Создание групп пользователей и создание главного меню для них 3.3.9. Создание процедуры автоматического обновления (загрузки) данных с помощью системного агента 3.4. Развертывание прикладного решения 3.5. Тестирование прикладного решения 3.6. Усложнение задачи 3.7. Доработка прикладного решения 3.7.1. Создание интерактивного отчета 3.7.2. Создание интерактивной загрузки 3.7.3. Финальный этап внесения доработок в прикладное решение

Система e-port дилер. Клиент-серверный протокол

Система «e-port дилер» предназначена для приема и проведения моментальных платежей при оплате услуг мобильной связи, доступа в Интернет и т. п. Центральный сервер системы принадлежит группе e-port, а пункт приема платежей может открыть любой желающий, установив у себя на компьютере (подключенном к Интернету) программу-клиент. Обмен данными между центральным сервером и программой-клиентом осуществляется по специальному протоколу. Протокол открытый, что позволяет различным организациям: банкам, розничным сетям, сетям платежных терминалов, осуществлять платежи непосредственно из собственных систем. Протокол разработан Группой e-port , а техническая документация «Философтом» по ее заказу.

Введение i. Система e-port дилер: клиент-серверный протокол. Назначение и обзор возможностей ii. Задачи протокола iii. Основные преимущества использования протокола 1. Реализация протокола (шлюз) 1.1. Общие сведения 1.2. Структура приложения 2. Как работает шлюз 2.1. Регистрация и отчетность 2.1.1. Регистрация 2.1.2. Отчетность 2.2. Обмен данными с сервером 2.2.1. Структура пакета 2.2.2. Справочники 2.2.3. Порядок обмена пакетами 2.3. Цикл обработки операции 2.3.1. Запрос операции 2.3.2. Очередь 2.3.3. Анализ ответа сервера 2.3.4. Нестандартные ситуации 3. Спецификация протокола 3.1. Структурные элементы пакета 3.2. Заголовок запроса 3.3. Заголовок ответа 3.4. Пополнение счета 3.5. Покупка PIN-кода 3.6. Прерывание процесса обработки операции 3.7. Транзакционные свойства операции 3.8. Запрос на проведение нескольких операций 3.9. Справочник 3.10. Статус операции 3.10.1. Примеры сообщений о статусе операций 3.10.2. Коды состояния находящихся в обработке или завершенных операций 3.11. Уведомления системы 4. Глоссарий Приложения Приложение 1. DTD XML-запроса и комментарий DTD XML-запроса Комментарий Приложение 2. DTD XML-ответа Приложение 3. Правила расчета суммовых полей Приложение 4. Примеры запросов и ответов сервера

Программно-технические средства
блокировок и защит по уровню воды

Руководство программиста
Структура программы контроллера

АННОТАЦИЯ

В настоящем документе приводится описание назначения, условий применения и характеристик прикладного программного обеспечения (ППО) программируемого логического контроллера (ПЛК). Прикладное программное обеспечение промышленного компьютера (ПК) описано в документе «Руководство оператора». Ссылки на программное обеспечение ПК приведены в настоящем документе по мере необходимости.

СОДЕРЖАНИЕ
1. НАЗНАЧЕНИЕ И УСЛОВИЯ ПРИМЕНЕНИЯ ПРОГРАММЫ
1.1.Назначение ППО ПЛК
1.2.Условия применения ППО ПЛК
2. ХАРАКТЕРИСТИКА ПРОГРАММЫ
2.1. Структура ППО ПЛК

2.3. Пользовательские функциональные блоки, применяемые в ППО «Unity»
3. ОБРАЩЕНИЕ К ПРОГРАММЕ
4. ВХОДНЫЕ И ВЫХОДНЫЕ ДАННЫЕ
5. СООБЩЕНИЯ

1. НАЗНАЧЕНИЕ И УСЛОВИЯ ПРИМЕНЕНИЯ ПРОГРАММЫ
ПТС блокировок и защит по уровню воды в парогенераторах энергоблоков №1,2 Электростанции предназначена для защиты трубной системы парогенераторов при снижении уровня воды, а также защиты системы от заброса питательной воды в проточную часть турбины при повышенном уровне в парогенераторе.
Защита технологического процесса обеспечивается комплексом технологического оборудования:
Арматура на основной линии питающей воды (ВП-9);
Арматура на основной линии питающей воды (ВП-10);
Арматура на линии продувки (У5-01);
Арматура на линии продувки (У5-02);
Арматура на байпасной линии питающей воды (ВП11);
Команды включения аварийного повысительного электронасоса (АПЭН-1);
Команды включения аварийного повысительного электронасоса (АПЭН-2);
Команда отключения турбогенератора (ТГ3);
Команда отключения турбогенератора (ТГ4);
Выдача технологической сигнализации по понижению уровня в 4-х из 6-ти ПГ
Выдача технологической сигнализации срабатывания защиты по +300мм
Команда отключения регулятора питания на линии продувки +75мм
Команда отключения регулятора питания на линии продувки 500 тонн
Выдача технологической сигнализации по +125мм
Выдача технологической сигнализации по +75мм
Выдача технологической сигнализации по ±50мм
Выдача технологической сигнализации по -120мм
Выдача технологической сигнализации по 500т/час

Функционирование системы обеспечивается прикладным программным обеспечением (ППО).
ППО включает прикладное программное обеспечение промышленного компьютера (ППО ПК) и прикладное программное обеспечение программируемого контроллера (ППО ПЛК).

1.1. Назначение ППО ПЛК
ППО ПЛК в составе ПТС реализует следующие функции:
– резервирование контроллеров;
– получение и обработка сигналов ввода-вывода с трех идентичных корзин ввода-вывода;
– Принимает и фильтрует входные дискретные сигналы от вероятного «дребезга» контактов.
– Принимает и обрабатывает входные аналоговые сигналы:
обеспечивает контроль выхода сигнала за допустимые границы (недостоверность сигнала);
производит масштабирование аналогового сигнала;
осуществляет гистерезис пороговых значений;
анализирует состояния трех сигналов из состава корзин и выборка достоверных значений;
осуществляет фильтрацию сигнала по скорости нарастания или убывания величины сигнала.
– Выдача дискретных сигналов на оборудование (срабатывание защит);
– Контроль отклонений параметров от заданий и достижения уставленных значений;
– Выдача исполнительных воздействий на лампы технологической сигнализации на БЩУ;
– Реализация алгоритмов защит и блокировок;
– Обмен данными со смежными системами по каналу Modbus/TCP/IP;
– Проверка модулей контроллера на наличие ошибок, и формирование сообщений для АРМ о состоянии оборудования контроллера, а также на панель БЩУ;
– Мониторинг аварийных ситуаций оборудования системы;
– ППО ПЛК обеспечивает возможность приема от промышленного компьютера, а также с панели БЩУ ключей отключающих определенные защиты и блокировки системы.

1.2. Условия применения ППО ПЛК
Общая архитектура системы приведена на рисунке 1.

Рисунок 1. Общая архитектура ППО

Комплекс ПТС включает следующие аппаратные и покупные программные компоненты:
1) Два программируемых логических контроллера (ПЛК) QUANTUM на базе процессора P266 CPU, работающих в режиме горячего резерва. Исполнительная среда Unity Pro 4.1 XL.
2) Промышленный компьютер, состоящий из:
– персональная ЭВМ (встраиваемый промышленный компьютер);
– операционная система Windows XP Pro SP3;
– пакет визуализации СITECT 7
ПЛК осуществляют взаимодействие с внешними подсистемами по сети Ethernet (со стороны ПЛК) и по каналам ввода-вывода.
Взаимодействие ПЛК и промышленного компьютера осуществляется по сети Ethernet.
ПТС включает прикладные программные компоненты, разрабатываемые в соответствии с настоящим проектом:
Приложение Unity Pro, установленное на ПЛК.
Приложение Citect, установленное на ПК.

2. ХАРАКТЕРИСТИКА ПРОГРАММЫ
2.1. Структура ППО ПЛК
Прикладное программное обеспечение ПЛК реализуется в виде приложения (см Рисунок 1), написанного в среде Unity v.4.1. Название приложения – upg.stu.
Приложение upg.stu обеспечивает реализацию функциональности системы, реализуемой на ПЛК для всех режимов работы.
Приложение содержит:
конфигурацию аппаратных и программных средств;
набор функциональных модулей, каждый из которых реализуется секциями, написанными на языке LD (лестничных диаграмм);
набор функциональных блоков, разработанных в рамках проекта;
базу данных;
анимационные таблицы.
В состав приложения входят следующие функциональные модули, каждый из которых содержит один или несколько программных модулей, отраженных в таблице 1.
Таблица 1

Init Секция выполняется при первом цикле после запуска и обеспечивает присвоение начальных значений всем параметрам.
AI_to_AM Секция обработки входных аналоговых сигналов. Осуществляется вызов блока соответствующего сигнала для присвоения значения внутренней переменной и проверки достоверности канала.
DI_to_DM Секция обработки входных дискретных переменных. Производится вызов функционального блока соответствующего сигнала для присвоения значения внутренней переменной и проверки достоверности канала.
Comparing Секция сравнения получаемых значений с трех различных корзин распределённого ввода-вывода. Сигналы сравниваются по логике 2 из 3-х. Если два сигнала идентичны, а третий различен, то последний признается недействительным.
Наименование секции Функциональность
Alarms Секция обработки дискретных и аналоговых сигналов для определения достижений предельных значений. Выработка сигнализаций и команд на исполнение блокировок и защит.
INTERLOCK Секция формирования алгоритма блокировок и защит. В данной секции происходит запись в переменные, связанные с исполнительными механизмами.
SIM Секция управления режимами имитации и опробования контроллера.
DIAGNOSTIC Секция формирования диагностической информации контроллера.

Внутри секций используются следующие подпрограммы:
Таблица 2
Наименование секции Функциональность
CompAI Функциональный блок, предназначенный для сравнения трех разных аналоговых величин, выдачи на выход результирующего значения, а также диагностической информации по каждому из каналов.
CompDI Функциональный блок, предназначенный для сравнения трех дискретных сигналов приходящих с трех разных корзин, выдачи на выход результирующего значения, а также диагностической информации по каждому из каналов.
BlockF Функциональный блок, предназначенный для фиксирования недопустимо быстрого падения или прироста аналоговой величины. В случае обрыва или короткого замыкания данный ФБ выведет данный сигнал из обработки, что не позволит остановить технологический процесс.
GetDI Функциональный блок, предназначенный для получения и обработки дискретных сигналов. Осуществляет фильтрацию «дребезга» контактов.

Наименование секции Функциональность
HLLA4 Функциональный блок, предназначенный для выработки четырех пороговых нарушений с одного аналогового сигнала (HH, H, L, LL). В ФБ учтены параметры гистерезиса и мертвой зоны по фиксации нарушений.
GetAI Функциональный блок, предназначенный для получения и обработки аналоговых сигналов. Осуществляет масштабирование значений, а также выполняет функции частичного сглаживания.
SIMPMEHA Функциональный блок, предназначенный для выдачи синусоидальной помехи. Данная помеха «подмешивается» к имитируемому сигналу для придания реалистичности при работе с такими режимами, как «опробование».
SIMPULSE Функциональный блок, предназначенный для выдачи в системе пульсов заданной длительности.
SIMPV Функциональный блок, предназначенный для имитации аналоговой величины при работе с такими режимами, как «опробование».
2.2. Структуры данных ППО ПЛК
Всего в каждом энергетическом блоке находится шесть парогенераторов и программные элементы ППО выполнены для каждого из них идентично.
В проекте программного обеспечения контроллеров используются следующие типы данных:
Слово состояния аналогового канала – тип word;
Слово состояния дискретного канала – тип word;
Слово определяющее значение аналогового канала – тип real (два слова word);
Слово состояния контроллера QUANTUM – тип word (всего зарезервировано два слова);
Слово состояния нарушений – тип word;
Слово состояния блокировок – тип word;
Слово состояния деблокировочных ключей – тип word;

Промышленный компьютер позволяет производить управляющие воздействия только на деблокировочные ключи, посредством изменения состояния битов через управляющее слово. ПЛК информирует о своем состоянии через слово состояния. Описание отдельных полей (разрядов) слов данных приведено в Руководстве программиста.

Переменные в ПЛК кодируются следующим образом:
AI – аналоговый вход в ПЛК;
AIM – внутренний аналоговый вход ПЛК /ПК;
DI – дискретный вход в ПЛК;
DM – внутренний дискретный вход ПЛК /ПК;

2.3. Пользовательские функциональные блоки, применяемые в ППО «Unity»
2.3.1 Функциональный блок сравнения аналоговых каналов CompAI

.

Рисунок 2. Функциональный блок сравнения аналоговых каналов CompAI

Данный ФБ служит для сравнения трех различных аналоговых значений. Если один из аналоговых параметров выходит за пределы среднего значения двух других, то его значение не учитывается и в свойство данного канала пишется сообщение об ошибке. Если исправны все три канала (находятся в приемлемом допуске рассогласования), то результирующим будет большее из существующих значений.

2.3.2 Функциональный блок сравнения аналоговых каналов CompDI

Рисунок 3. Функциональный блок сравнения дискретных каналов CompDI

Данный ФБ служит для сравнения трех пар дискретных сигналов. Если в паре сигналов два значения будут одинаковыми, то это будет означать обрыв или короткое замыкание. В данном случае данная пара не учитывается и выводится из обращения. В систему выдается сообщение о характере вызвавшего нарушения. Если суммарное значение в трех разных парах различается, то алгоритм блока выводит из обращения те, которые не соответствуют предыдущим двум.
2.3.3 Функциональный блок вычисления скорости спада аналоговой величины BlockF

Рисунок 4. Функциональный блок вычисления скорости спада аналоговой величины BlockF

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

2.3.4 Функциональный блок масштабирования аналогового канала GetAI

Рисунок 5. Функциональный блок масштабирования аналогового канала GetAI

Данный ФБ служит для перевода программных единиц контроллера (INT) в величины реальных единиц технологического процесса (REAL). В случае выхода параметра за границы допустимой погрешности (OFFSET) ошибка на канале не выдается и параметр останавливается на максимальном или минимальном значении. В случае если параметр выделяется сильнее нормированной погрешности, то выдается ошибка на канале с расшифровкой характера нарушения.

2.3.5 Функциональный блок обработки дискретного канала GetDI

Рисунок 6. Функциональный блок обработки дискретного канала GetDI

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

2.3.6 Функциональный блок выработки пороговых нарушений HLLA4

Рисунок 7. Функциональный блок выработки пороговых нарушений HLLA4

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

2.3.7 Функциональный блок выработки синусоидальной помехи SIMPMEHA

Рисунок 8. Функциональный блок выработки синусоидальной помехи SIMPMEHA

Данный ФБ служит для реализации режимов контроллера, связанных с отладкой и имитацией работы установки. Данный сигнал на диаграмме выглядит как синусоидальная кривая, с диапазоном разброса заданного пределами (входные переменные). Эта помеха предназначена для «подмешивания» к величине аналогового сигнала и для придания ему динамических свойств и визуальной реалистичности.

2.3.8 Функциональный блок выработки импульсов заданной длины SIMPULSE

Рисунок 9. Функциональный блок выработки импульсов заданной длины SIMPULSE

Данный ФБ служит для реализации режимов контроллера, связанных с отладкой и имитацией работы установки. Данный сигнал на диаграмме выглядит как меандр, с разными диапазонами вершин и впадин. Временные значения вершин меандра задаются временными пределами (входные переменные).

2.3.9 Функциональный блок генерации аналоговой переменной SIMPV

Рисунок 10. Функциональный блок генерации аналоговой переменной SIMPV

Данный ФБ служит для генерации аналоговых сигналов для режимов имитации работы устройств и отладки контроллера.
3. ОБРАЩЕНИЕ К ПРОГРАММЕ
Программа при работе на объекте сконфигурирована на автоматический запуск при включении контроллера. Состояние программы отображается на дисплее контроллера. Настройка параметров программы может осуществляться с переносного компьютера, входящего в поставку системы.

4. ВХОДНЫЕ И ВЫХОДНЫЕ ДАННЫЕ
Входными данными системы является информация, поступающая от объекта управления в ПТС через устройства связи с объектом (распределенной периферии), а также команды, вводимые оператором с ПК.
Выходными данными системы является информация, передаваемая на объект управления из ПТС через устройство связи с объектом. Информация выводится в ПК в виде экранных форм и поступает в виде сигнализации на панель БЩУ.

5. СООБЩЕНИЯ
Сообщения, передаваемые по интерфейсу ПЛК-ПК, описаны в документе «Руководство программиста. Часть 2. Интерфейс ПЛК-ПК». Сообщения, выдаваемые оператору, описаны в документе «Руководство оператора».

#Руководство, #программиста, #описание, #ПЛК, #ПТС, #интерфейс, #аналоговых, #контроллер

Руководство программиста относится к эксплуатационно-технической документации. Разрабатывается такой документ для программных продуктов. Предназначен для ознакомления программистом, который будет решать те или иные задачи, связанные с эксплуатацией данной программы.

Когда требуется руководство программиста?

Руководство программиста необходимо в нескольких случаях:

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

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

К типичным задачам такого документа относится:

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

УФИМСКИЙ ГОСУДАРСТВЕННЫЙ АВИАЦИОННЫЙ ТЕХНИЧЕСКИЙ УНИВЕРСИТЕТ

КАФЕДРА ВЫЧИСЛИТЕЛЬНОЙ МАТЕМАТИКИ И КИБЕРНЕТИКИ

Прикладное программное обеспечение для учета заявок и контроля их исполнения на примере ООО «Интегрированная транспортная сеть».

1. Руководство программиста

1. Аннотация

Приводится руководство программиста программного обеспечения для учета заявок и контроля их исполнения на примере ООО «Интегрированная транспортная сеть».

Программный продукт должен быть разработан для организации, предназначенное для автоматизации стратегий взаимодействия с клиентами, в частности, для повышения уровня продаж, улучшения обслуживания клиентов путём сохранения информации о клиентах и их персональных данных. Так же должна быть реализована email-рассылка пользователям данного продукта, статистика, где показано какое количество заявок завел пользователь за день, за месяц.

В руководстве программиста рассматриваются назначение, характеристики, условия, необходимые для выполнения программы

1. Назначение программы

Программный продукт будет использован в компании NetTrans (ООО «Интегрированная транспортная сеть») в отделах технической поддержки, абонентском и строительства как модель взаимодействия, полагающая, что центром всей философии бизнеса является клиент, а основными направлениями деятельности являются меры по поддержке продаж и обслуживания клиентов. Данным программным обеспечением могут воспользоваться лишь зарегистрированные пользователи, регистрация в свою очередь осуществляет лишь администратор, путем добавления нового пользователя в базу данных, так же имеется возможность вести статистику операторов, составляющие заявки абонентов.

1. 2. Условия, необходимые для выполнения программы

Для работы программного продукта необходима следующая программно-аппаратная конфигурация:

Windows 7,Windows Server 2003 Service Pack 2,Windows Server 2008,Windows Server 2008 R2,Windows Vista, Windows Vista Service Pack 1,Windows XP Service Pack 2,Windows XP Service Pack 3;

32-разрядные системы: компьютер, оборудованный процессором Intel или совместимым процессором с тактовой частотой 1 ГГц или выше (рекомендуется 2 ГГц или выше, поддерживается только один процессор);

64-разрядные системы: процессор с тактовой частотой 1,4 ГГц или выше (рекомендуется 2 ГГц или выше, поддерживается только один процессор);

1 ГБ свободного места на диске;

наличие СУБД: MS SQL 2008;

1. 3. Характеристики программы

3.1. Режим работы программы

Диалоговый. Web-интерфейс в браузере (с поддержкой HTML5).

3.2.Средства проверки правильности выполнения программы

Проверка правильности работы программы осуществляется при выполнении конкретных примеров. Программа выдает сообщение при вводе некорректных данных (Рис. 2.20):

Рис. 2.20. Некорректный ввод номера телефона

3.3. Функционирование программы после сбоев

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

Обращение к программе

Для запуска программы необходимо выполнить следующие действия:

Запустить программу на ПК, с поддержкой Microsoft .NET Framework (или на удаленном сервере), если он еще не запущен;

Откройте ваш любимый браузер (на пример chrome, internet explorer, mozilla firefox);

Введите в адресную строку IP-адрес сервера, с заранее определенным портом;

Откроется страница домашняя страница;

Начать работу с клиентами.

Отправить свою хорошую работу в базу знаний просто. Используйте форму, расположенную ниже

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

Размещено на http://www.allbest.ru/

Руководство программиста

• 1. Назначение и условия применения
• 2. Характеристика программы
• 3. Обращение к программе
• 4. Полный перечень модулей и компонентов
• 5. Сообщение пользователю

1 . Назначение и условия применения

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

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

Проектирование данного программного продукта поможет автоматизировать работу менеджера по работе с дилерами.

Требования к аппаратному обеспечению:

· процессор Intel Pentium IV и выше;

· оперативная память 512 Мб и выше;

· видеокарта AGP/PCI Express 64 Мб и выше;

· свободное пространство на диске 12 Мб;

· видеомонитор с разрешением 1024x768;

· клавиатура;

· мышь;

· принтер для вывода на печать отчетов;

· операционная система Windows 98/2000/XP/Vista/7/8;

· Microsoft Access, Borland Delphi 7.

2 . Характеристика программы

В тестовом режиме был произведен запрос к форме ввода/вывода и введены данные в главную таблицу, что позволило оценить наглядно загруженность центрального процессора (ЦП) и использование выделенной (виртуальной) памяти с помощью «Диспетчера задач», как изображено на рис.Б.1 и рис.Б.2.

Рис.Б.2- Выделенная память и время загрузки

3 . Обращение к программе

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

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

Возможен запуск программы через командную строку. Запустить командную строку «Пуск/Все программы/Стандартные/Командная строка» Далее в командной строке необходимо ввести полный путь к программе, далее написать название программы (Project1.exe) и нажать Enter. Программа запущена.

Еще один способ запуска программы: в меню «Пуск» выберите пункт «Выполнить». В результате на экране откроется окно «Выполнение программы». В поле «Открыть» окна «Выполнение программы» введите путь к файлу программы, которую требуется запустить.

Выход из приложения возможен при нажатии на кнопку «Закрыть» или с помощью пункта меню программы «Файл/Выход», а также можно воспользоваться сочетанием клавиш Alt+F4.

4 . Полный перечень модулей и компонентов

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

В состав данного программного продукта входят следующие модули:

Unit1.pas - главный модуль программы, где непосредственно происходит заполнение данных по заказам;

Unit2.pas - отправка заказа дилеру (дилерский терминал);

Unit3.pas - модуль программы, где происходит заполнение данных по замерам изделия (окна);

Unit4.pas - модуль программы, где происходит заполнение данных по установке изделия (окна);

Unit5.pas - поиск, фильтрация, сортировка по заказам;

Unit6.pas - модуль «О программе».

В главной форме имеются компоненты, изображенные на рис.Б.3. На рисунке также изображено «дерево» всех компонентов формы (рис. Б.4).

Рисунок Б.3 - Компоненты главной формы

Компоненты главной формы:

TADOConnection - используется для указания базы данных и работы транзакциями;

TADOTable - таблица доступная через ADO;

DataSource обеспечивает механизм для связи компонентов доступа к данным (Table) с визуальными компонентами, которые отображают данные (DBGrid, DBEdit, DBListBox и т. д.)

TADOQuery - выполняет запрос (выборку) к базе данных;

TMainMenu - создает главное меню программы;

TDBGrid - осуществляет отображение данных из базы данных в виде таблицы;

TEdit - поле для ввода текстовых сообщений;

TButton - кнопка;

TComboBox - выпадающий список;

TDBCtrlGrid - используется для отображения таблицы в виде «кирпичиков»;

TLabel - надписи;

TGroupBox - панель, как отельный элемент с другими компонентами;

TDBNavigator - компонент для управления навигацией и редактированием данных;

TDBEdit - поле редактирования записи базы данных;

TDateTimePicker - выбор даты;

TSpeedButton - быстрая кнопка;

TBitBtn - кнопка, передающая действие форме;

TBevel - предназначен в приложении для простого обведения чего-либо рамкой.

Компоненты главной формы необходимы для вывода таблиц из базы данных, для изменения, добавления, удаления, фильтрации, поиска, перехода к другим форм и для иных действий.

Рисунок Б.4 - Структура компонентов

5 . Сообщение пользователю

Если пользователь ввёл неверные значения для фильтрации данных базы данных, то выводится сообщение, показанное на рис.Б.5.

Рис.Б.5 - Сообщение об ошибке

Если произошла ошибка при удалении данных, то выводиться сообщение об ошибке, показанное на рис.Б.6.

программный пластиковый окно

Рис.Б.6 - Сообщение об ошибке.

Пользователь забыл ввести номер накладной при сохранении заказа, то выводиться сообщение об ошибке, показанное на рис.Б.7.

Рис.Б.7 - Сообщение о ошибке

При попытке удаления выводится сообщение, показанное на рис.Б.8.

Рис.Б.8 - Диалог с пользователем

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

Рис.Б.9 - Диалог с пользователем

Размещено на Allbest.ru

...

Подобные документы

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

курсовая работа , добавлен 19.03.2010


Использование основных свойств объектно-ориентированного языка программирования C ++ при написании программы по реализации списка футболистов разных амплуа. Руководство пользователя и руководство программиста. Работа со списком, программный интерфейс.

курсовая работа , добавлен 20.07.2014


Описание входной и выходной информации. Требования к комплексу технических средств и к интерфейсу конечного пользователя. Разработка форм представления входных и выходных данных. Проектирование программных модулей. Руководство пользователя и программиста.

курсовая работа , добавлен 27.06.2015


Особенности алгоритмов, критерии качества. Создание и применение программного продукта на языке Delphi. Тип операционной системы. Внутренняя структура программного продукта. Руководство пользователя и программиста, расчет себестоимости и цены программы.

дипломная работа , добавлен 12.06.2009


Delphi как программный продукт с феноменальными характеристиками. Компилятор в машинный код. Объектно-ориентированная модель программных компонентов. Масштабируемые средства для построения баз данных. Программный код.

контрольная работа , добавлен 30.07.2007


Разработка структурной схемы и интерфейса программного комплекса управления сайтом. Выбор языка программирования. Принципы тестирования программы. Разработка руководства оператора и системного программиста. Расчет сметы затрат на программный продукт.

дипломная работа , добавлен 11.06.2012


Назначение и область применения промышленных роботов. Разработка программы "Кинематическое движение" в среде Delphi для определения основных параметров кинематического движения. Описание работы и листинг программы. Руководство программиста и оператора.

курсовая работа , добавлен 17.11.2014


Техническое задание. Планы работы: первоначальный, поэтапный. Технический проект. Таблицы базы данных программы. Схема обмена данными. Тестирование программного продукта. Эксплуатационная документация. Руководство программиста. Руководство пользователя.

курсовая работа , добавлен 07.12.2007


Создание программного продукта по теме "Назначение и основные свойства палитры компонентов "Standard"", тестирующего знания студентов, в среде языка программирования Delphi. Особенности методики осуществления контроля знаний и состав тестовых заданий.

курсовая работа , добавлен 17.04.2011


Разработка программы на языке Visual Basic. Спецификация на программный модуль. Ввод, изменение и удаление данных по определенным требованиям. Руководство системного программиста, программиста и оператора. Ведение базы данных в виде таблицы Excel.