Описание программы (ГОСТ 19.402-78)

Общие сведения

Обозначение и наименование программы

Программабазы данных«Расчёт платежей за коммунальные услуги ТСЖ».

Программное обеспечение, необходимое для функционирования программы

ПакетDelphi7полностьюподдерживаетновейшие иуже существующие Web-сервисы.

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

Языки программирования, на которых написана программа

Программа написана на языке Object Pascal и предназначена для обработки компилятором.

Функциональное назначение

Информационная система «Расчет платежей за коммунальные услуги ТСЖ-99» предназначена для автоматизации рабочего места управляющего ТСЖ, ведения расчета оплаты за коммунальные услуги для квартиросъёмщиков.

Описание логической структуры

Логическая структураприведена в приложении А.

Используемые методы

Для подключения базы данных к Delphi используются технология ADOConnection.

ADO – ActiveXDataObjects.Технология MicrosoftActive X DataObjects обеспечивает универсальный доступ к источникам данных, из приложений БД. Такую возможность предоставляют функции набора интерфейсов, созданные на основе общей модели объектов СОМ (Component Object Model) и описанные в спецификации OLE DB. Провайдеры ADO обеспечивают соединение приложения, использующего данные через ADO, с источником данных (сервером SQL, локальной СУБД, файловой системой и т. д.). Для каждого типа хранилища данных должен существовать провайдер ADO. Microsoft Jet OLE DB Provider обеспечивает соединение с данными СУБД Access. Использование ADO позволяет отказаться от установки BDE и поставки дополнительных библиотек на ПК конечного пользователя разрабатываемого приложения БД.

Структура программы

Структура программных файлов

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

*.ddp – файл для разработки Delphi;

*.dfm- файл с описанием строения формы;

*.pas- исходный код модуля;

*.dcu- скомпилированный модуль Delphi;

*.dof - текущие параметры проекта;

*.cfg - файлы конфигурации проекта

*.dpr- файл проекта;

*.ехе - исполняемый файл;

*.res – результирующий файл, файл ресурсов;

*.gui – файл данных;

*.chm – файл для справки;

*.mdb – файл базы данных Access.

Структура программных модулей

Unit – имя модуля (файла).

Interface – используется для внешних определений модуля .

Uses- подключение стандартных библиотек и модулей.

{Windows, Messages, SysUtils, Classes, Graphics, Controls, Forms, Dialogs}

Type – описание класса TForm с его полями и методами.

private – описание данных (полей) и подпрограмм (методы) класса, которые являются частными (внутренними) для этого класса.

{Privatedeclarations}

Public - переменные, открытые для всех модулей.

{Publicdeclarations}

Var – описание глобальных переменных.

Implementation – начинает раздел исполняемого кода в модуле.

Function – пользовательскиефункции.

{$R *.DFM} – подключение файла формы.

procedure<имя> (Sender: TObject);

Var – описание локальных переменных.

Begin

... Блок активированных процедур

End;

End.

Используемые технические средства

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

- Процессор:IntelCore i54460, частота процессора 3.2 ГГц,количество ядер процессора – 4, чипсет материнской платы - Intel H81;

- Оперативная память: DIMM, DDR34096 Мб 1600 МГц, максимальный объем оперативной памяти - 16 Гб;

- Жесткий диск:500 Гб, 7200 об/мин, SATA III;

- Мышь, монитор, клавиатура.

Вызов и загрузка

Загрузка программы осуществляется путём следования H:\Temp\Курсовой проект БД Осипов\ Программа (ТСЖ)\ tsg.exe

Входные данные

Входными данными являются:

- Data Module DFM: ADO Connection BD –подключение базы данных к Delphi; ADO Table Sob, ADO Table Voda, ADO Table Giljo, ADO Table Otopl, ADO Table Svet, ADO Table Obslug, ADO Table Quit, ADO Table Requisites – таблица из БД;

- Form Avtorisation: Combo Box User Name – выборпользователей; Edit Password – вводпароля;

- Form Requisites: DB Edit Adr–ввод юридического адреса, DB Edit Naim TSG –вводнаименованияТСЖ, DB Edit Tel –вводномерателефона, DB Edit INN- вводИНН,DB Edit BIK- вводБИК, DB Edit RS- вводрасчётногосчёта, DB Edit KS- вводкорреспондентскогосчёта;

- Form Table Sobstvennikov: Edit Poisk–ввод поиска по ФИО квартиросъёмщика, DB Edit FIO –ввод ФИО квартиросъёмщика, DB Edit LS –ввод лицевого счёта, DB Edit kolvo- ввод количества проживающих, DB Edit PL- ввод общей площади, DB Edit Adr–ввод адреса;

- Form Table Tarifes: DB Edit Naimvoda–вводнаименованиятарифанаводу, DB Edit edvoda–ввод единицы измерения для воды, DB Edit voda- вводтарифанаводу, DB Edit Naimgiljo–ввод наименования тарифа на жильё, DB Edit ed giljo–вводединицыизмерениядляжилья, DB Edit giljo–вводтарифанажильё, DB Edit Naim otopl–ввод наименования тарифа на отопление, DB Edit ed otopl–вводединицыизмерениядляотопления, DB Edit otopl–вводтарифанаотопление, DB Edit Naimsvet–вводнаименованиятарифанасвет, DB Edit edsvet–вводединицыизмерениядлясвета, DB Edit svet–вводтарифанасвет, DB Edit Naimobslug–вводнаименованиятарифанатех. обслуживание, DB Edit edobslug–вводединицыизмерениядлятех. обслуживания, DB Edit obslug–вводтарифанатех. обслуживание;

- Form Table Kvitanzia: DB Edit NP voda - вводначальногопоказаниясчётчиканаводу, DB Edit KP voda–вводконечногопоказаниясчётчиканаводу, DB Edit kolvovoda- вводколичествапосчётчикунаводу, DB Edit NP giljo–вводначальногопоказаниясчётчиканажильё, DB Edit KP giljo–вводконечногопоказаниясчётчиканажильё, DB Edit kolvogiljo–вводколичествапосчётчикужилья, DB Edit NP otopl–вводначальногопоказаниясчётчиканаотопление, DB Edit KP otopl–вводконечногопоказаниясчётчиканаотопление, DB Edit kolvootopl–вводколичествапосчётчикунаотопление, DB Edit NP svet–вводначальногопоказаниясчётчиканасвет, DB Edit KP svet–вводконечногопоказаниясчётчиканасвет, DB Edit kolvosvet–вводколичествапосчётчикунасвет, DB Edit NP obslug–вводначальногопоказаниясчётчиканатехобслуживание, DB Edit KP obslug–вводконечногопоказаниясчётчиканатехобслуживание, DB Edit kolvoobslug–вводколичествапосчётчикунатехобслуживание, DB Lookup Combo box Number- выборличногономера,DB Lookup Combo box LS –выборлицевогосчёта, DB Lookup Combo boxadr - выборадреса, DB Lookup Combo box kolvo–выборколичествапроживающих, DB Lookup Combo box pl –выборплощадиквартир, DB Lookup Combo box NaimVoda–выборнаименованиятарифанаводу, DB Lookup Combo box NaimGiljo–выборнаименованиятарифанажильё, DB Lookup Combo box NaimOtopl–выборнаименованиятарифанаотопление, DB Lookup Combo box NaimSvet–выборнаименованиятарифанасвет, DB Lookup Combo box NaimObslug–выборнаименованиятарифанатехобслуживание, DB Lookup Combo box Voda–выбортарифанаводу, DB Lookup Combo box Giljo–выбортарифанажильё, DB Lookup Combo box Otopl–выбортарифанаотопление, DB Lookup Combo box Svet–выбортарифанасвет, DB Lookup Combo box Obslug–выбортарифанатехобслуживание, DB Lookup Combo box Ed Voda–выборединицыизмерениянаводу, DB Lookup Combo box Ed Giljo–выборединицыизмерениянажильё, DB Lookup Combo box Ed Otopl–выборединицыизмерениянаотопление, DB Lookup Combo box Ed Svet–выборединицыизмерениянасвет, DB Lookup Combo box Ed Obslug–выборединицыизмерениянатехобслуживание, DB Lookup Combo box FIO –выборФИОквартиросъёмщика;

- Form Export: DB Lookup Combo box Number- выборличногономера, DB Lookup Combo box LS –выборлицевогосчёта, DB Lookup Combo box adr–выборадреса, DB Lookup Combo box kolvo–выборколичествапроживающих, DB Lookup Combo box pl –выборплощадиквартир, DB Lookup Combo box FIO –выборФИОквартиросъёмщика, DB Date Time Picker Word –вводдатыраспечатаннойквитанции.

Выходные данные

Выходными данными являются:

- FormTarifes: DBGridVoda - вывод информации о тарифах на воду в таблице, DBGridGiljo - вывод информации о тарифах на жильё в таблице, DBGridotopl - вывод информации о тарифах на отопление в таблице, DBGridsvet - вывод информации о тарифах на свет в таблице, DBGridobslug - вывод информации о тарифах на тех обслуги в таблице;

- FormKvitanzia: DBGridQuit - вывод информации о квитанции в таблице;

- FormSobstvenniki: DBGridSob - вывод информации о собственниках в таблице.

Описание программы составлено в соответствии с ГОСТ 19.402-78. ЕСПД. Требования к содержанию и оформлению.

ПРОЦЕСС РАЗРАБОТКИ

Для разработки ИС «Расчёт платежей за коммунальные услуги ТСЖ» воспользуемся инструментальной средой Delphi7, с её взаимодействием со средой MSAccess, через компоненты ADO.Основное окно программы содержит следующие части:

Системное меню (1);

Панель инструментов(2);

Окно для всех таблиц (3);

Палитра компонентов (4);

Форма (5);

Модуль (6).

Рисунок 9 – Основное окно программы Delphi 7

Для начала создадим форму авторизации пользователей. Для логина мы будем использовать компонент Combobox, для пароля – компонентEdit, для входа в систему – компонент Button, для загрузки входа в систему – компонент Timer и ProgressBar.

Рисунок 10 – Форма для авторизации пользователей

В компоненте Combobox для добавления списка необходимо щелкнуть назначок<…> в свойстве Items.

Рисунок 11 – Работа со свойством Items в компоненте ComboBox

Затем создадим главную форму. В главной форме добавим компонент «MainMenu».В компоненте MainMenu для добавления списка меню необходимо щелкнуть на значок <…>в свойстве Items.

Рисунок 12 – Работа со свойством Items в компоненте MainMenu

Рисунок 13 – Настройка компонента MainMenu

Для удобства размещения компонентов используется модуль хранения компонентов данныхDataModule. Компонент DataModuleпредназначен исключительно для размещения на нем невизуальных компонент для доступа к данным.

Отличие окна DataModule от обычной формы состоит в том, что на нем можно размещать только невизуальные компоненты. Это могут быть не только компоненты для доступа к данным, но, и любые другие, необходимые в разных частях приложения. В окне DataModule размещены компоненты необходимые для связи с таблицами БД, такие как: ADOConnection, ADOTable и DataSource.

Рисунок 14 - Окно DataModule

Для связи интерфейсаcБД, созданной в MSAccess, предусмотренкомпонент ADOConnection,находящийся на вкладкеADO. Для подключения к базе компонент размещается на форме и в свойстве LoginPrompt ставится False, чтобы при подключении пароль не запрашивался. Это делается только на этапе создания интерфейса. Далее в свойстве ConnectionStringнужно нажать на значок «…», в открывшемся окне необходимо выбрать UseConnectionStringи нажать кнопку Build.В появившемся окне на вкладке «Поставщик данных» нужно выбрать провайдера MicrosoftJet 4.0 OLE DB Provider, на вкладке Подключение в соответствующем поле нужно ввести имя базы данных. Затем необходимо свойство Connectedпоставить в значение Trueдля соединения с программой MSAccess.

Рисунок 15 – ConnectionString

Рисунок 16 –Свойства подключения

