Added code comments for technician module.

1 files changed, 153 insertions, 9 deletions

diff --git a/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Technician/ViewModels/MachineTechViewVM.cs b/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Technician/ViewModels/MachineTechViewVM.cs
index 2a55d12c6..6ccc1caa0 100644
--- a/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Technician/ViewModels/MachineTechViewVM.cs
+++ b/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Technician/ViewModels/MachineTechViewVM.cs
@@ -29,6 +29,11 @@ using Tango.SharedUI;
 
 namespace Tango.MachineStudio.Technician.ViewModels
 {
+    /// <summary>
+    /// Represents the MachineTechView View Model.
+    /// </summary>
+    /// <seealso cref="Tango.SharedUI.ViewModel" />
+    /// <seealso cref="Tango.MachineStudio.Common.StudioApplication.IShutdownListener" />
     public class MachineTechViewVM : ViewModel, IShutdownListener
     {
         private List<PropertyInfo> _diagnoticsDataProperties;
@@ -139,22 +144,42 @@ namespace Tango.MachineStudio.Technician.ViewModels
 
         #region Commands
 
+        /// <summary>
+        /// Gets or sets the save as project command.
+        /// </summary>
         public RelayCommand SaveAsProjectCommand { get; set; }
 
+        /// <summary>
+        /// Gets or sets the save project command.
+        /// </summary>
         public RelayCommand SaveProjectCommand { get; set; }
 
+        /// <summary>
+        /// Gets or sets the open project command.
+        /// </summary>
         public RelayCommand OpenProjectCommand { get; set; }
 
         #endregion
 
         #region Constructors
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="MachineTechViewVM"/> class.
+        /// </summary>
+        /// <param name="applicationManager">The application manager.</param>
+        /// <param name="notificationProvider">The notification provider.</param>
         [PreferredConstructor]
         public MachineTechViewVM(IStudioApplicationManager applicationManager, INotificationProvider notificationProvider) : this(applicationManager, notificationProvider, true)
         {
 
         }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="MachineTechViewVM"/> class.
+        /// </summary>
+        /// <param name="applicationManager">The application manager.</param>
+        /// <param name="notificationProvider">The notification provider.</param>
+        /// <param name="loadLastProject">if set to <c>true</c> [load last project].</param>
         public MachineTechViewVM(IStudioApplicationManager applicationManager, INotificationProvider notificationProvider, bool loadLastProject)
         {
             _notification = notificationProvider;
@@ -215,6 +240,10 @@ namespace Tango.MachineStudio.Technician.ViewModels
 
         #region Populate Diagnostics Data
 
+        /// <summary>
+        /// Populates the diagnostics data to the proper elements.
+        /// </summary>
+        /// <param name="data">The data.</param>
         private void PopulateDiagnosticsData(PushDiagnosticsResponse data)
         {
             if (DateTime.Now > _lastDiagnosticsResponseUpdate.AddMilliseconds(MIN_DIAGNOSTICS_UPDATE_MILI))
@@ -240,7 +269,7 @@ namespace Tango.MachineStudio.Technician.ViewModels
 
                             if (prop != null)
                             {
-                                monitorItem.Value = GetLastMonitorValue(monitorItem.TechMonitor, prop.GetValue(data));
+                                monitorItem.Value = GetDataLastValue(monitorItem.TechMonitor, prop.GetValue(data));
                             }
                         }
                     }
@@ -254,7 +283,7 @@ namespace Tango.MachineStudio.Technician.ViewModels
 
                             if (prop != null)
                             {
-                                meterItem.Value = GetLastMonitorValue(meterItem.TechMonitor, prop.GetValue(data));
+                                meterItem.Value = GetDataLastValue(meterItem.TechMonitor, prop.GetValue(data));
                             }
                         }
                     }
@@ -270,7 +299,7 @@ namespace Tango.MachineStudio.Technician.ViewModels
 
                             if (_singleControllers.TryGetValue(graphItem, out controller))
                             {
-                                controller.PushData(GetSingleGraphValues(graphItem.TechMonitor, prop.GetValue(data)));
+                                controller.PushData(GetDataArray(graphItem.TechMonitor, prop.GetValue(data)));
                             }
                         }
                     }
