Changeset 16651 for trunk/HeuristicLab.Optimization/3.3/MetaOptimizers

Timestamp:

03/06/19 10:54:20 (6 years ago)

Author:

abeham

Message:

#2561: Decoupled execution state of timelimitrun and its embedded algorithm

File:

• trunk/HeuristicLab.Optimization/3.3/MetaOptimizers/TimeLimitRun.cs (modified) (24 diffs)

trunk/HeuristicLab.Optimization/3.3/MetaOptimizers/TimeLimitRun.cs

@@ -27 +27 @@
 using System.Threading;
 using System.Threading.Tasks;
+using HEAL.Attic;
 using HeuristicLab.Collections;
 using HeuristicLab.Common;
 using HeuristicLab.Common.Resources;
 using HeuristicLab.Core;
-using HEAL.Attic;
 
 namespace HeuristicLab.Optimization {
@@ -62 +62 @@
         if (maximumExecutionTime == value) return;
         maximumExecutionTime = value;
-        OnPropertyChanged("MaximumExecutionTime");
+        OnPropertyChanged(nameof(MaximumExecutionTime));
       }
     }
@@ -77 +77 @@
         snapshotTimes.Sort();
         FindNextSnapshotTimeIndex(ExecutionTime);
-        OnPropertyChanged("SnapshotTimes");
+        OnPropertyChanged(nameof(SnapshotTimes));
       }
     }
@@ -89 +89 @@
         if (storeAlgorithmInEachSnapshot == value) return;
         storeAlgorithmInEachSnapshot = value;
-        OnPropertyChanged("StoreAlgorithmInEachSnapshot");
+        OnPropertyChanged(nameof(StoreAlgorithmInEachSnapshot));
       }
     }
@@ -100 +100 @@
         if (snapshots == value) return;
         snapshots = value;
-        OnPropertyChanged("Snapshots");
+        OnPropertyChanged(nameof(Snapshots));
       }
     }
 
     #region Inherited Properties
+    [Storable]
+    private ExecutionState executionState;
     public ExecutionState ExecutionState {
-      get { return (Algorithm != null) ? Algorithm.ExecutionState : ExecutionState.Stopped; }
+      get { return executionState; }
+      private set {
+        if (executionState == value) return;
+        executionState = value;
+        OnExecutionStateChanged();
+        OnPropertyChanged(nameof(ExecutionState));
+      }
     }
 
@@ -119 +127 @@
       set {
         if (algorithm == value) return;
+        if (ExecutionState == ExecutionState.Started || ExecutionState == ExecutionState.Paused)
+          throw new InvalidOperationException("Cannot change algorithm while the TimeLimitRun is running or paused.");
         if (algorithm != null) DeregisterAlgorithmEvents();
         algorithm = value;
+        if (algorithm != null) RegisterAlgorithmEvents();
+        OnPropertyChanged(nameof(Algorithm));
+        OnPropertyChanged(nameof(NestedOptimizers));
         if (algorithm != null) {
-          RegisterAlgorithmEvents();
-        }
-        OnPropertyChanged("Algorithm");
-        Prepare();
+          if (algorithm.ExecutionState == ExecutionState.Started || algorithm.ExecutionState == ExecutionState.Paused)
+            throw new InvalidOperationException("Cannot assign a running or paused algorithm to a TimeLimitRun.");
+          Prepare();
+          if (algorithm.ExecutionState == ExecutionState.Stopped) OnStopped();
+        } else OnStopped();
       }
     }
@@ -137 +151 @@
         if (runs == value) return;
         runs = value;
-        OnPropertyChanged("Runs");
+        OnPropertyChanged(nameof(Runs));
       }
     }
@@ -160 +174 @@
       snapshots = cloner.Clone(original.snapshots);
       storeAlgorithmInEachSnapshot = original.storeAlgorithmInEachSnapshot;
+      executionState = original.executionState;
       algorithm = cloner.Clone(original.algorithm);
       runs = cloner.Clone(original.runs);
@@ -169 +184 @@
       name = ItemName;
       description = ItemDescription;
