diff --git a/LibOfTimetableOfClasses/CAuditor.cs b/LibOfTimetableOfClasses/CAuditor.cs index 260db8835..d59a55233 100644 --- a/LibOfTimetableOfClasses/CAuditor.cs +++ b/LibOfTimetableOfClasses/CAuditor.cs @@ -9,11 +9,15 @@ namespace LibOfTimetableOfClasses { /// - /// Контроллер объекта Аудитория. + /// Таблица со строками, хранящими данные о разных аудиториях Университета. /// public class CAuditor : DataTable, IController { - + /// + /// Конструктор таблицы + /// Формируются поля таблицы типа DataTable и их свойства. + /// Уникальность строки в таблице определяется уникальностью поля NameOfAuditor + /// public CAuditor() : base("Аудитория") { DataColumn[] keys = new DataColumn[2]; @@ -44,7 +48,12 @@ public CAuditor() : base("Аудитория") keys[1] = column; PrimaryKey = keys; } - + /// + /// Метод вставки переданной модели MAuditor в таблицу CAuditor + /// в случае уникальности поля NameOfAuditor + /// + /// Модель хранящая добавляемую запись таблицы + /// Результат вставки public bool Insert(Model model) { MAuditor mAuditor = (MAuditor)model; @@ -67,7 +76,12 @@ public bool Insert(Model model) return false; } } - + /// + /// Обновление свойств строки в таблице CAuditor из переданной модели MAuditor + /// Поиск изменяемой строки CAuditor осуществляется по полю "NameOfAuditor" + /// + /// Модель хранящая обновляемую запись таблицы + /// Результат обновления public bool Update(Model model) { MAuditor mAuditor = (MAuditor)model; @@ -99,7 +113,14 @@ public bool Update(Model model) } return false; } - + /// + /// Метод удаления строки соответствующей переданной модели из таблицы CAuditor. + /// В таблице CAuditor ищется строка с полем "NameOfAuditor" соответсвующим этому же полю модели, + /// переданной в качестве параметра. + /// В случае успеха поиска удаляется найденная строка. + /// + /// Модель, хранящая выбранную строку в таблице + /// Результат удаления переданной строки из CAuditor public bool Delete(Model model) { MAuditor mAuditor = (MAuditor)model; diff --git a/LibOfTimetableOfClasses/CDirectionOfPreparation.cs b/LibOfTimetableOfClasses/CDirectionOfPreparation.cs index 8ad9267db..0898151e7 100644 --- a/LibOfTimetableOfClasses/CDirectionOfPreparation.cs +++ b/LibOfTimetableOfClasses/CDirectionOfPreparation.cs @@ -8,8 +8,16 @@ namespace LibOfTimetableOfClasses { + /// + /// Таблица со строками, хранящими данные о разных направлениях подготовки Университета. + /// public class CDirectionOfPreparation : DataTable, IController { + /// + /// Конструктор таблицы + /// Формируются поля таблицы типа DataTable и их свойства. + /// Уникальность строки в таблице определяется уникальностью поля CodeOfDP + /// public CDirectionOfPreparation() : base("Направление подготовки") { DataColumn column = new DataColumn(); @@ -28,6 +36,14 @@ public CDirectionOfPreparation() : base("Направление подготов column.ColumnName = "PeriodOfStudy"; Columns.Add(column); } + /// + /// Метод удаления строки соответствующей переданной модели из таблицы CDirectionOfPreparation. + /// В таблице CDirectionOfPreparation ищется строка с полем "NameOfDP" соответсвующим этому же полю модели, + /// переданной в качестве параметра. + /// В случае успеха поиска удаляется найденная строка. + /// + /// Модель, хранящая выбранную строку в таблице + /// Результат удаления переданной строки из CDirectionOfPreparation public bool Delete(Model model) { MDirectionOfPreparation mDirectionOfPreparation = (MDirectionOfPreparation)model; @@ -44,6 +60,12 @@ public bool Delete(Model model) } return false; } + /// + /// Метод вставки переданной модели MDirectionOfPreparation в таблицу CDirectionOfPreparation + /// в случае уникальности поля CodeOfDP + /// + /// Модель хранящая добавляемую запись таблицы + /// Результат вставки public bool Insert(Model model) { MDirectionOfPreparation mDirectionOfPreparation = (MDirectionOfPreparation)model; @@ -66,7 +88,12 @@ public bool Insert(Model model) return false; } } - + /// + /// Обновление свойств строки в таблице CDirectionOfPreparation из переданной модели MDirectionOfPreparation + /// Поиск изменяемой строки CAuditor CDirectionOfPreparation по полю "NameOfDP" + /// + /// Модель хранящая обновляемую запись таблицы + /// Результат обновления public bool Update(Model model) { MDirectionOfPreparation mDirectionOfPreparation = (MDirectionOfPreparation)model; @@ -96,7 +123,9 @@ public bool Update(Model model) } return false; } - + /// + /// Какая-то заглушка + /// public bool Update(DataRow row, Model model) { throw new NotImplementedException(); diff --git a/LibOfTimetableOfClasses/CDiscipline.cs b/LibOfTimetableOfClasses/CDiscipline.cs index bafd5ad8f..f6b5f8219 100644 --- a/LibOfTimetableOfClasses/CDiscipline.cs +++ b/LibOfTimetableOfClasses/CDiscipline.cs @@ -8,12 +8,17 @@ namespace LibOfTimetableOfClasses { - /// - /// Контроллер для объекта Дисциплина - /// - public class CDiscipline : DataTable,IController + /// + /// Таблица со строками, хранящими данные о разных дисциплинах Университета. + /// + public class CDiscipline : DataTable,IController { - public CDiscipline() : base("Дисциплина") + /// + /// Конструктор таблицы + /// Формируются поля таблицы типа DataTable и их свойства. + /// Уникальность строки в таблице определяется уникальностью поля Fullname + /// + public CDiscipline() : base("Дисциплина") { DataColumn column = new DataColumn(); column.DataType = typeof(string); @@ -31,8 +36,15 @@ public CDiscipline() : base("Дисциплина") column.ColumnName = "CycleofDiscipline"; Columns.Add(column); } - - public bool Delete(Model model) + /// + /// Метод удаления строки соответствующей переданной модели из таблицы CDiscipline. + /// В таблице CDiscipline ищется строка с полем "Fullname" соответсвующим этому же полю модели, + /// переданной в качестве параметра. + /// В случае успеха поиска удаляется найденная строка. + /// + /// Модель, хранящая выбранную строку в таблице + /// Результат удаления переданной строки из CDiscipline + public bool Delete(Model model) { MDiscipline mDiscipline = (MDiscipline)model; @@ -48,8 +60,13 @@ public bool Delete(Model model) } return false; } - - public bool Insert(Model model) + /// + /// Метод вставки переданной модели MDiscipline в таблицу CDiscipline + /// в случае уникальности поля Fullname + /// + /// Модель хранящая добавляемую запись таблицы + /// Результат вставки + public bool Insert(Model model) { MDiscipline mDiscipline = (MDiscipline)model; @@ -79,8 +96,13 @@ public bool Insert(Model model) return false; } } - - public bool Update(Model model) + /// + /// Обновление свойств строки в таблице CDiscipline из переданной модели MDiscipline + /// Поиск изменяемой строки CAuditor осуществляется по полю "Fullname" + /// + /// Модель хранящая обновляемую запись таблицы + /// Результат обновления + public bool Update(Model model) { MDiscipline mDiscipline = (MDiscipline)model; @@ -109,7 +131,9 @@ public bool Update(Model model) } return false; } - + /// + /// Какая-то заглушка + /// public bool Update(DataRow row, Model model) { throw new NotImplementedException(); diff --git a/LibOfTimetableOfClasses/CTrainingProfiles.cs b/LibOfTimetableOfClasses/CTrainingProfiles.cs index 9a7de3054..4b3f322f2 100644 --- a/LibOfTimetableOfClasses/CTrainingProfiles.cs +++ b/LibOfTimetableOfClasses/CTrainingProfiles.cs @@ -9,10 +9,15 @@ namespace LibOfTimetableOfClasses { /// - /// Контроллер класса объекта Профили подготовки + /// Таблица со строками, хранящими данные о разных профилях подготовки Университета. /// public class CTrainingProfile : DataTable, IController { + /// + /// Конструктор таблицы + /// Формируются поля таблицы типа DataTable и их свойства. + /// Уникальность строки в таблице определяется уникальностью полей Fullname и Shortname + /// public CTrainingProfile() : base("Профиль подготовки") { DataColumn column = new DataColumn(); @@ -32,7 +37,14 @@ public CTrainingProfile() : base("Профиль подготовки") //column.Unique = true; Columns.Add(column); } - + /// + /// Метод удаления строки соответствующей переданной модели из таблицы CTrainingProfile. + /// В таблице CTrainingProfile ищется строка с полем "Fullname" соответсвующим этому же полю модели, + /// переданной в качестве параметра. + /// В случае успеха поиска удаляется найденная строка. + /// + /// Модель, хранящая выбранную строку в таблице + /// Результат удаления переданной строки из CTrainingProfile public bool Delete(Model model) { MTrainingProfile mTrainingProfile = (MTrainingProfile)model; @@ -51,6 +63,12 @@ public bool Delete(Model model) } return false; } + /// + /// Метод вставки переданной модели MTrainingProfile в таблицу CTrainingProfile + /// в случае уникальности поля Fullname + /// + /// Модель хранящая добавляемую запись таблицы + /// Результат вставки public bool Insert(Model model) { MTrainingProfile mTrainingProfile = (MTrainingProfile)model; @@ -72,6 +90,12 @@ public bool Insert(Model model) return false; } } + /// + /// Обновление свойств строки в таблице CTrainingProfile из переданной модели MTrainingProfile + /// Поиск изменяемой строки CTrainingProfile осуществляется по полю "FullName" + /// + /// Модель хранящая обновляемую запись таблицы + /// Результат обновления public bool Update(Model model) { MTrainingProfile mTrainingProfile = (MTrainingProfile)model; diff --git a/LibOfTimetableOfClasses/MAuditor.cs b/LibOfTimetableOfClasses/MAuditor.cs index ee8cef01c..79df2a7c9 100644 --- a/LibOfTimetableOfClasses/MAuditor.cs +++ b/LibOfTimetableOfClasses/MAuditor.cs @@ -29,7 +29,13 @@ public class MAuditor : Model /// string building; - + /// + /// Создает экземпляр Аудитории + /// + /// Название аудитории + /// Кафедра + /// Вместительность + /// Корпус public MAuditor(string nameOfAuditor, string cafedra, ushort spacious, string building) : base() { NameOfAuditor = nameOfAuditor; @@ -39,7 +45,7 @@ public MAuditor(string nameOfAuditor, string cafedra, ushort spacious, string bu } /// - /// Возвращает или задает nameofaud - название аудитории + /// nameofaud - название аудитории /// public string NameOfAuditor { @@ -55,7 +61,7 @@ public string NameOfAuditor } /// - /// Возвращает или задает cafedra - кафедру + /// cafedra - кафедру /// public string Cafedra { @@ -71,7 +77,7 @@ public string Cafedra } /// - /// Возвращает или задает building - корпус + /// building - корпус /// public string Building { @@ -87,7 +93,7 @@ public string Building } /// - /// Возвращает или задает spacious - вместительность + /// spacious - вместительность /// public ushort Spacious { diff --git a/LibOfTimetableOfClasses/MDirectionOfPreparation.cs b/LibOfTimetableOfClasses/MDirectionOfPreparation.cs index 32278a42b..0858d6698 100644 --- a/LibOfTimetableOfClasses/MDirectionOfPreparation.cs +++ b/LibOfTimetableOfClasses/MDirectionOfPreparation.cs @@ -9,17 +9,33 @@ namespace LibOfTimetableOfClasses { public class MDirectionOfPreparation : Model { + /// + /// Код направления подготовки + /// protected string codeOfDP; + /// + /// Название направления подготовки + /// protected string nameOfDP; + /// + /// Период обучения + /// protected ushort periodOfStudy; - + /// + /// Создает экземпляр направления подготовки + /// + /// Код направления подготовки + /// Название направления подготовки + /// Период обучения public MDirectionOfPreparation(string codeOfDP, string nameOfDP, ushort periodOfStudy) : base() { CodeOfDP = codeOfDP; NameOfDP = nameOfDP; PeriodOfStudy = periodOfStudy; } - + /// + /// codeOfDP - код напраления подготовки + /// public string CodeOfDP { set @@ -31,11 +47,17 @@ public string CodeOfDP get { return codeOfDP; } } + /// + /// nameOfDP - название напраления подготовки + /// public string NameOfDP { set { nameOfDP = value; } get { return nameOfDP; } } + /// + /// periodOfStudy - период обучения + /// public ushort PeriodOfStudy { set diff --git a/LibOfTimetableOfClasses/MDiscipline.cs b/LibOfTimetableOfClasses/MDiscipline.cs index 20d043590..7acf8118f 100644 --- a/LibOfTimetableOfClasses/MDiscipline.cs +++ b/LibOfTimetableOfClasses/MDiscipline.cs @@ -38,16 +38,16 @@ public MDiscipline(string fullName, string shortName, string cycleOfDiscipline) } /// - /// Возвращает или задает значение Name - полное название + /// fullName - полное название /// public string Fullname { set { fullName = value; } get { return fullName; } } /// - /// Возвращает или задает значение Shortname - краткому названию + /// shortName - краткому названию /// public string Shortname { set { shortName = value; } get { return shortName; } } /// - /// + /// cycleOfDiscipline - цикла дисциплины /// public string CycleofDiscipline { set { cycleOfDiscipline = value; } get { return cycleOfDiscipline; } } } diff --git a/LibOfTimetableOfClasses/MTrainingProfiles.cs b/LibOfTimetableOfClasses/MTrainingProfiles.cs index 6ff6fde30..9df0cd046 100644 --- a/LibOfTimetableOfClasses/MTrainingProfiles.cs +++ b/LibOfTimetableOfClasses/MTrainingProfiles.cs @@ -21,9 +21,12 @@ public class MTrainingProfile : Model /// string shortname; /// - /// Возвращает или задает fullname - Полное название профиля подготовки + /// Шифр направления /// string shiphr; + /// + /// fullname - Полное название профиля подготовки + /// public string FullName { get @@ -39,7 +42,7 @@ public string FullName } } /// - /// Возвращает или задает shortname - Краткое название профиля подготовки + /// shortname - Краткое название профиля подготовки /// public string ShortName { @@ -55,6 +58,9 @@ public string ShortName shortname = value; } } + /// + /// shiphr - Шифр напраления подготовки + /// public string Shiphr { get @@ -66,13 +72,22 @@ public string Shiphr shiphr = value; } } + /// + /// Создает экземпляр Профиля подготовки + /// + /// Полное название профиля подготовки + /// Краткое название профиля подготовки + /// Шмфр направления подготовки public MTrainingProfile(string fullname, string shortname, string shiphr) :base() { FullName = fullname; ShortName = shortname; Shiphr = shiphr; } - + /// + /// Возвращает string краткое название профиля подготовки + /// + /// public override string ToString() { return this.ShortName; diff --git a/LibOfTimetableOfClasses/RefData.cs b/LibOfTimetableOfClasses/RefData.cs index fef215e97..86a863374 100644 --- a/LibOfTimetableOfClasses/RefData.cs +++ b/LibOfTimetableOfClasses/RefData.cs @@ -28,16 +28,16 @@ public class RefData public RefData() { DataSet.Tables.Add(CTrainingProfile); - DataSet.Tables.Add(CDirectionOfPreparation); + DataSet.Tables.Add(CDirectionOfPreparation); DataSet.Tables.Add(CAuditor); - DataSet.Tables.Add(СEnclosures); + DataSet.Tables.Add(СEnclosures); DataSet.Tables.Add(CUniversity); DataSet.Tables.Add(CInstitute); DataSet.Tables.Add(CTeacher); DataSet.Tables.Add(CAcademicDegree); DataSet.Tables.Add(CTitle); DataSet.Tables.Add(CGroup); - + DataSet.Relations.Add("Direction_TrainingProfile", CDirectionOfPreparation.Columns["CodeOfDP"], CTrainingProfile.Columns["Shiphr"]); DataSet.Relations.Add("Enclosures-Auditor", СEnclosures.Columns["Name"], CAuditor.Columns["Building"]); DataSet.Relations.Add("AcademicDegree-Teacher", CAcademicDegree.Columns["Reduction"], CTeacher.Columns["academicDegree"]); diff --git a/TimetableOfClasses/AddDiscipline.cs b/TimetableOfClasses/AddDiscipline.cs index 30ec493c0..bfc9ccf57 100644 --- a/TimetableOfClasses/AddDiscipline.cs +++ b/TimetableOfClasses/AddDiscipline.cs @@ -19,7 +19,6 @@ public partial class AddDiscipline : Form public AddDiscipline() { InitializeComponent(); - bool itsupdate = false; } public AddDiscipline(MDiscipline mDiscipline) diff --git a/TimetableOfClasses/Program.cs b/TimetableOfClasses/Program.cs index 1e5875a80..064540be5 100644 --- a/TimetableOfClasses/Program.cs +++ b/TimetableOfClasses/Program.cs @@ -1,6 +1,6 @@ -using System; +using LibOfTimetableOfClasses; +using System; using System.Windows.Forms; -using LibOfTimetableOfClasses; namespace TimetableOfClasses {