Для подключения к конкретной таблице в БД, используется компонент ADOTable, вкладка ADO. В свойстве Connection нужно выбрать ADOConnectionи свойство Activeпоставить в положение True. (см. страница 23)

Для того, чтобы другие компоненты Delphi могли подключаться к таблицам (черезADOTable), используется компонент DataSource, находящийся на вкладкеDataAccess. В свойстве DataSet нужно выбрать соответствующий компонент ADOTable. (см. страница 24)

Для отображения данных БД в форме таблицы, используется компонент DBGrid, находящийся на вкладке DataControls.В свойстве DataSource выбирается соответствующий компонент DataSource (см. страница 22).

Для ввода полей БД в форме таблицы используется компонент DBEdit, находящийся на вкладке DataControls.В свойстве DataSource выбирается соответствующий компонент DataSource.Основным отличием DBEdit является наличие свойства DataSource, при помощи которого они связываются с источником данных. Еще одно свойство DataField указывает на то поле, которое должно отображаться в данном компоненте(см. страница 29).

Для связи одной таблице с другой таблицей используется компонент DBLookUPCombobox, находящийся на вкладке DataControls.В свойствеListSourceнужно выбрать соответствующий компонент DataSourceтаблицы-справочника, в свойстве ListFieldнужно выбрать соответствующее поле таблицы-справочника, в свойстве KeyFieldнужно выбрать ключевое поле. В свойстве DataSourceнужно выбрать соответствующий компонент DataSource конечной таблицы, в свойстве DataFieldнужно выбрать соответствующее поле конечной таблицы (см. страница 31).

Для даты и времени используется компонент DataTimePicker, находящийся на вкладке Win 32. В свойстве Date необходимо указать формат: дд.мм.гггг (см. страница 30).

Создаём остальные формы в программном интерфейсе.

Рисунок 17 – Форма сведений о программе

Для работы со справочником воспользуемся с программой Dr. Explain. При создании справочника появится окно выбора проекта (см. рисунок 18). В этом окне выберем создание локального проекта.

Рисунок 18 – Создание проекта

После этого появится рабочее поле проекта. В рабочем поле проекта присутствует две части: левая и правая, при этом левая часть делится ещё на две части (см. рисунок 19,20).

Рисунок 19- Создание структуры проекта

Рисунок 20- Информация о странице

В верхней левой части главного окна Dr.Explain можно задать непосредственно структуру документации, создавая новые темы и разделы в них. Для этого можно использовать как сочетания клавиш, так и щелчок правой кнопкой мыши по названию проекта. По умолчанию проект в Dr.Explain имеет три страницы: Начальная страница; Оглавление; <НЕ ЗАБЫТЬ: Имя темы>. Начальная страница содержит наименование проекта и указание на то, чем является файл (по умолчанию отображается значение «Руководство пользователя»).

Рисунок 21– Начальная страница

В оглавлении отражена структура справочной документации. Страница <НЕ ЗАБЫТЬ: Имя темы> представляет собой шаблон для первой темы проекта, в рамках которого и идёт создание всей документации. К редактированию проекта можно легко вернуться, нажав на кнопку Редактор. Типовой интерфейс проекта представлен на рисунке 22.

Рисунок 22- Интерфейс проекта

Создадим следующие разделы в справочнике (см. рисунок 23-27), затем скомпилируем программу ивыполним экспорт в файл формата (*.chm).

Рисунок 23– Руководство пользователя

Рисунок 24– Назначение программы

Рисунок 25– Условие выполнения программы

Рисунок 26– Выполнение программы

Рисунок 27– Сообщение оператору

После создания справочника в программе Delphiдобавим модуль ShellApi, чтобы соединить Delphiсо справочником.

ТЕСТИРОВАНИЕ И ОТЛАДКА

Классификация ошибок

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

В целом сложность отладки обусловлена следующими причинами:

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

- возможно взаимовлияние ошибок в разных частях программы, например, за счет затирания области памяти одного модуля другим из-за ошибок адресации;

- отсутствуют четко сформулированные методики отладки.