+      executionState = ExecutionState.Stopped;
       maximumExecutionTime = TimeSpan.FromMinutes(.5);
       snapshotTimes = new ObservableList<TimeSpan>(new[] {
@@ -182 +198 @@
       : base(name) {
       description = ItemDescription;
+      executionState = ExecutionState.Stopped;
       maximumExecutionTime = TimeSpan.FromMinutes(.5);
       snapshotTimes = new ObservableList<TimeSpan>(new[] {
@@ -194 +211 @@
     public TimeLimitRun(string name, string description)
       : base(name, description) {
+      executionState = ExecutionState.Stopped;
       maximumExecutionTime = TimeSpan.FromMinutes(.5);
       snapshotTimes = new ObservableList<TimeSpan>(new[] {
@@ -213 +231 @@
     private void AfterDeserialization() {
       Initialize();
+      // BackwardsCompatibility3.3
+      #region Backwards compatible code, remove with 3.4
+      if (Algorithm != null && executionState != Algorithm.ExecutionState) {
+        executionState = Algorithm.ExecutionState;
+      } else if (Algorithm == null) executionState = ExecutionState.Stopped;
+      #endregion
     }
 
@@ -238 +262 @@
     }
     public void Prepare(bool clearRuns) {
+      if (Algorithm == null) return;
       Algorithm.Prepare(clearRuns);
     }
@@ -282 +307 @@
     public event EventHandler Prepared;
     private void OnPrepared() {
+      ExecutionState = ExecutionState.Prepared;
       var handler = Prepared;
       if (handler != null) handler(this, EventArgs.Empty);
@@ -287 +313 @@
     public event EventHandler Started;
     private void OnStarted() {
+      ExecutionState = ExecutionState.Started;
       var handler = Started;
       if (handler != null) handler(this, EventArgs.Empty);
@@ -292 +319 @@
     public event EventHandler Paused;
     private void OnPaused() {
+      ExecutionState = ExecutionState.Paused;
       var handler = Paused;
       if (handler != null) handler(this, EventArgs.Empty);
@@ -297 +325 @@
     public event EventHandler Stopped;
     private void OnStopped() {
+      ExecutionState = ExecutionState.Stopped;
       var handler = Stopped;
       if (handler != null) handler(this, EventArgs.Empty);
@@ -302 +331 @@
     public event EventHandler<EventArgs<Exception>> ExceptionOccurred;
     private void OnExceptionOccurred(Exception exception) {
+      ExecutionState = ExecutionState.Paused;
       var handler = ExceptionOccurred;
       if (handler != null) handler(this, new EventArgs<Exception>(exception));
@@ -311 +341 @@
       algorithm.ExceptionOccurred += Algorithm_ExceptionOccurred;
       algorithm.ExecutionTimeChanged += Algorithm_ExecutionTimeChanged;
-      algorithm.ExecutionStateChanged += Algorithm_ExecutionStateChanged;
       algorithm.Paused += Algorithm_Paused;
       algorithm.Prepared += Algorithm_Prepared;
@@ -320 +349 @@
       algorithm.ExceptionOccurred -= Algorithm_ExceptionOccurred;
       algorithm.ExecutionTimeChanged -= Algorithm_ExecutionTimeChanged;
-      algorithm.ExecutionStateChanged -= Algorithm_ExecutionStateChanged;
       algorithm.Paused -= Algorithm_Paused;
       algorithm.Prepared -= Algorithm_Prepared;
@@ -340 +368 @@
       }
       OnExecutionTimeChanged();
-    }
-    private void Algorithm_ExecutionStateChanged(object sender, EventArgs e) {
-      OnExecutionStateChanged();
     }
     private void Algorithm_Paused(object sender, EventArgs e) {
@@ -350 +375 @@
         MakeSnapshot();
         FindNextSnapshotTimeIndex(ExecutionTime);
-      }
-      OnPaused();
+      } else OnPaused();
       if (action == ExecutionState.Started) Algorithm.Start();
       else if (action == ExecutionState.Stopped) Algorithm.Stop();
@@ -361 +385 @@
     }
     private void Algorithm_Started(object sender, EventArgs e) {
-      OnStarted();
+      if (ExecutionState == ExecutionState.Prepared || ExecutionState == ExecutionState.Paused)
+        OnStarted();
+      if (ExecutionState == ExecutionState.Stopped)
+        throw new InvalidOperationException("Algorithm was started although TimeLimitRun was in state Stopped.");
+      // otherwise the algorithm was just started after being snapshotted
     }
     private void Algorithm_Stopped(object sender, EventArgs e) {
-      var cloner = new Cloner();
-      var algRun = cloner.Clone(Algorithm.Runs.Last());
-      var clonedSnapshots = cloner.Clone(snapshots);
-      algRun.Results.Add("TimeLimitRunSnapshots", clonedSnapshots);
-      Runs.Add(algRun);
-      Algorithm.Runs.Clear();
-      OnStopped();
+      try {
+        var cloner = new Cloner();
+        var algRun = cloner.Clone(Algorithm.Runs.Last());
+        var clonedSnapshots = cloner.Clone(snapshots);
+        algRun.Results.Add("TimeLimitRunSnapshots", clonedSnapshots);
+        Runs.Add(algRun);
+        Algorithm.Runs.Clear();
+      } finally { OnStopped(); }
     }
     #endregion
@@ -379 +408 @@
       while (index < snapshotTimes.Count && snapshotTimes[index] <= reference) {
         index++;
-      };
+      }
       snapshotTimesIndex = index;
     }