blob: 5c594ab708409e5ff3a6629db9332f8dde1041ec (
plain)
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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
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)
{
}
}
}
|
