Merge pull request #973 from Students-of-the-city-of-Kostroma/tmp-Tes…

…ting-17-ISbo-2a-7 Relese Sprint 7
Students-of-the-city-of-Kostroma · May 29, 2019 · 009d151 · 009d151
2 parents 81614cd + 80e692a
commit 009d151
Show file tree

Hide file tree

Showing 11 changed files with 180 additions and 40 deletions.
diff --git a/LibOfTimetableOfClasses/CAuditor.cs b/LibOfTimetableOfClasses/CAuditor.cs
@@ -9,11 +9,15 @@
 namespace LibOfTimetableOfClasses
 {
 	/// <summary>
-	/// Контроллер объекта Аудитория.
+	/// Таблица со строками, хранящими данные о разных аудиториях Университета.
 	/// </summary>
 	public class CAuditor : DataTable, IController
 	{
-
+		/// <summary>
+		/// Конструктор таблицы
+		/// Формируются поля таблицы типа DataTable и их свойства.
+		/// Уникальность строки в таблице определяется уникальностью поля NameOfAuditor
+		/// </summary>
 		public CAuditor() : base("Аудитория")
 		{
 			DataColumn[] keys = new DataColumn[2];
@@ -44,7 +48,12 @@ public CAuditor() : base("Аудитория")
 			keys[1] = column;
 			PrimaryKey = keys;
 		}
-
+		/// <summary>
+		/// Метод вставки переданной модели MAuditor в таблицу CAuditor
+		/// в случае уникальности поля NameOfAuditor
+		/// </summary>
+		/// <param name="model">Модель хранящая добавляемую запись таблицы</param>
+		/// <returns>Результат вставки</returns>
 		public bool Insert(Model model)
 		{
 			MAuditor mAuditor = (MAuditor)model;
@@ -67,7 +76,12 @@ public bool Insert(Model model)
 				return false;
 			}
 		}
-
+		/// <summary>
+		/// Обновление свойств строки в таблице CAuditor из переданной модели MAuditor
+		/// Поиск изменяемой строки CAuditor осуществляется по полю "NameOfAuditor"
+		/// </summary>
+		/// <param name="model">Модель хранящая обновляемую запись таблицы</param>
+		/// <returns>Результат обновления</returns>
 		public bool Update(Model model)
 		{
 			MAuditor mAuditor = (MAuditor)model;
@@ -99,7 +113,14 @@ public bool Update(Model model)
 			}
 			return false;
 		}