@@ -286,7 +315,7 @@ namespace Tango.MachineStudio.Technician.ViewModels
 
                             if (_multiControllers.TryGetValue(graphItem, out controller))
                             {
-                                controller.PushData(GetMultiGraphValues(graphItem.TechMonitor, prop.GetValue(data)));
+                                controller.PushData(GetDataMatrix(graphItem.TechMonitor, prop.GetValue(data)));
                             }
                         }
                     }
@@ -320,7 +349,13 @@ namespace Tango.MachineStudio.Technician.ViewModels
 
         #region Private Methods
 
-        private double GetLastMonitorValue(TechMonitor monitor, object value)
+        /// <summary>
+        /// Gets the last data point from a protobuf repeated field.
+        /// </summary>
+        /// <param name="monitor">The monitor.</param>
+        /// <param name="value">The value.</param>
+        /// <returns></returns>
+        private double GetDataLastValue(TechMonitor monitor, object value)
         {
             if (!monitor.MultiChannel)
             {
@@ -334,12 +369,24 @@ namespace Tango.MachineStudio.Technician.ViewModels
             }
         }
 
-        private List<double> GetSingleGraphValues(TechMonitor monitor, object value)
+        /// <summary>
+        /// Gets the data array from a protobuf repeated field.
+        /// </summary>
+        /// <param name="monitor">The monitor.</param>
+        /// <param name="value">The value.</param>
+        /// <returns></returns>
+        private List<double> GetDataArray(TechMonitor monitor, object value)
         {
             return (value as RepeatedField<double>).ToList();
         }
 
-        private List<List<double>> GetMultiGraphValues(TechMonitor monitor, object value)
+        /// <summary>
+        /// Gets the data matrix from a protobuf repeated field of <see cref="DoubleArray"/>.
+        /// </summary>
+        /// <param name="monitor">The monitor.</param>
+        /// <param name="value">The value.</param>
+        /// <returns></returns>
+        private List<List<double>> GetDataMatrix(TechMonitor monitor, object value)
         {
             DoubleArray[] arrayOfDoubles = Enumerable.ToArray(value as IEnumerable<DoubleArray>);
             return arrayOfDoubles.Select(x => x.Data.ToList()).ToList();
@@ -349,6 +396,9 @@ namespace Tango.MachineStudio.Technician.ViewModels
 
         #region Virtual Methods
 
+        /// <summary>
+        /// Called when the disable rendering has been changed
+        /// </summary>
         protected virtual void OnDisableRenderingChanged()
         {
             foreach (var controller in _singleControllers)
@@ -366,11 +416,20 @@ namespace Tango.MachineStudio.Technician.ViewModels
 
         #region Add/Remove Element
 
+        /// <summary>
+        /// Creates a new tech element by the specified bounds and the current selected element.
+        /// </summary>
+        /// <param name="bounds">The bounds.</param>
         public void CreateElement(Rect bounds)
         {
             CreateElement(SelectedTechItem, bounds);
         }
 
+        /// <summary>
+        /// Creates a new tech element by the specified tech item instance and bounds.
+        /// </summary>
+        /// <param name="item">The item.</param>
+        /// <param name="bounds">The bounds.</param>
         private void CreateElement(TechItem item, Rect bounds)
         {
             if (item is MonitorItem)
@@ -422,6 +481,15 @@ namespace Tango.MachineStudio.Technician.ViewModels
             }
         }
 
+        /// <summary>
+        /// Creates a new element by the specified editor type, tech item type, bounds and tech item constructor value.
+        /// </summary>
+        /// <typeparam name="Editor">The type of the editor.</typeparam>
+        /// <typeparam name="Tech">The type of the tech.</typeparam>
+        /// <typeparam name="Value">The type of the value.</typeparam>
+        /// <param name="bounds">The bounds.</param>
+        /// <param name="value">The value.</param>
+        /// <returns></returns>
         private Editor CreateElement<Editor, Tech, Value>(Rect bounds, Value value) where Editor : IElementEditor where Tech : TechItem
         {
             TechItem item = Activator.CreateInstance(typeof(Tech), new object[] { value }) as TechItem;
@@ -430,6 +498,12 @@ namespace Tango.MachineStudio.Technician.ViewModels
             return (Editor)editor;
         }
 
+        /// <summary>
+        /// Creates a new element by the specified editor type and tech item instance.
+        /// </summary>
+        /// <typeparam name="Editor">The type of the editor.</typeparam>
+        /// <param name="item">The item.</param>
+        /// <returns></returns>
         private Editor CreateElement<Editor>(TechItem item) where Editor : IElementEditor
         {
             IElementEditor editor = Activator.CreateInstance(typeof(Editor), new object[] { item, item.GetBounds() }) as IElementEditor;
@@ -437,6 +511,10 @@ namespace Tango.MachineStudio.Technician.ViewModels
             return (Editor)editor;
         }
 
+        /// <summary>
+        /// Adds a new tech item.
+        /// </summary>
+        /// <param name="item">The item.</param>
         private void AddTechItem(TechItem item)
         {
             if (item is MonitorItem)
@@ -496,6 +574,10 @@ namespace Tango.MachineStudio.Technician.ViewModels
             }
         }
 
+        /// <summary>
+        /// Called when elements have been removed
+        /// </summary>
+        /// <param name="elements">The elements.</param>
         public void OnElementsRemoved(List<IElementEditor> elements)
         {
             //foreach (var element in elements)
@@ -513,6 +595,10 @@ namespace Tango.MachineStudio.Technician.ViewModels
             //}
         }
 
+        /// <summary>
+        /// Called when elements have been pasted
+        /// </summary>
+        /// <param name="elements">The elements.</param>
         public void OnElementsPasted(List<IElementEditor> elements)
         {
             foreach (var element in elements)
@@ -585,6 +671,10 @@ namespace Tango.MachineStudio.Technician.ViewModels
 
         #region Init Tech Items
 
+        /// <summary>
+        /// Initializes the motor item.
+        /// </summary>
+        /// <param name="item">The item.</param>
         private void InitMotorItem(MotorItem item)
         {
             item.ActionExecuted += async (x, action) =>
@@ -655,6 +745,10 @@ namespace Tango.MachineStudio.Technician.ViewModels
             };
         }
 
+        /// <summary>
+        /// Initializes the dispenser item.
+        /// </summary>
+        /// <param name="item">The item.</param>
         private void InitDispenserItem(DispenserItem item)
         {
             item.ActionExecuted += async (x, action) =>
@@ -725,6 +819,11 @@ namespace Tango.MachineStudio.Technician.ViewModels
             };
         }
 
+        /// <summary>
+        /// Initializes the single graph item.
+        /// </summary>
+        /// <param name="item">The item.</param>
+        /// <param name="editor">The editor.</param>
         private void InitSingleGraphitem(SingleGraphItem item, SingleGraphElementEditor editor)
         {
             editor.InnerGraph.InnerGraph.MaxPoints = Common.Helpers.GraphsHelper.GetMaxPoints(item.TechMonitor.PointsPerFrame);
@@ -736,6 +835,11 @@ namespace Tango.MachineStudio.Technician.ViewModels
             _singleControllers.Add(item, controller);
         }
 
+        /// <summary>
+        /// Initializes the multi graph item.
+        /// </summary>
+        /// <param name="item">The item.</param>
+        /// <param name="editor">The editor.</param>
         private void InitMultiGraphItem(MultiGraphItem item, MultiGraphElementEditor editor)
         {
             editor.InnerGraph.InnerGraph.MaxPoints = Common.Helpers.GraphsHelper.GetMaxPoints(item.TechMonitor.PointsPerFrame);
@@ -758,6 +862,10 @@ namespace Tango.MachineStudio.Technician.ViewModels
             _multiControllers.Add(item, controller);
         }
 
