Free cookie consent management tool by TermsFeed Policy Generator

source: stable/HeuristicLab.Core/3.3/Engine.cs @ 15370

Last change on this file since 15370 was 15292, checked in by jkarder, 7 years ago

#2258: merged r15287 into stable

File size: 5.3 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2016 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
4 *
5 * This file is part of HeuristicLab.
6 *
7 * HeuristicLab is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * HeuristicLab is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
19 */
20#endregion
21
22using System;
23using System.Collections.Generic;
24using System.Linq;
25using System.Threading;
26using HeuristicLab.Common;
27using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
28
29namespace HeuristicLab.Core {
30  [Item("Engine", "A base class for engines.")]
31  [StorableClass]
32  public abstract class Engine : Executable, IEngine {
33    [Storable]
34    protected ILog log;
35    public ILog Log {
36      get { return log; }
37    }
38
39    [Storable]
40    private Stack<IOperation> executionStack;
41    protected Stack<IOperation> ExecutionStack {
42      get { return executionStack; }
43    }
44
45    #region Variables for communication between threads
46    private CancellationTokenSource cancellationTokenSource;
47    private bool stopPending;
48    private DateTime lastUpdateTime;
49    #endregion
50
51    [StorableConstructor]
52    protected Engine(bool deserializing) : base(deserializing) { }
53    protected Engine(Engine original, Cloner cloner)
54      : base(original, cloner) {
55      log = cloner.Clone(original.log);
56      executionStack = new Stack<IOperation>();
57      IOperation[] contexts = original.executionStack.ToArray();
58      for (int i = contexts.Length - 1; i >= 0; i--)
59        executionStack.Push(cloner.Clone(contexts[i]));
60    }
61    protected Engine()
62      : base() {
63      log = new Log();
64      executionStack = new Stack<IOperation>();
65    }
66
67    public sealed override void Prepare() {
68      base.Prepare();
69      executionStack.Clear();
70      OnPrepared();
71    }
72    public void Prepare(IOperation initialOperation) {
73      base.Prepare();
74      executionStack.Clear();
75      if (initialOperation != null)
76        executionStack.Push(initialOperation);
77      OnPrepared();
78    }
79    protected override void OnPrepared() {
80      Log.LogMessage("Engine prepared");
81      base.OnPrepared();
82    }
83
84    public override void Start(CancellationToken cancellationToken) {
85      base.Start(cancellationToken);
86      cancellationTokenSource = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken);
87      stopPending = false;
88
89      try {
90        Run((object)cancellationTokenSource.Token);
91      } catch (OperationCanceledException) {
92      } catch (AggregateException ae) {
93        OnExceptionOccurred(ae.InnerExceptions.SingleOrDefault() ?? ae);
94      } catch (Exception e) {
95        OnExceptionOccurred(e);
96      }
97
98      cancellationTokenSource.Dispose();
99      cancellationTokenSource = null;
100      if (stopPending) executionStack.Clear();
101      if (executionStack.Count == 0) OnStopped();
102      else OnPaused();
103    }
104    protected override void OnStarted() {
105      Log.LogMessage("Engine started");
106      base.OnStarted();
107    }
108
109    public override void Pause() {
110      base.Pause();
111      cancellationTokenSource.Cancel();
112    }
113    protected override void OnPaused() {
114      Log.LogMessage("Engine paused");
115      base.OnPaused();
116    }
117
118    public override void Stop() {
119      base.Stop();
120      if (ExecutionState == ExecutionState.Paused) {
121        executionStack.Clear();
122        OnStopped();
123      } else {
124        stopPending = true;
125        cancellationTokenSource.Cancel();
126      }
127    }
128    protected override void OnStopped() {
129      Log.LogMessage("Engine stopped");
130      base.OnStopped();
131    }
132
133    protected override void OnExceptionOccurred(Exception exception) {
134      Log.LogException(exception);
135      base.OnExceptionOccurred(exception);
136    }
137
138    private void Run(object state) {
139      CancellationToken cancellationToken = (CancellationToken)state;
140
141      OnStarted();
142      lastUpdateTime = DateTime.UtcNow;
143      System.Timers.Timer timer = new System.Timers.Timer(250);
144      timer.AutoReset = true;
145      timer.Elapsed += new System.Timers.ElapsedEventHandler(timer_Elapsed);
146      timer.Start();
147      try {
148        Run(cancellationToken);
149      } finally {
150        timer.Elapsed -= new System.Timers.ElapsedEventHandler(timer_Elapsed);
151        timer.Stop();
152        ExecutionTime += DateTime.UtcNow - lastUpdateTime;
153      }
154
155      cancellationToken.ThrowIfCancellationRequested();
156    }
157    protected abstract void Run(CancellationToken cancellationToken);
158
159    private void timer_Elapsed(object sender, System.Timers.ElapsedEventArgs e) {
160      System.Timers.Timer timer = (System.Timers.Timer)sender;
161      timer.Enabled = false;
162      DateTime now = DateTime.UtcNow;
163      ExecutionTime += now - lastUpdateTime;
164      lastUpdateTime = now;
165      timer.Enabled = true;
166    }
167  }
168}
Note: See TracBrowser for help on using the repository browser.