source: branches/TerminationCriteria/HeuristicLab.Termination/3.3/Terminator.cs @ 12436

Last change on this file since 12436 was 12436, checked in by mkommend, 5 years ago

#2027: Improved code formatting for terminators.

File size: 2.6 KB
RevLine 
[12303]1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2015 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
[12413]22using System.Collections.Generic;
[12405]23using System.Drawing;
[12303]24using HeuristicLab.Common;
25using HeuristicLab.Core;
26using HeuristicLab.Data;
27using HeuristicLab.Operators;
28using HeuristicLab.Parameters;
29using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
30
31namespace HeuristicLab.Termination {
[12402]32  [Item("Terminator", "A base class for all termination criteria.")]
[12303]33  [StorableClass]
[12414]34  public abstract class Terminator : SingleSuccessorOperator, ITerminator {
[12405]35    public static new Image StaticItemImage {
36      get { return HeuristicLab.Common.Resources.VSImageLibrary.FlagRed; }
37    }
38
[12303]39    public ILookupParameter<BoolValue> TerminateParameter {
40      get { return (ILookupParameter<BoolValue>)Parameters["Terminate"]; }
41    }
42
43    [StorableConstructor]
[12402]44    protected Terminator(bool deserializing) : base(deserializing) { }
45    protected Terminator(Terminator original, Cloner cloner) : base(original, cloner) { }
[12303]46
[12402]47    protected Terminator()
[12303]48      : base() {
49      Parameters.Add(new LookupParameter<BoolValue>("Terminate", "The parameter which will be set to determine if execution should be terminated or should continue."));
50    }
51
[12414]52    public sealed override IOperation Apply() {
[12303]53      if (!TerminateParameter.ActualValue.Value) { // If terminate flag is already set, no need to check further termination criteria.
[12407]54        bool terminate = !CheckContinueCriterion();
[12436]55        TerminateParameter.ActualValue.Value = terminate;
[12303]56      }
[12414]57      return base.Apply();
[12303]58    }
59
[12407]60    protected abstract bool CheckContinueCriterion();
[12413]61
62    public override void CollectParameterValues(IDictionary<string, IItem> values) {
63      base.CollectParameterValues(values);
64      values["Type"] = new StringValue(GetType().GetPrettyName(false));
65    }
[12303]66  }
67}
Note: See TracBrowser for help on using the repository browser.