Changeset 14523 for trunk/sources/HeuristicLab.Optimization/3.3/Algorithms

Timestamp:

12/22/16 15:47:00 (8 years ago)

Author:

mkommend

Message:

#2524:

• Renamed pausable to SupportsPause
• Changed SupportsPause field to abstract property that has to be implemented
• Stored initialization flag in BasicAlgorithm
• Changed CancellationToken access to use the according property
• Adapted HillClimber to new pausing mechanism
• Disable pause for PPP, because it does not work correctly
• Derived FixedDataAnalysisAlgorithm from BasicAlgorithm
• Changed base class of all data analysis algorithm from BasicAlgorithm to FixedDataAnalysisAlgorithm

File:

• trunk/sources/HeuristicLab.Optimization/3.3/Algorithms/BasicAlgorithm.cs (modified) (5 diffs)

trunk/sources/HeuristicLab.Optimization/3.3/Algorithms/BasicAlgorithm.cs

@@ -30 +30 @@
   [StorableClass]
   public abstract class BasicAlgorithm : Algorithm, IStorableContent {
-    private bool initialized;
+
     private bool pausePending;
     private DateTime lastUpdateTime;
-    protected bool pausable;
 
     public string Filename { get; set; }
-    public bool Pausable { get { return pausable; } }
+
+    public abstract bool SupportsPause { get; }
 
     [Storable]
-    private ResultCollection results;
+    private bool initialized;
+    [Storable]
+    private readonly ResultCollection results;
     public override ResultCollection Results {
       get { return results; }
@@ -54 +56 @@
     protected BasicAlgorithm(BasicAlgorithm original, Cloner cloner)
       : base(original, cloner) {
-      pausable = original.pausable;
       results = cloner.Clone(original.Results);
     }
@@ -75 +76 @@
       pausePending = false;
       OnStarted();
-      Task task = Task.Factory.StartNew(Run, cancellationTokenSource.Token, cancellationTokenSource.Token);
+
+      Task task = Task.Factory.StartNew(Run, CancellationTokenSource.Token, CancellationTokenSource.Token);
       task.ContinueWith(t => {
         try {
           t.Wait();
-        } catch (AggregateException ex) {
+        }
+        catch (AggregateException ex) {
           try {
             ex.Flatten().Handle(x => x is OperationCanceledException);
-          } catch (AggregateException remaining) {
+          }
+          catch (AggregateException remaining) {
             if (remaining.InnerExceptions.Count == 1) OnExceptionOccurred(remaining.InnerExceptions[0]);
             else OnExceptionOccurred(remaining);
@@ -95 +99 @@
 
     public override void Pause() {
-      if (!Pausable)
+      // CancellationToken.ThrowIfCancellationRequested() must be called from within the Run method, otherwise pause does nothing
+      // alternatively check the IsCancellationRequested property of the cancellation token
+      if (!SupportsPause)
         throw new NotSupportedException("Pause is not supported by this algorithm.");
 
       base.Pause();
       pausePending = true;
-      cancellationTokenSource.Cancel();
+      CancellationTokenSource.Cancel();
     }
 
@@ -123 +129 @@
         initialized = true;
         Run(cancellationToken);
-      } finally {
+      }
+      finally {
         timer.Elapsed -= new System.Timers.ElapsedEventHandler(timer_Elapsed);
         timer.Stop();