-
+		/// <summary>
+		/// Метод удаления строки соответствующей переданной модели из таблицы CAuditor.
+		/// В таблице CAuditor ищется строка с полем "NameOfAuditor" соответсвующим этому же полю модели, 
+		/// переданной в качестве параметра.
+		///	В случае успеха поиска удаляется найденная строка.
+		/// </summary>
+		/// <param name="model">Модель, хранящая выбранную строку в таблице</param>
+		/// <returns>Результат удаления переданной строки из CAuditor</returns>
 		public bool Delete(Model model)
 		{
 			MAuditor mAuditor = (MAuditor)model;

diff --git a/LibOfTimetableOfClasses/CDirectionOfPreparation.cs b/LibOfTimetableOfClasses/CDirectionOfPreparation.cs
@@ -8,8 +8,16 @@
 
 namespace LibOfTimetableOfClasses
 {
+	/// <summary>
+	/// Таблица со строками, хранящими данные о разных направлениях подготовки Университета.
+	/// </summary>
 	public class CDirectionOfPreparation : DataTable, IController
 	{
+		/// <summary>
+		/// Конструктор таблицы
+		/// Формируются поля таблицы типа DataTable и их свойства.
+		/// Уникальность строки в таблице определяется уникальностью поля CodeOfDP
+		/// </summary>
 		public CDirectionOfPreparation() : base("Направление подготовки")
 		{
 			DataColumn column = new DataColumn();
@@ -28,6 +36,14 @@ public CDirectionOfPreparation() : base("Направление подготов
 			column.ColumnName = "PeriodOfStudy";
 			Columns.Add(column);
 		}
+		/// <summary>
+		/// Метод удаления строки соответствующей переданной модели из таблицы CDirectionOfPreparation.
+		/// В таблице CDirectionOfPreparation ищется строка с полем "NameOfDP" соответсвующим этому же полю модели, 
+		/// переданной в качестве параметра.
+		///	В случае успеха поиска удаляется найденная строка.
+		/// </summary>
+		/// <param name="model">Модель, хранящая выбранную строку в таблице</param>
+		/// <returns>Результат удаления переданной строки из CDirectionOfPreparation</returns>
 		public bool Delete(Model model)
 		{
 			MDirectionOfPreparation mDirectionOfPreparation = (MDirectionOfPreparation)model;
@@ -44,6 +60,12 @@ public bool Delete(Model model)
 			}
 			return false;
 		}
+		/// <summary>
+		/// Метод вставки переданной модели MDirectionOfPreparation в таблицу CDirectionOfPreparation
+		/// в случае уникальности поля CodeOfDP
+		/// </summary>
+		/// <param name="model">Модель хранящая добавляемую запись таблицы</param>
+		/// <returns>Результат вставки</returns>
 		public bool Insert(Model model)
 		{
 			MDirectionOfPreparation mDirectionOfPreparation = (MDirectionOfPreparation)model;
@@ -66,7 +88,12 @@ public bool Insert(Model model)
 				return false;
 			}
 		}
-
+		/// <summary>
+		/// Обновление свойств строки в таблице CDirectionOfPreparation из переданной модели MDirectionOfPreparation
+		/// Поиск изменяемой строки CAuditor CDirectionOfPreparation по полю "NameOfDP"
+		/// </summary>
+		/// <param name="model">Модель хранящая обновляемую запись таблицы</param>
+		/// <returns>Результат обновления</returns>
 		public bool Update(Model model)
 		{
 			MDirectionOfPreparation mDirectionOfPreparation = (MDirectionOfPreparation)model;
@@ -96,7 +123,9 @@ public bool Update(Model model)
 			}
 			return false;
 		}
-
+		/// <summary>
+		/// Какая-то заглушка
+		/// </summary>
 		public bool Update(DataRow row, Model model)
 		{
 			throw new NotImplementedException();

diff --git a/LibOfTimetableOfClasses/CDiscipline.cs b/LibOfTimetableOfClasses/CDiscipline.cs
@@ -8,12 +8,17 @@
 
 namespace LibOfTimetableOfClasses
 {
-    /// <summary>
-    /// Контроллер для объекта Дисциплина
-    /// </summary>
-    public class CDiscipline : DataTable,IController
+	/// <summary>
+	/// Таблица со строками, хранящими данные о разных дисциплинах Университета.
+	/// </summary>
+	public class CDiscipline : DataTable,IController
     {
-        public CDiscipline() : base("Дисциплина")
+		/// <summary>
+		/// Конструктор таблицы
+		/// Формируются поля таблицы типа DataTable и их свойства.
+		/// Уникальность строки в таблице определяется уникальностью поля Fullname
+		/// </summary>
+		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)
+		/// <summary>
+		/// Метод удаления строки соответствующей переданной модели из таблицы CDiscipline.
+		/// В таблице CDiscipline ищется строка с полем "Fullname" соответсвующим этому же полю модели, 
+		/// переданной в качестве параметра.
+		///	В случае успеха поиска удаляется найденная строка.
+		/// </summary>
+		/// <param name="model">Модель, хранящая выбранную строку в таблице</param>
+		/// <returns>Результат удаления переданной строки из CDiscipline</returns>
+		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)
+		/// <summary>
+		/// Метод вставки переданной модели MDiscipline в таблицу CDiscipline
+		/// в случае уникальности поля Fullname
+		/// </summary>
+		/// <param name="model">Модель хранящая добавляемую запись таблицы</param>
+		/// <returns>Результат вставки</returns>
+		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)
+		/// <summary>
+		/// Обновление свойств строки в таблице CDiscipline из переданной модели MDiscipline
+		/// Поиск изменяемой строки CAuditor осуществляется по полю "Fullname"
+		/// </summary>
+		/// <param name="model">Модель хранящая обновляемую запись таблицы</param>
+		/// <returns>Результат обновления</returns>
+		public bool Update(Model model)
         {
             MDiscipline mDiscipline = (MDiscipline)model;
 
@@ -109,7 +131,9 @@ public bool Update(Model model)
             }
             return false;
         }
