Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Operators/DelegatingOperator.cs @ 1172

Last change on this file since 1172 was 801, checked in by vdorfer, 16 years ago

Created API documentation for HeuristicLab.Operators namespace (#331)

File size: 3.0 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2008 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.Text;
25using HeuristicLab.Core;
26using HeuristicLab.Data;
27
28namespace HeuristicLab.Operators {
29  /// <summary>
30  /// Base class for operators that call other operators.
31  /// </summary>
32  public abstract class DelegatingOperator : OperatorBase {
33    /// <summary>
34    /// Executes the specified operator in the given <paramref name="scope"/>.
35    /// </summary>
36    /// <remarks>Calls <see cref="OperatorBase.OnExecuted"/>.<br/>
37    /// Will be executed two times: First to execute the operation where the local variables
38    /// are added to the global scope and a second time to remove the local variables again.</remarks>
39    /// <param name="scope">The scope where to apply the operation.</param>
40    /// <returns><c>null</c>.</returns>
41    public override IOperation Execute(IScope scope) {
42      myCanceled = false;
43
44      if(scope.GetVariable(Guid.ToString()) == null) { // contained operator not yet executed
45        // add marker
46        scope.AddVariable(new Variable(Guid.ToString(), new NullData()));
47
48        // add aliases and local variables
49        foreach (IVariableInfo variableInfo in VariableInfos) {
50          scope.AddAlias(variableInfo.FormalName, variableInfo.ActualName);
51          if (variableInfo.Local)
52            scope.AddVariable(GetVariable(variableInfo.ActualName));
53        }
54
55        CompositeOperation next = new CompositeOperation();
56        next.AddOperation(Apply(scope));
57        // execute combined operator again after contained operators have been executed
58        next.AddOperation(new AtomicOperation(this, scope));
59
60        OnExecuted();
61        return next;
62      } else {  // contained operator already executed
63        // remove marker
64        scope.RemoveVariable(Guid.ToString());
65
66        // remove aliases and local variables
67        foreach (IVariableInfo variableInfo in VariableInfos) {
68          scope.RemoveAlias(variableInfo.FormalName);
69          if (variableInfo.Local)
70            scope.RemoveVariable(variableInfo.ActualName);
71        }
72
73        OnExecuted();
74        return null;
75      }
76    }
77  }
78}
Note: See TracBrowser for help on using the repository browser.