МИНИСТЕРСТВО ОБРАЗОВАНИЯ И НАУКИ РОССИЙСКОЙ ФЕДЕРАЦИИ
федеральное государственное бюджетное образовательное учреждение
высшего образования
«УЛЬЯНОВСКИЙ ГОСУДАРСТВЕННЫЙ ТЕХНИЧЕСКИЙ УНИВЕРСИТЕТ»
Кафедра «Измерительно-вычислительные комплексы»
Элемент управления “Помощник в выборе прошивки”
Руководство программиста
Р.02069337. 16/889-03 ТЗ-01
Листов 7
Руководитель разработки:
ассистент каф. ИВК
Москвичёва Мария Геннадьевна
«» 2020 г.
Исполнитель:
студент гр. ИСТбд-21
Ёрочкин Денис Сергеевич
«» 2020 г.
1. Назначение и условия применения программы
Назначение и функции, выполняемые элементом управления
Элемент управления "Помощник в выборе прошивки для телефона", условно обозначаемый как FirmWareInstallation содержит в себе подробную информацию о прошивках для телефонов (на базе Android),разработчики могут обновлять и добавлять прошивки, а также удалять их.
Функциональные возможности:
1. Ведение коллекции прошивок.
2. Выбор конкретной прошивки.
3. Просмотр подробной информации о прошивках.
4. Видимость количества доступных прошивок на выбранный телефон.
5. Изменение размера, местоположения, доступности элемента управления.
6. Изменение основных элементов управления, включённых в составной элемент управления.
7. Добавление/удаление элементов(прошивок).
8. Настройка возможности добавления/удаления/обновления прошивок посредством ввода пароля.
9. Настройка возможности восстановления последнего удалённого элемента, а также возможности обновлять прошивки и прятать недоступные прошивки.
10. Наличие дополнительного окна для ввода/редактирования/чтения данных.
11. Полный контроль ошибок с выводом соответствующего подробного сообщения, указывающего на причину возникновения ошибки.
12. Изменение элемента управления при изменении состояния корзины, обновления и скрытия прошивок.
Условия, необходимые для использования элемента управления
Необходимые условия:
1. Операционная система: Windows 10 или более поздняя.
2. Установленный Microsoft.NET Framework 4.6.1 или выше.
3. Поддержка версии языка C# 7.0.
4. Интегрированная среда разработки Visual Studio Community 2017 или выше.
2. Характеристики программы
Характеристики элемента управления
В элементе управления: 1200 значимых строк, 13 свойств (7 различных типов): 2 — List<FirmWareStorage>, 1 — Font, 5 — bool, 1 — string, 2 — Color, 1 — Cursor, 1 — int, 6 методов, 4 конструктора, 4 события.
Пояснения:
1. Для получения полного доступа к элементу управления необходимо ввести пароль (11111111). При его вводе разблокируются функции добавления, удаления и обновления прошивок (обновление разблокируется, только если также установлен флаг, разрешающий эту функцию - AllowUpdates). При вводе правильного пароля окно для ввода пароля пропадёт.
2. Для доступа к сокрытию недоступных прошивок и для сохранения последней удалённой прошивки, а также для обновления необходимо перед запуском установить соответствующие флаги – HideIsAvailable, AllowUpdates и RecoveryIsEnable.
3. При выборе одного из элементов в текущем ListBox незамедлительно появляется следующий ListBox и заполняется соответствующими предыдущему выбору значениями.
4. При добавлении/обновлении/просмотре прошивок появляется одна и та же форма. Разница в тексте, записанном в элементы Label, и свойствах TextBox.ReadOnly, CheckBox.Enabled и numericUpDown.ReadOnly. Так при добавлении прошивки все элементы TextBox доступны для заполнения. При обновлении textBoxFirm и textBoxPhone недоступны, т.к. прошивка относится только к конкретному телефону, а потому менять это поля не рекомендуется. При чтении все элементы TextBox, numericUpDown и CheckBox доступны только для чтения.
5. При попытке добавить копию существующей в элементе управления прошивки вызывается MessageBox с сообщением о запрете данного действия. Если свойство AllowUpdates = true, то сообщение будет иметь изменённое содержание. При попытке добавить копию форма для заполнения закроется, добавление будет отклонено.
6. Корзина является строковым типом, который посредством стандартных преобразований становится объектов списка прошивок List<FirmWareStorage> Storage.
7. В элементе управления используются методы повышения производительности и ускорения работы программы за счёт работы с памятью и правильного использования известных функций.
Режимы работы элемента управления:
1. Обычный режим (ограничены некоторые возможности (см. п. 2.1).
2. Продвинутый режим (для разработчиков доступны функции добавления, удаления (соответственно и восстановление тоже будет доступно) и обновления прошивок).
Стандартный вид элемента управления:
Стандартный вид формы для добавления прошивки:
Контроль ввода значений реализован с помощью соответствующей функции, описанной ниже в п.3. Функция проверяет, введено ли значение в каждый из элементов Textbox и numericUpDown. Для элемента CheckBox проверка не осуществляется. При наличии незаполненных полей, вызывается MessageBox с соответствующим сообщением (поля проверяются в порядке сверху вниз).
2.2 Особенности реализации элемента управления
При скрытии недоступных прошивок, они переносятся в специальное хранилище List<FirmWareStorage> HiddenStorage. При отображении недоступных прошивок это хранилище очищается, а недоступные прошивки переносятся обратно в основное хранилище.
Для уменьшения потребления памяти корзина Bin является типом string, а не List<FirmWareStorage> или объектом собственного класса FirmWareStorage.
Интерфейс IPropertiesFunc содержит только методы, являющиеся важной составляющей элемента управления. Интерфейс IControlSettings содержит только свойства, изменяющие элемент управления.
Почти в каждой функциональности используется метод ResetProperties(), который перестраивает элементы ListBox.
3. Обращение к программе
Свойства:
1. List<FirmWareStorage> Storage – является основным хранилищем прошивок.
2. List<FirmWareStorage> HiddenStorage – является хранилищем для недоступных прошивок при вызове соответствующей функциональности.
3. int C – является своего рода счётчиком, который при инкременте выводит сообщение о том, что была добавлена прошивка, а при декременте – о том, что прошивка была удалена.
4. bool HiddenValue – логическое свойство, выводящее при истине сообщение о том, что все недоступные прошивки спрятаны, а при лжи – о том, что все прошивки снова видимые.
5. string Bin – корзина для хранения последнего удалённого элемента. При передаче в эту переменную значения “” происходит очистка корзины.
6. bool HideIsAvailable – свойство, которое отвечает за наличие доступа к функции скрытие недоступных прошивок. Изначально принимает значение истины.
7. bool AllowUpdates – свойство, которое отвечает за наличие доступа к функции обновления прошивок. Изначально принимает значение лжи. Свойство не имеет значения в обычном режиме элемента управления (см. п. 2.1).
8. bool RecoveryIsEnable – свойство, которое отвечает за наличие доступа к функции восстановления прошивок. Изначально принимает значение лжи. При таком значении доступ к методу будет предоставлен, но при попытке восстановить прошивку выводится сообщение о том, что данная функция недоступна.
9. Font ListBoxFont – свойство, меняющее шрифт элементов в Listbox. По умолчанию используется стандартный шрифт элементов управления.
10. Color LabelColor – свойство, меняющее фон элементов Label. По умолчанию используется стандартный фон элемента управления panel1.
11. Color BackGround – свойство, меняющее фон элементов ListBox. По умолчанию используется стандартный фон элемента управления Control.
12. Cursor LabelDefaultCursor – свойство, меняющее курсор в области элементов Label. По умолчанию используется стандартный курсор.
13. bool ListBoxScrollVisible – свойство, влияющее на постоянное отображение колеса прокрутки элементов Listbox.
Конструкторы:
1. FirmWareInstallation(). Стандартный конструктор без аргументов.
2. FirmWareInstallation(int x, int y). Конструктор позиционирования элемента управления, указывает его первоначальные координаты.
3. FirmWareInstallation(double Size). Конструктор размера элемента управления. Тип double преобразуется внутри конструктора в два int. Целая часть – ширина, дробная часть – высота.
4. FirmWareInstallation(bool EnableState). Конструктор, определяющий, доступен ли элемент управления. По умолчанию – доступен.
События:
1. Event AddFirmWare AddNewItem – происходит при добавлении прошивки в список List<FirmWareStorage> Storage. Событие вызывает добавление объекта.
2. Event DeleteFirmWare DeleteItem – происходит при удалении прошивки из списка List<FirmWareStorage> Storage. Событие вызывает удаление объекта.
3. Event UpdateFirmWare UpdateItem – происходит при обновлении прошивки из списка List<FirmWareStorage> Storage. Событие вызывает обновление объекта.
4. Event HideUnAvailableFirmWare HideItem – происходит при скрытии прошивки из списка List<FirmWareStorage> Storage. Событие вызывает скрытие объекта (обменом).
Методы:
1. bool DataIsValid(object sender) – принимает объект и проверяет его на корректность. Проверяются почти все свойства собственного класса. Возвращает логическое значение проверки. В случае корректного объекта возвращает истину. В случае ошибки – ложь.
2. bool SelectionIsAvailable(int ID) – принимает значение от 0 до 4 и проверяет статус ListBox с выбранным ID. В случае ID = 0 проверяет каждый ListBox. Возвращает логическое значение проверки.
3. bool RecycleFunc(string Bin) – принимает строковое значение и проверяет его на пустоту. Возвращает логическое значение проверки.
4. bool UniqueCheck(List<string> Unique, string Value) – принимает два аргумента: первый – список значений строкового типа, а второй – значение строкового типа. Метод проверяет наличие Value в Unique. Возвращает логическое значение проверки.
5. string RecoveryLastRemovedData(bool RecoveryState, Func<string,bool> Recycle, string Firm = “Default”, string Phone = “Default”, string FirmWare = “Default”, string Version = “Default”, bool IsAvailable = true, string ProCreator = “Default”, ushort YearOfCreation = 2000) – принимает логическое значение стадии восстановления, функцию проверки корзины на пустоту и все свойства собственного класса со значениями по умолчанию. Значения по умолчанию используются для того, чтобы исключить лишние переменные во время первой стадии. Метод возвращает содержимое корзины во время второй (заключительной) стадии восстановления при условии, что корзина не пуста. В противном случае, вызывается элемент MessageBox с соответствующим сообщением о том, что корзина пустая. Во время первой стадии происходит сохранение объекта и его преобразование в строковый тип с дальнейшим возвратом из функции.
6. void ResetProperties(bool ResetFirm, bool ResetPhone, bool ResetFirmWare, bool ResetVersion) – принимает 4 значения логического типа, по порядку следования элементов Listbox слева направо. Метод перестраивает элементы Listbox посредством снятия выделения с элементов, затем очистки Listbox и, наконец, скрытием элемента Listbox (за исключением самого первого, его метод заполняет новыми значениями вместо скрытия)
4. Сообщения
Сообщения пользователю:
1. При успешном действии (обновление, удаление, обновление и т.д.) пользователь элемента управления увидит сообщение об успехе операции и результат на элементе управления.
Примеры:
2. В случае возникновения ошибки пользователь получит соответствующее сообщение с информацией о том, что пошло не так.
Примеры:
