aboutsummaryrefslogtreecommitdiffstats
path: root/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Synchronization/ViewModels/MainViewVM.cs
diff options
context:
space:
mode:
Diffstat (limited to 'Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Synchronization/ViewModels/MainViewVM.cs')
-rw-r--r--Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Synchronization/ViewModels/MainViewVM.cs33
1 files changed, 33 insertions, 0 deletions
diff --git a/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Synchronization/ViewModels/MainViewVM.cs b/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Synchronization/ViewModels/MainViewVM.cs
index c392aee1a..48a5c64bd 100644
--- a/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Synchronization/ViewModels/MainViewVM.cs
+++ b/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Synchronization/ViewModels/MainViewVM.cs
@@ -8,8 +8,15 @@ using Tango.SharedUI;
namespace Tango.MachineStudio.Synchronization.ViewModels
{
+ /// <summary>
+ /// Represents the synchronization module main view, view model.
+ /// </summary>
+ /// <seealso cref="Tango.SharedUI.ViewModel" />
public class MainViewVM : ViewModel
{
+ /// <summary>
+ /// Initializes a new instance of the <see cref="MainViewVM"/> class.
+ /// </summary>
public MainViewVM()
{
MainViewLogger logger = new MainViewLogger();
@@ -33,23 +40,49 @@ namespace Tango.MachineStudio.Synchronization.ViewModels
#region Custom Logger
+ /// <summary>
+ /// Represents a custom logger.
+ /// </summary>
+ /// <seealso cref="Tango.Logging.ILogger" />
public class MainViewLogger : ILogger
{
+ /// <summary>
+ /// Gets or sets a value indicating whether this <see cref="T:Tango.Logging.ILogger" /> is enabled.
+ /// </summary>
public bool Enabled { get; set; }
+
+ /// <summary>
+ /// Gets or sets a value indicating whether this <see cref="T:Tango.Logging.ILogger" /> will be notified about logs without waiting for the logs queue.
+ /// </summary>
public bool Immediate { get; set; }
+
+ /// <summary>
+ /// Occurs when a new log item is available.
+ /// </summary>
public event Action<String> NewLog;
+ /// <summary>
+ /// Initializes a new instance of the <see cref="MainViewLogger"/> class.
+ /// </summary>
public MainViewLogger()
{
Enabled = true;
Immediate = true;
}
+ /// <summary>
+ /// Called when a new library exception is available.
+ /// </summary>
+ /// <param name="output">The output.</param>
public void OnError(LogItemBase output)
{
NewLog?.Invoke(output.TimeStamp.ToTimeString() + ": " + output.GetMessage());
}
+ /// <summary>
+ /// Called when a new library trace is available.
+ /// </summary>
+ /// <param name="output">The output.</param>
public void OnTrace(LogItemBase output)
{
NewLog?.Invoke(output.TimeStamp.ToTimeString() + ": " + output.GetMessage());