Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Operators/ScopeCleaner.cs @ 801

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

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

File size: 1.8 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  /// Operator that removes all variables in the given scope and deletes also all subscopes.
31  /// </summary>
32  public class ScopeCleaner : OperatorBase {
33    /// <inheritdoc select="summary"/>
34    public override string Description {
35      get { return @"Removes all variables in the current scope and deletes all subscopes"; }
36    }
37
38    /// <summary>
39    /// Deletes all variable and sub scopes from the given <paramref name="scope"/>.
40    /// </summary>
41    /// <remarks>Calls <see cref="IScope.Clear"/> of interface <see cref="IScope"/>.</remarks>
42    /// <param name="scope">The scope to clear.</param>
43    /// <returns><c>null</c>.</returns>
44    public override IOperation Apply(IScope scope) {
45      scope.Clear();
46      return null;
47    }
48  }
49}
Note: See TracBrowser for help on using the repository browser.