source: branches/2520_PersistenceReintegration/HeuristicLab.Operators/3.3/SubScopesRemover.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  /// <summary>
30  /// An operator which removes all sub-scopes or one specified sub-scope from the current scope.
31  /// </summary>
32  [Item("SubScopesRemover", "An operator which removes all sub-scopes or one specified sub-scope from the current scope.")]
33  [StorableClass]
34  public sealed class SubScopesRemover : SingleSuccessorOperator {
35    private ValueParameter<BoolValue> RemoveAllSubScopesParameter {
36      get { return (ValueParameter<BoolValue>)Parameters["RemoveAllSubScopes"]; }
37    }
38    public ValueLookupParameter<IntValue> SubScopeIndexParameter {
39      get { return (ValueLookupParameter<IntValue>)Parameters["SubScopeIndex"]; }
40    }
41    private ScopeParameter CurrentScopeParameter {
42      get { return (ScopeParameter)Parameters["CurrentScope"]; }
43    }
44
45    public bool RemoveAllSubScopes {
46      get { return RemoveAllSubScopesParameter.Value.Value; }
47      set { RemoveAllSubScopesParameter.Value.Value = value; }
48    }
49    public IScope CurrentScope {
50      get { return CurrentScopeParameter.ActualValue; }
51    }
52
53    [StorableConstructor]
54    private SubScopesRemover(bool deserializing) : base(deserializing) { }
55    private SubScopesRemover(SubScopesRemover original, Cloner cloner)
56      : base(original, cloner) {
57    }
58    public SubScopesRemover()
59      : base() {
60      Parameters.Add(new ValueParameter<BoolValue>("RemoveAllSubScopes", "True if all sub-scopes of the current scope should be removed, otherwise false.", new BoolValue(true)));
61      Parameters.Add(new ValueLookupParameter<IntValue>("SubScopeIndex", "The index of the sub-scope which should be removed. This parameter is ignored, if RemoveAllSubScopes is true."));
62      Parameters.Add(new ScopeParameter("CurrentScope", "The current scope from which one or all sub-scopes should be removed."));
63    }
64
65    public override IDeepCloneable Clone(Cloner cloner) {
66      return new SubScopesRemover(this, cloner);
67    }
68
69    public override IOperation Apply() {
70      if (RemoveAllSubScopes)
71        CurrentScope.SubScopes.Clear();
72      else {
73        CurrentScope.SubScopes.RemoveAt(SubScopeIndexParameter.ActualValue.Value);
74      }
75      return base.Apply();
76    }
77  }
78}
Note: See TracBrowser for help on using the repository browser.