aboutsummaryrefslogtreecommitdiffstats
path: root/Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Storage
diff options
context:
space:
mode:
authorShlomo Hecht <shlomo@twine-s.com>2019-10-23 10:14:10 +0300
committerShlomo Hecht <shlomo@twine-s.com>2019-10-23 10:14:10 +0300
commit54506c761a571b7344491e8f12a63e475372f19e (patch)
tree9cb2afa24af730180fb9e87b40bd9cf6cf0d4e9d /Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Storage
parent80070a6ae7db28ab30321922ca354f7c1e087412 (diff)
downloadTango-54506c761a571b7344491e8f12a63e475372f19e.tar.gz
Tango-54506c761a571b7344491e8f12a63e475372f19e.zip
use feeder tension in the RML as an alternative thread-compatible pressure buildup value.
Diffstat (limited to 'Software/Visual_Studio/MachineStudio/Modules/Tango.MachineStudio.Storage')
0 files changed, 0 insertions, 0 deletions
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.Core;
using Tango.BL.Entities;
using Tango.BL.Enumerations;

namespace Tango.MachineStudio.Common
{
    /// <summary>
    /// Represents a base class for studio modules.
    /// </summary>
    /// <seealso cref="Tango.MachineStudio.Common.IStudioModule" />
    public abstract class StudioModuleBase : ExtendedObject, 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 type.
        /// </summary>
        public abstract Type MainViewType { 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);
            }
        }

        private bool _inNewWindow;
        /// <summary>
        /// Gets or sets a value indicating whether this module is shown under a new window.
        /// </summary>
        public bool InNewWindow
        {
            get { return _inNewWindow; }
            set { _inNewWindow = value; RaisePropertyChangedAuto(); }
        }

        /// <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)
        {

        }
    }
}