В соответствии с этапом обработки, на котором проявляются ошибки, различают:

- синтаксические ошибки - ошибки, фиксируемые компилятором (транслятором, интерпретатором) при выполнении синтаксического и частично семантического анализа программы;

- ошибки компоновки - ошибки, обнаруженные компоновщиком (редактором связей) при объединении модулей программы;

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

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

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

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

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

- появление сообщения об ошибке, обнаруженной операционной системой, например, нарушении защиты памяти, попытке записи на устройства, защищенные от записи, отсутствии файла с заданным именем и т. п.;

- «зависание» компьютера, как простое, когда удается завершить программу без перезагрузки операционной системы, так и «тяжелое», когда для продолжения работы необходима перезагрузка;

- несовпадение полученных результатов с ожидаемыми результатами.

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

- неверное определение исходных данных,

- логические ошибки,

- накопление погрешностей результатов вычислений.

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

К последней группе относят:

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

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

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

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

Рисунок 28 - Ошибки выполнения

Отладка программы

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

– Ошибки компоновки – количество обнаруженных и исправленных синтаксических ошибок –1.

Рисунок 29–Отсутствие файла базы данных по указанному адресу

– Синтаксические ошибки – количество обнаруженных и исправленных синтаксических ошибок –5.

Рисунок 30–Поставлен знак «; » перед оператором else

– Ошибки выполнения - количество обнаруженных и исправленных ошибок выполнения –9.

Рисунок 31– Ошибка выполненияэкспорта в файл

Тестирование

Тестирование программного обеспечения– это процесс исследования, испытанияпрограммного продукта с целью получения информации о качестве продукта.

Существуют два принципа тестирования программы:

- функциональное тестирование (тестирование «черного ящика»);

- структурное тестирование (тестирование «белого ящика»).

Белый ящик – тестирование кода на предмет логики работы программы и корректности ее работы с точки зрения компилятора того языка, на котором она писалась.

Существуют следующие способы тестирования методом "Белого ящика":

Тестирование базового пути

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

Тестирование условий

Различают следующие виды тестирования:Простое условие — булева переменная или выражение отношения.Выражение отношения имеет вид:

Е1<оператор отношения>E2,

где El, Е2 — арифметические выражения, а в качестве оператора отношения используется один из следующих операторов: <, >, =, , .

Составное условие состоит из нескольких простых условий, булевых операторов и круглых скобок. Будем применять булевы операторы OR, AND (&), NOT. Условия, не содержащие выражений отношения, называют булевыми выражениями.

Тестирование циклов

Тестирование циклов производится по принципу «белого ящика», при проверке циклов основное внимание обращается на правильность конструкций циклов.

Различают 4 типа циклов: простой, вложенный, объединенный, неструктурированный.

Простые циклы. Для проверки простых циклов с количеством повторений пможет использоваться один из следующих наборов тестов: прогон всего цикла; только один проход цикла; два прохода цикла; т проходов цикла, где т<п;п- 1, п, п + 1 проходов цикла.

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

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

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

Неструктурированные циклы - Неструктурированные циклы тестированию не подлежат. Этот тип циклов должен быть переделан с помощью структурированных программных конструкций.

При тестировании «черного ящика» рассматриваются системные характеристики программ, игнорируется их внутренняя логическая структура.

Тестирование «черного ящика» обеспечивает поиск следующих категорий ошибок:некорректных или отсутствующих функций;ошибок интерфейса;ошибок во внешних структурах данных или в доступе к внешней базе данных;ошибок характеристик (необходимая емкость памяти и т. д.);ошибок инициализации и завершения.

Существует три способа тестирования «черного ящика»:

- Разбиение по эквивалентности — самый популярный способ тестирования «черного ящика». В этом способе входная область данных программы делится на классы эквивалентности. Для каждого класса эквивалентности разрабатывается один тестовый вариант.

- Способ анализа граничных значений. Большая часть ошибок происходит на границах области ввода, а не в центре. Анализ граничных значений заключается в получении тестовых вариантов, которые анализируют граничные значения. Данный способ тестирования дополняет способ разбиения по эквивалентности.