Software/Visual_Studio/PPC/Tango.PPC.Common/PPCModuleBase.cs


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
pre { line-height: 125%; }
td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
.highlight .hll { background-color: #ffffcc }
.highlight .c { color: #888888 } /* Comment */
.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
.highlight .k { color: #008800; font-weight: bold } /* Keyword */
.highlight .ch { color: #888888 } /* Comment.Hashbang */
.highlight .cm { color: #888888 } /* Comment.Multiline */
.highlight .cp { color: #cc0000; font-weight: bold } /* Comment.Preproc */
.highlight .cpf { color: #888888 } /* Comment.PreprocFile */
.highlight .c1 { color: #888888 } /* Comment.Single */
.husing 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;
using System.Reflection;

namespace Tango.PPC.Common
{
    /// <summary>
    /// Represents a base class for PPC modules.
    /// </summary>
    /// <seealso cref="Tango.MachineStudio.Common.IStudioModule" />
    public abstract class PPCModuleBase : ExtendedObject, IPPCModule
    {
        private bool _isVisibleInMenu = true;
        /// <summary>
        /// Gets a value indicating whether this module should be displayed in the application menu.
        /// </summary>
        public bool IsVisibleInMenu
        {
            get { return _isVisibleInMenu; }
            protected set { _isVisibleInMenu = value; RaisePropertyChangedAuto(); }
        }

        /// <summary>
        /// Gets a value indicating whether to dock this module menu item to the bottom.
        /// </summary>
        public bool DockToBottom
        {
            get { return this.GetType().GetCustomAttribute<PPCModuleAttribute>().DockToBottom; }
        }

        /// <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>
        /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
        /// </summary>
        public abstract void Dispose();

        /// <summary>
        /// Called when the application has entered the technician mode.
        /// </summary>
        public virtual void OnTechnicianEntered()
        {
            
        }

        /// <summary>
        /// Called when the application has exited the technician mode.
        /// </summary>
        public virtual void OnTechnicianExited()
        {
            
        }
    }
}