MERGE

1 files changed, 113 insertions, 0 deletions

diff --git a/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.Common/StudioModuleBase.cs b/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.Common/StudioModuleBase.cs
new file mode 100644
index 000000000..5c594ab70
--- /dev/null
+++ b/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.Common/StudioModuleBase.cs
@@ -0,0 +1,113 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using System.Windows;
+using System.Windows.Media.Imaging;
+using Tango.Integration.Observables;
+
+namespace Tango.MachineStudio.Common
+{
+    /// <summary>
+    /// Represents a base class for studio modules.
+    /// </summary>
+    /// <seealso cref="Tango.MachineStudio.Common.IStudioModule" />
+    public abstract class StudioModuleBase : IStudioModule
+    {
+        private bool _isInitialized;
+        private bool _isLoaded;
+
+        /// <summary>
+        /// Occurs when the user has navigated into or out of this module.
+        /// </summary>
+        public event EventHandler<bool> IsLoadedChanged;
+
+        /// <summary>
+        /// Gets the module name.
+        /// </summary>
+        public abstract string Name { get; }
+
+        /// <summary>
+        /// Gets the module description.
+        /// </summary>
+        public abstract string Description { get; }
+
+        /// <summary>
+        /// Gets the module cover image.
+        /// </summary>
+        public abstract BitmapSource Image { get; }
+
+        /// <summary>
+        /// Gets the module entry point view.
+        /// </summary>
+        public abstract FrameworkElement MainView { get; }
+
+        /// <summary>
+        /// Gets the permission required to see and load this module.
+        /// </summary>
+        public abstract Permissions Permission { get; }
+
+        /// <summary>
+        /// Gets a value indicating whether this module has been initialized.
+        /// </summary>
+        public bool IsInitialized
+        {
+            get
+            {
+                return _isInitialized;
+            }
+            private set
+            {
+                _isInitialized = value;
+            }
+        }
+
+        /// <summary>
+        /// Sets a value indicating whether this module is loaded.
+        /// </summary>
+        public bool IsLoaded
+        {
+            get
+            {
+                return _isLoaded;
+            }
+            set
+            {
+                _isLoaded = value;
+                IsLoadedChanged?.Invoke(this, value);
+            }
+        }
+
+        /// <summary>
+        /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
+        /// </summary>
+        public abstract void Dispose();
+
+        /// <summary>
+        /// Perform any operations required to initialize this module.
+        /// </summary>
+        public void Initialize()
+        {
+            OnInitialized();
+            IsInitialized = true;
+        }
+
+        /// <summary>
+        /// Called when machine studio initializes this module.
+        /// </summary>
+        protected virtual void OnInitialized()
+        {
+
+        }
+
+        /// <summary>
+        /// Raises the <see cref="IsLoadedChanged"/> event.
+        /// </summary>
+        /// <param name="loaded">if set to <c>true</c> the module is loaded.</param>
+        protected virtual void OnLoadedChanged(bool loaded)
+        {
+
+        }
+    }
+}