ПРИЛОЖЕНИЕ
А.1 Введение
Требования настоящего документа применяются при предварительных комплексных испытаниях, приемочных испытаниях и эксплуатации программного комплекса.
Программный комплекс (далее ПК) формирования обобщённой оценки состояния сложных технических объектов на основе обработки событий.
ПК предполагает разграничение прав пользователей только одним сотрудником - Специалистом по эксплуатации объекта. И в соответствии с правами доступа предоставляет функционал ведения справочной информации, формирование информационных отчетов и ведение оперативной информации.
Пользователь системы должны иметь навыки работы с персональным компьютером. Также ему необходимо быть знакомым с предметной областью и ознакомиться с данным руководством.
А.2 Назначение и условия применения
ПК предназначен для ввода значений параметров датчиков окружающей среды сложных технических объектов (предприятие, умный дом), получать обобщённую оценку состояния объекта на основе обработки событий; можно вести справочник пользователей, параметров и состояний; просмотреть журнал событий; вывести справку по системе.
Работа с системой доступна всем пользователям с установленными правами доступа.
Минимальные требования к техническому и программному обеспечению. Требования к процессору определяются требованиями ОС.
Минимальные требования к рабочей станции:
- процессор класса Pentiumс тактовой частотой 1,6 ГГц и выше;
- объем оперативной памяти не менее 4 Гб;
- объем свободного дискового пространства не менее 22,1 Гб;
- тип операционной системы -Windows7 64 бит (или вышедшие следом);
- манипулятор типа “мышь”;
- монитор с разрешением 1280x1024.
Условия работы:
- температура окружающего воздуха -15 - +25 °С;
- относительная влажность - 45-75%.
- содержание вредных веществ, пыли и подвижного воздуха в рабочей зоне соответствует нормам ГОСТ 12.1.005, 12.1.007; комплекс должен удовлетворять санитарным правилам и нормам СанПиН 2.2.2/2.4.1340-03.
А3. Подготовка к работе
Руководство пользователя программного комплекса формирования обобщённой оценки состояния сложных технических объектов на основе обработки событий разрабатывалось в соответствии с РД 50-34.698-90. В нем регламентировались правила оформления руководства пользователя, порядок и расположение пунктов в тексте, описывающем работу с программным комплексом, размеры и положение рисунков.
Данное руководство предназначено для специалистов по эксплуатации объекта и предполагает у пользователей комплекса наличие элементарных навыков работы с программными комплексами и умения пользоваться компьютером.
После запуска приложения, появляется окно авторизации (рисунок А.1). Пользователь должен ввести логин и пароль, нажав после этого “Войти”.
Рисунок А.1 - Окно авторизации
Рисунок А.2 - Главное окно программы
Ведение справочников
Ведение справочников пользователей, параметров, состояний и объектов.
Войдем в систему в качестве Специалиста по эксплуатации объекта, заполнив для этого форму авторизации соответствующими значениями (рисунок А.3).
Рисунок А.3 - Вход в программный комплекс с правами Специалиста по эксплуатации объекта
Система откроет меню, настроенное на права Специалиста по эксплуатации объекта (Рисунок А4).
Рисунок А.4 - Главное меню
Для ведения справочника пользователей выберете пункт меню “Справочник пользователей”.
Рисунок А.5 - Окно ведения справочника пользователя
Для ведения остальных справочников - справочника Параметров, Состояний и Объектов - выберите пункт меню “Справочник параметров”, “Справочник состояний” и “Справочник параметров” и по очереди заполните необходимые справочники, вызвав соответствующие формы и воспользовавшись ими (рисунок А.6,А.7 и А.8).
Рисунок А.6 - Окно ведения справочника параметров
Рисунок А.7 - Окно ведения справочника состояний
Рисунок А.8 - Окно ведения справочника объектов
Отсутствие той или иной информации приведёт к невозможности ведения справочника, и будет сопровождаться информационными сообщениями, приведенными в таблице А.1.
Таблица А.1 - Информационные сообщения
|
Содержание сообщения |
Пояснение |
Пути решения |
|
|
Вы не заполнили одно из полей, перепроверьте информацию |
Вероятно, не внесены одна или более записей о пользователях в поля формы |
Внести записи о пользователях в поля формы |
|
|
Запись сохранена |
Запись успешно сохранена |
Никаких действий |
Только после занесения в соответствующие поля справочника исчерпывающей информации, возможно добавление записи (рисунок А.7)
Рисунок А.9 - Успешное добавление записи
ПРИЛОЖЕНИЕ 2
Аннотация
В данном программном документе приведено руководство программиста по использованию программы “PCEvent.exe”, предназначенной для формирования обобщённой оценки состояния технически сложного объекта.
В данном программном документе, в разделе “Назначение и условия применения программы” указаны назначение и функции, выполняемые программой, условия, необходимые для выполнения программы (объем оперативной памяти, требования к составу и параметрам периферийных устройств, требования к программному обеспечению и т.п.).
В разделе “Характеристика программы” приведено описание основных характеристик и особенностей программы (режим работы, средства контроля правильности выполнения и т.п.).
В данном программном документе, в разделе “Входные и выходные данные” приведено описание организации используемой входной и выходной информации.
В разделе “Сообщения” указаны тексты сообщений, выдаваемых программисту или оператору в ходе выполнения программы, описание их содержания и действий, которые необходимо предпринять по этим сообщениям.
Оформление программного документа “Руководство программиста” произведено по требованиям ЕСПД (ГОСТ 19.101-77 1), ГОСТ 19.103-77 2), ГОСТ 19.104-78* 3), ГОСТ 19.105-78* 4), ГОСТ 19.106-78* 5), ГОСТ 19.504-79* 6), ГОСТ 19.604-78* 7)).
1. НАЗНАЧЕНИЕ И УСЛОВИЕ ПРИМЕНЕНИЯ ПРОГРАММЫ
1.1 Назначение программы
Зачастую приходится принимать решения в условиях неполной информации об объекте, когда логические процедуры не могут дать однозначного (детерминированного) решения проблемы. В таких случаях оператор-диспетчер привлекает хранящуюся в его памяти информацию о частотах появления тех или иных технологических признаков, возникновения тех или иных ситуаций для принятия вероятностных решений. Данная программа помогает оператору в этом.
1.2 Функции, выполняемые программой
Основной функцией программы “PCEvent.exe” является ввод и обработка событий (угроз) и формирование обобщённой оценки состояния объекта.
Программа “PCEvent.exe” реализует следующие функции:
* авторизация пользователей;
* статистика событий (угроз) и состояний.
* ведение справочников, указанных в п.2.3.3.
1.3 Условия, необходимые для выполнения программы
1.3.1 Объем оперативной памяти
Для выполнения своих функций, программе “PCEvent.exe” достаточно 100 Мб оперативной памяти. Но, исходя из того, что для функционирования операционной системы необходимо минимум 32 Мб оперативной памяти, то рекомендуется использовать программу “PCEvent.exe” на ПК, имеющем ОЗУ более 512 Мб.
1.3.2 Требования к составу периферийных устройств
Никаких требований к составу периферийных устройств, программа “PCEvent.exe” не предъявляет.
1.3.3 Требования к параметрам периферийных устройств
Никаких требований к параметрам периферийных устройств, программа “PCEvent.exe” не предъявляет.
1.3.4 Требования к программному обеспечению
Системные программные средства, используемые программой “PCEvent.exe”, должны быть представлены локализованной версией операционной системы Windows 8 или Windows 7.
Программа “PCEvent.exe” не предназначена для самостоятельной работы, она работает тогда, когда её запускает пользователь. Программа Model может быть установлена в любое удобное для пользователя место. Для установки данной программы достаточно скопировать перечисленные ниже файлы в указанную папку на компьютере пользователя. Каких-либо настроек после копирования программы Model не требуется.
Список необходимых файлов программы “PCEvent.exe”:
* Model 192 512 байт
1.3.5 Требования к персоналу (программисту)
Программист должен иметь минимум среднее техническое образование и должен быть аттестован минимум на II квалификационную группу по электробезопасности (для работы с конторским оборудованием)
В перечень задач, выполняемых программистом, должны входить:
а) задача поддержания работоспособности технических средств;
б) задача поддержания работоспособности системных программных средств - операционной системы.
2. ХАРАКТЕРИСТИКА ПРОГРАММЫ
2.1 Описание основных характеристик программы.
2.1.1 Режим работы программы
Режим работы программы “PCEvent.exe” круглосуточный непрерывный.
2.1.2 Контроль правильности выполнения программы.
После запуска программы и некоторого времени работы нажать кнопку "Пауза", и снова продолжить если программа продолжит работу, то все исправно.
2.2 Описание основных особенностей программы
Программа “PCEvent.exe” не имеет пользовательского интерфейса и не предоставляет конечному пользователю возможности настройки и изменения своих параметров.
3. ОБРАЩЕНИЕ К ПРОГРАММЕ
3.1 Загрузка и запуск программы
Загрузка и запуск программы “PCEvent.exe” осуществляется способами, детальные сведения о которых изложены в "Руководстве пользователя" программным комплексом.
3.2 Выполнение программы
3.2.1 Выполнение функции программы
Выполнение функций программы “PCEvent.exe” осуществляется способами, детальные сведения о которых изложены в "Руководстве пользователя" программным комплексом.
3.3 Завершение работы программы
Программа “Model.exe” выключается простейшим нажатием на кнопку "Выход".
4. ВХОДНЫЕ И ВЫХОДНЫЕ ДАННЫЕ
4.1 Организация используемой входной информации
Программа “Model.exe” в ходе своей работы не использует входных данных которые можно ввести. Все входные данные уже внесены и появляются исключительно как подсказка у работе.
4.2 Организация используемой выходной информации
Программа “Model.exe” в ходе своей работы все выходные данные выдаёт как граффики.
5. СООБЩЕНИЯ
5.1 Сообщение о незаполненном поле.
Программа “PCEvent.exe” выдает сообщение о незаполненном поле в справочнике при добавлении записи или при вводе параметров (рисунок Б.1).
Рисунок Б.1 - Сообщение о незаполненном поле
5.2 Сообщение об успешном сохранении записи.
Программа “PCEvent.exe” выдает сообщение об успешном сохранении записи в справочнике (рисунок Б.2).
Рисунок Б.2 - Сообщение об успешном сохранении записи
5.3 Сообщение о подтверждении удаления записи.
Программа “PCEvent.exe” выдает сообщение о подтверждении удаления записи в справочнике (рисунок Б.3).
Рисунок Б.3 - Сообщение о подтверждении удаления записи
5.4 Сообщение о неправильно введённом логине или пароле.
Программа “PCEvent.exe” выдает сообщение о неправильно введённом логине или пароле в окне авторизации (рисунок Б.4).
Рисунок Б.4 - Сообщение о неправильно введённом логине или пароле
Всё связанное с дальнейшими действиями описано в "Руководстве пользователя" программным комплексом.
ПРИЛОЖЕНИЕ 3
Листинг основных модулей программы
journal.h
#ifndef JOURNAL_H
#define JOURNAL_H
#include <QDialog>
#include <QSqlQueryModel>
#include <QSqlQuery>
namespace Ui {
class Journal;
}
class Journal : public QDialog
{
Q_OBJECT
public:
explicit Journal(QWidget *parent = 0);
~Journal();
private slots:
void on_btnBack_clicked();
private:
Ui::Journal *ui;
};
#endif // JOURNAL_H
login.h
#ifndef LOGIN_H
#define LOGIN_H
#include <QDialog>
#include <QDebug>
#include <QSql>
#include <QSqlDatabase>
#include <QSqlQuery>
#include <QString>
#include <QMessageBox>
namespace Ui {
class Login;
}
class Login : public QDialog
{
Q_OBJECT
public:
QSqlDatabase db;
void connClose()
{
db.close();
db.removeDatabase(db.connectionName());
}
bool connOpen()
{
QString dbName = "C:\\BD1.mdb";
QSqlDatabase db = QSqlDatabase::addDatabase(QLatin1String("QODBC"));
QString conn1 = QString("DRIVER={Microsoft Access Driver (*.mdb)};FIL={MS Access};DBQ=%1;").arg(dbName);
db.setDatabaseName(conn1);
if(!db.open()){
qDebug()<<("Failed to open the database");
return false;
}
else{
qDebug()<<("Connected....");
return true;
}
}
public:
explicit Login(QWidget *parent = 0);
~Login();
private slots:
void on_btnExit_clicked();
void on_btnLogin_clicked();
void on_btnClear_clicked();
private:
Ui::Login *ui;
};
#endif // LOGIN_H
mainwindow.h
#ifndef LOGIN_H
#define LOGIN_H
#include <QDialog>
#include <QDebug>
#include <QSql>
#include <QSqlDatabase>
#include <QSqlQuery>
#include <QString>
#include <QMessageBox>
namespace Ui {
class Login;
}
class Login : public QDialog
{
Q_OBJECT
public:
QSqlDatabase db;
void connClose()
{
db.close();
db.removeDatabase(db.connectionName());
}
bool connOpen()
{
QString dbName = "C:\\BD1.mdb";
QSqlDatabase db = QSqlDatabase::addDatabase(QLatin1String("QODBC"));