source: branches/2520_PersistenceReintegration/HeuristicLab.Operators/3.3/SubScopesCounter.cs @ 16453

Last change on this file since 16453 was 16453, checked in by jkarder, 2 years ago

#2520: updated year of copyrights

File size: 3.2 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2019 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 HeuristicLab.Common;
23using HeuristicLab.Core;
24using HeuristicLab.Data;
25using HeuristicLab.Parameters;
26using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
27
28namespace HeuristicLab.Operators {
29  [Item("SubScopesCounter", "Counts the number of direct sub-scopes and increments or assigns it to the value given in the parameter.")]
30  [StorableClass]
31  public class SubScopesCounter : SingleSuccessorOperator {
32
33    public ILookupParameter<IntValue> ValueParameter {
34      get { return (ILookupParameter<IntValue>)Parameters["Value"]; }
35    }
36    public IValueParameter<BoolValue> AccumulateParameter {
37      get { return (IValueParameter<BoolValue>)Parameters["Accumulate"]; }
38    }
39
40    [StorableConstructor]
41    protected SubScopesCounter(bool deserializing) : base(deserializing) { }
42    protected SubScopesCounter(SubScopesCounter original, Cloner cloner)
43      : base(original, cloner) {
44    }
45    public SubScopesCounter() {
46      Parameters.Add(new LookupParameter<IntValue>("Value", "The value that should be incremented by the number of direct sub-scopes. It will be created in the current scope if the value is not found. If Accumulate is set to false, the number of direct sub-scopes is assigned and not accumulated."));
47      Parameters.Add(new ValueParameter<BoolValue>("Accumulate", "True if the number of direct sub-scopes should be accumulated, false if the number should be assigned.", new BoolValue(true)));
48    }
49
50    [StorableHook(HookType.AfterDeserialization)]
51    private void AfterDeserialization() {
52      // BackwardsCompatibility3.3
53      #region Backwards compatible code, remove with 3.4
54      if (!Parameters.ContainsKey("Accumulate"))
55        Parameters.Add(new ValueParameter<BoolValue>("Accumulate", "True if the number of direct sub-scopes should be accumulated, false if the number should be assigned.", new BoolValue(true)));
56      #endregion
57    }
58
59    public override IDeepCloneable Clone(Cloner cloner) {
60      return new SubScopesCounter(this, cloner);
61    }
62
63    public override IOperation Apply() {
64      int count = ExecutionContext.Scope.SubScopes.Count;
65      if (ValueParameter.ActualValue == null) ValueParameter.ActualValue = new IntValue();
66      if (AccumulateParameter.Value.Value) ValueParameter.ActualValue.Value += count;
67      else ValueParameter.ActualValue.Value = count;
68      return base.Apply();
69    }
70  }
71}
Note: See TracBrowser for help on using the repository browser.