+        /// <summary>
+        /// Initializes the thread motion item.
+        /// </summary>
+        /// <param name="item">The item.</param>
         private void InitThreadMotionItem(ThreadMotionItem item)
         {
             item.ActionExecuted += async (x, action) =>
@@ -783,6 +891,10 @@ namespace Tango.MachineStudio.Technician.ViewModels
             };
         }
 
+        /// <summary>
+        /// Initializes the motor group item.
+        /// </summary>
+        /// <param name="item">The item.</param>
         private void InitMotorGroupItem(MotorGroupItem item)
         {
             item.ActionExecuted += async (x, action) =>
@@ -853,6 +965,10 @@ namespace Tango.MachineStudio.Technician.ViewModels
             };
         }
 
+        /// <summary>
+        /// Initializes the digital out item.
+        /// </summary>
+        /// <param name="item">The item.</param>
         private void InitDigitalOutItem(DigitalOutItem item)
         {
             item.ValueChanged += async (x, value) =>
@@ -872,6 +988,9 @@ namespace Tango.MachineStudio.Technician.ViewModels
 
         #region Public Methods
 
+        /// <summary>
+        /// Opens a file open dialog to select a project file.
+        /// </summary>
         public void OpenProject()
         {
             OpenFileDialog dlg = new OpenFileDialog();
@@ -884,12 +1003,20 @@ namespace Tango.MachineStudio.Technician.ViewModels
             }
         }
 
+        /// <summary>
+        /// Opens the specified project file path.
+        /// </summary>
+        /// <param name="fileName">File path.</param>
         public void OpenProjectFile(String fileName)
         {
             LoadProject(MachineTechViewProject.Load(fileName));
             _lastTechProjectFile = fileName;
         }
 
+        /// <summary>
+        /// Loads the specified project.
+        /// </summary>
+        /// <param name="project">The project.</param>
         public void LoadProject(MachineTechViewProject project)
         {
             using (_notification.PushTaskItem("Loading technician project file..."))
@@ -910,6 +1037,9 @@ namespace Tango.MachineStudio.Technician.ViewModels
             }
         }
 
+        /// <summary>
+        /// Opens the file save dialog for selecting a project file target.
+        /// </summary>
         private void SaveAsProject()
         {
             SaveFileDialog dlg = new SaveFileDialog();
@@ -922,16 +1052,23 @@ namespace Tango.MachineStudio.Technician.ViewModels
             }
         }
 
+        /// <summary>
+        /// Saves the current project to the specified file path.
+        /// </summary>
+        /// <param name="fileName">Name of the file.</param>
         private void SaveProjectFile(String fileName)
         {
             using (_notification.PushTaskItem("Saving technician project file..."))
             {
-                MachineTechViewProject project = CreateProjectFile();
+                MachineTechViewProject project = GenerateProjectFile();
                 project.Save(fileName);
                 _lastTechProjectFile = fileName;
             }
         }
 
+        /// <summary>
+        /// Saves the current opened project file. If not project file is opened will call <see cref="SaveAsProject"/>.
+        /// </summary>
         private void SaveProject()
         {
             if (File.Exists(_lastTechProjectFile))
@@ -944,7 +1081,11 @@ namespace Tango.MachineStudio.Technician.ViewModels
             }
         }
 
-        private MachineTechViewProject CreateProjectFile()
+        /// <summary>
+        /// Generates a project file from the current element setup.
+        /// </summary>
+        /// <returns></returns>
+        private MachineTechViewProject GenerateProjectFile()
         {
             MachineTechViewProject project = new MachineTechViewProject();
 
@@ -967,6 +1108,9 @@ namespace Tango.MachineStudio.Technician.ViewModels
 
         #region IShutdownListener
 
+        /// <summary>
+        /// Called when the application is about to terminate.
+        /// </summary>
         public void OnShuttingDown()
         {
             InvokeUINow(() =>