From 56678ae530fe45b0880053793ab46f47051e4dc6 Mon Sep 17 00:00:00 2001
From: Victoria Plitt <Victoria.Plitt@twine-s.com>
Date: Sun, 15 Mar 2020 16:12:26 +0200
Subject: MS Statistics Job Runs page. Added comments.

---
 .../Models/StatisticsValueCollection.cs            | 49 +++++++++++++++++++---
 1 file changed, 44 insertions(+), 5 deletions(-)

(limited to 'Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Statistics/Models/StatisticsValueCollection.cs')

diff --git a/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Statistics/Models/StatisticsValueCollection.cs b/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Statistics/Models/StatisticsValueCollection.cs
index 2a298777b..2ad165d79 100644
--- a/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Statistics/Models/StatisticsValueCollection.cs
+++ b/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Statistics/Models/StatisticsValueCollection.cs
@@ -35,6 +35,9 @@ namespace Tango.MachineStudio.Statistics.Models
 
         private ObservableCollection<StatisticsValue> _statisticsCollection;
 
+        /// <summary>
+        /// Gets or sets the statistics collection of StatisticsValue object.
+        /// </summary>
         public ObservableCollection<StatisticsValue> StatisticsCollection
         {
             get { return _statisticsCollection; }
@@ -44,16 +47,25 @@ namespace Tango.MachineStudio.Statistics.Models
         }
 
         private List<StatisticsValue> _threadConsumptionPerThread;
-
+        /// <summary>
+        /// Gets or sets the thread consumption per thread list.
+        /// </summary>
         public List<StatisticsValue> ThreadConsumptionPerThread
         {
             get { return _threadConsumptionPerThread; }
             set { _threadConsumptionPerThread = value; RaisePropertyChangedAuto(); }
         }
 
+        /// <summary>
+        /// Gets or sets the thread consumption per thread collection.
+        /// </summary>
         public CompositeCollection ThreadConsumptionPerThreadCollection { get; set; }
 
         private LabeledSeriesCollection _pieJobSource;
+
+        /// <summary>
+        /// Gets or sets the pie job source.
+        /// </summary>
         public LabeledSeriesCollection PieJobSource
         {
             get { return _pieJobSource; }
@@ -61,6 +73,10 @@ namespace Tango.MachineStudio.Statistics.Models
         }
 
         private LabeledSeriesCollection _pieJobRunStatus;
+
+        /// <summary>
+        /// Gets or sets the pie job run status.
+        /// </summary>
         public LabeledSeriesCollection PieJobRunStatus
         {
             get { return _pieJobRunStatus; }
@@ -68,6 +84,10 @@ namespace Tango.MachineStudio.Statistics.Models
         }
 
         private LabeledSeriesCollection _pieGradientSolid;
+
+        /// <summary>
+        /// Gets or sets the pie gradient solid.
+        /// </summary>
         public LabeledSeriesCollection PieGradientSolid
         {
             get { return _pieGradientSolid; }
@@ -75,6 +95,10 @@ namespace Tango.MachineStudio.Statistics.Models
         }
 
         private List<JobRunLiquidQuantity> _liquidQuantities;
+
+        /// <summary>
+        /// Gets or sets the liquid quantities.
+        /// </summary>
         public List<JobRunLiquidQuantity> LiquidQuantities
         {
             get
@@ -91,6 +115,9 @@ namespace Tango.MachineStudio.Statistics.Models
 
         private int _totalLiquidQuantities;
 
+        /// <summary>
+        /// Gets or sets the total liquid quantities.
+        /// </summary>
         public int TotalLiquidQuantities
         {
             get { return _totalLiquidQuantities; }
@@ -128,6 +155,9 @@ namespace Tango.MachineStudio.Statistics.Models
             };
         }
 
+        /// <summary>
+        /// Cleans all values.
+        /// </summary>
         public void Clean()
         {
             StatisticsCollection.Clear();
@@ -138,21 +168,27 @@ namespace Tango.MachineStudio.Statistics.Models
             PieGradientSolid.SeriesCollection.Clear();
         }
 
-        public void AddStatisticsValue( string name, double value, string unit)
+        /// <summary>
+        /// Adds the statistics value.
+        /// </summary>
+        public void AddStatisticsValue(string name, double value, string unit)
         {
-            StatisticsCollection.Add(new StatisticsValue() { Name = name, Value=value, Unit = unit });
+            StatisticsCollection.Add(new StatisticsValue() { Name = name, Value = value, Unit = unit });
             RaisePropertyChanged("StatisticsCollection");
         }
 
+        /// <summary>
+        /// Creates the thread consumption per thread.
+        /// </summary>
         public void CreateThreadConsumptionPerThread(List<StatisticsValue> threads)
         {
             ThreadConsumptionPerThreadCollection.Add(new CollectionContainer() { Collection = threads.Take(threads.Count() > 2 ? 2 : threads.Count()) });
             if (threads.Count() > 2)
             {
-                ThreadConsumptionPerThreadCollection.Add(new CollectionContainer() { Collection = new List<MoreValue>() { new MoreValue(){ Text="More threads ..." } } });
+                ThreadConsumptionPerThreadCollection.Add(new CollectionContainer() { Collection = new List<MoreValue>() { new MoreValue() { Text = "More threads ..." } } });
                 ThreadConsumptionPerThread = threads.Skip(2).ToList();
             }
-                
+
             RaisePropertyChanged("ThreadConsumptionPerThreadCollection");
         }
 
@@ -259,6 +295,9 @@ namespace Tango.MachineStudio.Statistics.Models
         }
         #endregion
 
+        /// <summary>
+        /// Generates the statistics liquid quantity and TotalLiquidQuantities.
+        /// </summary>
         public void GenerateStatisticsLiquidQuantity(List<JobRunLiquidQuantity> liquidQuantities)
         {
             LiquidQuantities = liquidQuantities;
-- 
cgit v1.3.1