Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Operators/SubScopesCreater.cs @ 828

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

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

File size: 2.1 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 to create sub scopes in a given scope.
31  /// </summary>
32  public class SubScopesCreater : OperatorBase {
33    /// <inheritdoc select="summary"/>
34    public override string Description {
35      get { return @"TODO\r\nOperator description still missing ..."; }
36    }
37
38    /// <summary>
39    /// Initializes a new instance of <see cref="SubScopesCreater"/> with one variable info (<c>SubScopes</c>).
40    /// </summary>
41    public SubScopesCreater()
42      : base() {
43      AddVariableInfo(new VariableInfo("SubScopes", "Number of sub-scopes", typeof(IntData), VariableKind.In));
44    }
45
46    /// <summary>
47    /// Creates a specified number of sub scopes in the given <paramref name="scope"/>.
48    /// </summary>
49    /// <param name="scope">The scope where to create the sub scopes.</param>
50    /// <returns><c>null</c>.</returns>
51    public override IOperation Apply(IScope scope) {
52      IntData count = GetVariableValue<IntData>("SubScopes", scope, true);
53
54      for (int i = 0; i < count.Data; i++)
55        scope.AddSubScope(new Scope(i.ToString()));
56
57      return null;
58    }
59  }
60}
Note: See TracBrowser for help on using the repository browser.