forked from PNNL-Comp-Mass-Spec/MASIC
-
Notifications
You must be signed in to change notification settings - Fork 0
/
clsMasicEventNotifier.cs
203 lines (175 loc) · 7.5 KB
/
clsMasicEventNotifier.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
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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
using System;
using PRISM;
namespace MASIC
{
/// <summary>
/// MASIC event notifier
/// </summary>
public abstract class clsMasicEventNotifier : EventNotifier
{
// Ignore Spelling: uncache
private short mLastPercentComplete;
/// <summary>
/// Provides information on the number of cache and uncache events in spectraCache
/// </summary>
public event UpdateCacheStatsEventEventHandler UpdateCacheStatsEvent;
/// <summary>
/// Delegate for the update cache stats event
/// </summary>
/// <param name="cacheEventCount"></param>
/// <param name="unCacheEventCount"></param>
/// <param name="spectraPoolHitEventCount"></param>
public delegate void UpdateCacheStatsEventEventHandler(int cacheEventCount, int unCacheEventCount, int spectraPoolHitEventCount);
/// <summary>
/// Update the code associated with an error
/// </summary>
public event UpdateBaseClassErrorCodeEventEventHandler UpdateBaseClassErrorCodeEvent;
/// <summary>
/// Delegate for the base class error code event
/// </summary>
/// <param name="newErrorCode"></param>
public delegate void UpdateBaseClassErrorCodeEventEventHandler(PRISM.FileProcessor.ProcessFilesBase.ProcessFilesErrorCodes newErrorCode);
/// <summary>
/// Update the code associated with an error
/// </summary>
public event UpdateErrorCodeEventEventHandler UpdateErrorCodeEvent;
/// <summary>
/// Delete fro the update error code event
/// </summary>
/// <param name="newErrorCode"></param>
/// <param name="leaveExistingErrorCodeUnchanged"></param>
public delegate void UpdateErrorCodeEventEventHandler(clsMASIC.MasicErrorCodes newErrorCode, bool leaveExistingErrorCodeUnchanged);
private void OnUpdateCacheStats(int cacheEventCount, int unCacheEventCount, int spectraPoolHitEventCount)
{
UpdateCacheStatsEvent?.Invoke(cacheEventCount, unCacheEventCount, spectraPoolHitEventCount);
}
private void OnUpdateBaseClassErrorCode(PRISM.FileProcessor.ProcessFilesBase.ProcessFilesErrorCodes newErrorCode)
{
UpdateBaseClassErrorCodeEvent?.Invoke(newErrorCode);
}
private void OnUpdateErrorCode(clsMASIC.MasicErrorCodes newErrorCode, bool leaveExistingErrorCodeUnchanged)
{
UpdateErrorCodeEvent?.Invoke(newErrorCode, leaveExistingErrorCodeUnchanged);
}
/// <summary>
/// Register events
/// </summary>
/// <param name="sourceClass"></param>
protected void RegisterEvents(clsMasicEventNotifier sourceClass)
{
base.RegisterEvents(sourceClass);
sourceClass.UpdateCacheStatsEvent += UpdatedCacheStatsEventHandler;
sourceClass.UpdateBaseClassErrorCodeEvent += UpdateBaseClassErrorCodeEventHandler;
sourceClass.UpdateErrorCodeEvent += UpdateErrorCodeEventHandler;
}
/// <summary>
/// Report a status message
/// </summary>
/// <param name="message"></param>
protected void ReportMessage(string message)
{
OnStatusEvent(message);
}
/// <summary>
/// Report an error message
/// </summary>
/// <param name="message"></param>
/// <param name="newErrorCode"></param>
protected void ReportError(string message,
clsMASIC.MasicErrorCodes newErrorCode = clsMASIC.MasicErrorCodes.NoError)
{
if (newErrorCode != clsMASIC.MasicErrorCodes.NoError)
{
OnUpdateErrorCode(newErrorCode, false);
}
OnErrorEvent(message);
}
/// <summary>
/// Report an error message, including an exception
/// </summary>
/// <param name="message"></param>
/// <param name="ex"></param>
/// <param name="newErrorCode"></param>
protected void ReportError(string message,
Exception ex,
clsMASIC.MasicErrorCodes newErrorCode = clsMASIC.MasicErrorCodes.NoError)
{
if (newErrorCode != clsMASIC.MasicErrorCodes.NoError)
{
OnUpdateErrorCode(newErrorCode, false);
}
OnErrorEvent(message, ex);
}
/// <summary>
/// Report a warning message
/// </summary>
/// <param name="message"></param>
protected void ReportWarning(string message)
{
OnWarningEvent(message);
}
/// <summary>
/// Set the base class error code
/// </summary>
/// <param name="newErrorCode"></param>
protected void SetBaseClassErrorCode(PRISM.FileProcessor.ProcessFilesBase.ProcessFilesErrorCodes newErrorCode)
{
OnUpdateBaseClassErrorCode(newErrorCode);
}
/// <summary>
/// Set a local error code
/// </summary>
/// <param name="newErrorCode"></param>
/// <param name="leaveExistingErrorCodeUnchanged"></param>
protected void SetLocalErrorCode(clsMASIC.MasicErrorCodes newErrorCode, bool leaveExistingErrorCodeUnchanged = false)
{
OnUpdateErrorCode(newErrorCode, leaveExistingErrorCodeUnchanged);
}
/// <summary>
/// Update cache stats
/// </summary>
/// <param name="spectraCache"></param>
protected void UpdateCacheStats(clsSpectraCache spectraCache)
{
OnUpdateCacheStats(spectraCache.CacheEventCount, spectraCache.UnCacheEventCount, spectraCache.SpectraPoolHitEventCount);
}
/// <summary>
/// Update the progress of a given subtask
/// </summary>
/// <param name="percentComplete"></param>
protected void UpdateProgress(short percentComplete)
{
OnProgressUpdate(string.Empty, percentComplete);
}
/// <summary>
/// Update progress
/// </summary>
/// <param name="progressMessage"></param>
protected void UpdateProgress(string progressMessage)
{
OnProgressUpdate(progressMessage, mLastPercentComplete);
}
/// <summary>
/// Update progress
/// </summary>
/// <param name="percentComplete"></param>
/// <param name="progressMessage"></param>
protected void UpdateProgress(short percentComplete, string progressMessage)
{
mLastPercentComplete = percentComplete;
OnProgressUpdate(progressMessage, percentComplete);
}
private void UpdatedCacheStatsEventHandler(int cacheEventCount, int unCacheEventCount, int spectraPoolHitEventCount)
{
OnUpdateCacheStats(cacheEventCount, unCacheEventCount, spectraPoolHitEventCount);
}
private void UpdateBaseClassErrorCodeEventHandler(PRISM.FileProcessor.ProcessFilesBase.ProcessFilesErrorCodes errorCode)
{
SetBaseClassErrorCode(errorCode);
}
private void UpdateErrorCodeEventHandler(clsMASIC.MasicErrorCodes errorCode, bool leaveExistingErrorCodeUnchanged)
{
SetLocalErrorCode(errorCode, leaveExistingErrorCodeUnchanged);
}
}
}