Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Operators/3.3/SubScopesRemover.cs @ 2834

Last change on this file since 2834 was 2834, checked in by swagner, 14 years ago

Operator architecture refactoring (#95)

  • worked on operators, engines, and optimization
File size: 2.9 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2010 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.Core;
23using HeuristicLab.Data;
24using HeuristicLab.Parameters;
25using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
26
27namespace HeuristicLab.Operators {
28  /// <summary>
29  /// An operator which removes all sub-scopes or one specified sub-scope from the current scope.
30  /// </summary>
31  [Item("SubScopesRemover", "An operator which removes all sub-scopes or one specified sub-scope from the current scope.")]
32  [EmptyStorableClass]
33  [Creatable("Test")]
34  public sealed class SubScopesRemover : SingleSuccessorOperator {
35    private ValueParameter<BoolData> RemoveAllSubScopesParameter {
36      get { return (ValueParameter<BoolData>)Parameters["RemoveAllSubScopes"]; }
37    }
38    public ValueLookupParameter<IntData> SubScopeIndexParameter {
39      get { return (ValueLookupParameter<IntData>)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    public SubScopesRemover()
54      : base() {
55      Parameters.Add(new ValueParameter<BoolData>("RemoveAllSubScopes", "True if all sub-scopes of the current scope should be removed, otherwise false.", new BoolData(true)));
56      Parameters.Add(new ValueLookupParameter<IntData>("SubScopeIndex", "The index of the sub-scope which should be removed. This parameter is ignored, if RemoveAllSubScopes is true."));
57      Parameters.Add(new ScopeParameter("CurrentScope", "The current scope from which one or all sub-scopes should be removed."));
58    }
59
60    public override IOperation Apply() {
61      if (RemoveAllSubScopes)
62        CurrentScope.SubScopes.Clear();
63      else {
64        CurrentScope.SubScopes.RemoveAt(SubScopeIndexParameter.ActualValue.Value);
65      }
66      return base.Apply();
67    }
68  }
69}
Note: See TracBrowser for help on using the repository browser.