-
+		/// <summary>
+		/// Какая-то заглушка
+		/// </summary>
 		public bool Update(DataRow row, Model model)
 		{
 			throw new NotImplementedException();

diff --git a/LibOfTimetableOfClasses/CTrainingProfiles.cs b/LibOfTimetableOfClasses/CTrainingProfiles.cs
@@ -9,10 +9,15 @@
 namespace LibOfTimetableOfClasses
 {
 	/// <summary>
-	/// Контроллер класса объекта Профили подготовки
+	/// Таблица со строками, хранящими данные о разных профилях подготовки Университета.
 	/// </summary>
 	public class CTrainingProfile : DataTable, IController
 	{
+		/// <summary>
+		/// Конструктор таблицы
+		/// Формируются поля таблицы типа DataTable и их свойства.
+		/// Уникальность строки в таблице определяется уникальностью полей Fullname и Shortname
+		/// </summary>
 		public CTrainingProfile() : base("Профиль подготовки")
         {
 			DataColumn column = new DataColumn();
@@ -32,7 +37,14 @@ public CTrainingProfile() : base("Профиль подготовки")
 			//column.Unique = true;
 			Columns.Add(column);
 		}
-
+		/// <summary>
+		/// Метод удаления строки соответствующей переданной модели из таблицы CTrainingProfile.
+		/// В таблице CTrainingProfile ищется строка с полем "Fullname" соответсвующим этому же полю модели, 
+		/// переданной в качестве параметра.
+		///	В случае успеха поиска удаляется найденная строка.
+		/// </summary>
+		/// <param name="model">Модель, хранящая выбранную строку в таблице</param>
+		/// <returns>Результат удаления переданной строки из CTrainingProfile</returns>
 		public bool Delete(Model model)
 		{
 			MTrainingProfile mTrainingProfile = (MTrainingProfile)model;
@@ -51,6 +63,12 @@ public bool Delete(Model model)
 			}
 			return false;
 		}
+		/// <summary>
+		/// Метод вставки переданной модели MTrainingProfile в таблицу CTrainingProfile
+		/// в случае уникальности поля Fullname
+		/// </summary>
+		/// <param name="model">Модель хранящая добавляемую запись таблицы</param>
+		/// <returns>Результат вставки</returns>
 		public bool Insert(Model model)
 		{
 			MTrainingProfile mTrainingProfile = (MTrainingProfile)model;
@@ -72,6 +90,12 @@ public bool Insert(Model model)
 				return false;
 			}
 		}
+		/// <summary>
+		/// Обновление свойств строки в таблице CTrainingProfile из переданной модели MTrainingProfile
+		/// Поиск изменяемой строки CTrainingProfile осуществляется по полю "FullName"
+		/// </summary>
+		/// <param name="model">Модель хранящая обновляемую запись таблицы</param>
+		/// <returns>Результат обновления</returns>
 		public bool Update(Model model)
 		{
 			MTrainingProfile mTrainingProfile = (MTrainingProfile)model;

diff --git a/LibOfTimetableOfClasses/MAuditor.cs b/LibOfTimetableOfClasses/MAuditor.cs
@@ -29,7 +29,13 @@ public class MAuditor : Model
 		/// </summary>                 
 		string building;
 
-
+		/// <summary>
+		/// Создает экземпляр Аудитории
+		/// </summary>
+		/// <param name="nameOfAuditor">Название аудитории</param>
+		/// <param name="cafedra">Кафедра</param>
+		/// <param name="spacious">Вместительность</param>
+		/// <param name="building">Корпус</param>
 		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
 		}
 
 		/// <summary>
-		/// Возвращает или задает nameofaud - название аудитории
+		/// nameofaud - название аудитории
 		/// </summary>
 		public string NameOfAuditor
 		{
@@ -55,7 +61,7 @@ public string NameOfAuditor
 		}
 
 		/// <summary>
-		/// Возвращает или задает cafedra - кафедру
+		/// cafedra - кафедру
 		/// </summary>
 		public string Cafedra
 		{
@@ -71,7 +77,7 @@ public string Cafedra
 		}
 
 		/// <summary>
-		/// Возвращает или задает building - корпус
+		/// building - корпус
 		/// </summary>
 		public string Building
 		{
@@ -87,7 +93,7 @@ public string Building
 		}
 
 		/// <summary>
-		/// Возвращает или задает spacious - вместительность
+		/// spacious - вместительность
 		/// </summary>
 		public ushort Spacious
 		{

diff --git a/LibOfTimetableOfClasses/MDirectionOfPreparation.cs b/LibOfTimetableOfClasses/MDirectionOfPreparation.cs
@@ -9,17 +9,33 @@ namespace LibOfTimetableOfClasses
 {
 	public class MDirectionOfPreparation : Model
 	{
+		/// <summary>
+		/// Код направления подготовки
+		/// </summary>
 		protected string codeOfDP;
+		/// <summary>
+		/// Название направления подготовки
+		/// </summary>
 		protected string nameOfDP;
+		/// <summary>
+		/// Период обучения
+		/// </summary>
 		protected ushort periodOfStudy;
-
+		/// <summary>
+		/// Создает экземпляр направления подготовки
+		/// </summary>
+		/// <param name="codeOfDP">Код направления подготовки</param>
+		/// <param name="nameOfDP">Название направления подготовки</param>
+		/// <param name="periodOfStudy">Период обучения</param>
 		public MDirectionOfPreparation(string codeOfDP, string nameOfDP, ushort periodOfStudy) : base()
 		{
 			CodeOfDP = codeOfDP;
 			NameOfDP = nameOfDP;
 			PeriodOfStudy = periodOfStudy;
 		}
-
+		/// <summary>
+		/// codeOfDP - код напраления подготовки
+		/// </summary>
 		public string CodeOfDP
 		{
 			set
@@ -31,11 +47,17 @@ public string CodeOfDP
 
 			get { return codeOfDP; }
 		}
+		/// <summary>
+		/// nameOfDP - название напраления подготовки
+		/// </summary>
 		public string NameOfDP
 		{
 			set { nameOfDP = value; }
 			get { return nameOfDP; }
 		}
+		/// <summary>
+		/// periodOfStudy - период обучения
+		/// </summary>
 		public ushort PeriodOfStudy
 		{
 			set

diff --git a/LibOfTimetableOfClasses/MDiscipline.cs b/LibOfTimetableOfClasses/MDiscipline.cs
@@ -38,16 +38,16 @@ public MDiscipline(string fullName, string shortName, string cycleOfDiscipline)
 		}
 
 		/// <summary>
-		/// Возвращает или задает значение Name - полное название
+		/// fullName - полное название
 		/// </summary>
 		public string Fullname { set { fullName = value; } get { return fullName; } }
 
 		/// <summary>
-		/// Возвращает или задает значение Shortname - краткому названию
+		/// shortName - краткому названию
 		/// </summary>
 		public string Shortname { set { shortName = value; } get { return shortName; } }
 		/// <summary>
-		/// 
+		/// cycleOfDiscipline - цикла дисциплины
 		/// </summary>
 		public string CycleofDiscipline { set { cycleOfDiscipline = value; } get { return cycleOfDiscipline; } }
 	}