Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Operators/DataCollector.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.1 KB
RevLine 
[2]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 {
[801]29  /// <summary>
30  /// Collects values of specific variable names in a given scope.
31  /// </summary>
[2]32  public class DataCollector : OperatorBase {
[801]33    /// <inheritdoc select="summary"/>
[2]34    public override string Description {
35      get { return @"TODO\r\nOperator description still missing ..."; }
36    }
37
[801]38    /// <summary>
39    /// Initializes a new instance of <see cref="DataCollector"/> with two variable infos
40    /// (<c>VariableNames</c> and <c>Values</c>).
41    /// </summary>
[2]42    public DataCollector() {
[40]43      IVariableInfo variableNamesVariableInfo = new VariableInfo("VariableNames", "Names of variables whose values should be collected", typeof(ItemList<StringData>), VariableKind.In);
[2]44      variableNamesVariableInfo.Local = true;
45      AddVariableInfo(variableNamesVariableInfo);
[40]46      ItemList<StringData> variableNames = new ItemList<StringData>();
[2]47      AddVariable(new Variable("VariableNames", variableNames));
48      AddVariableInfo(new VariableInfo("Values", "Collected values", typeof(ItemList), VariableKind.New | VariableKind.In | VariableKind.Out));
49    }
50
[801]51    /// <summary>
52    /// Collects the values of a specified list of variable names in the given <paramref name="scope"/>.
53    /// </summary>
54    /// <param name="scope">The scope where to collect the values from.</param>
55    /// <returns><c>null</c>.</returns>
[2]56    public override IOperation Apply(IScope scope) {
[40]57      ItemList<StringData> names = GetVariableValue<ItemList<StringData>>("VariableNames", scope, false);
[723]58      ItemList values = GetVariableValue<ItemList>("Values", scope, true, false);
[2]59      if (values == null) {
60        values = new ItemList();
61        IVariableInfo info = GetVariableInfo("Values");
62        if (info.Local)
63          AddVariable(new Variable(info.ActualName, values));
64        else
[77]65          scope.AddVariable(new Variable(scope.TranslateName(info.FormalName), values));
[2]66      }
67
68      ItemList currentValues = new ItemList();
69      for (int i = 0; i < names.Count; i++)
[40]70        currentValues.Add((IItem)scope.GetVariableValue(names[i].Data, true).Clone());
[2]71      values.Add(currentValues);
72      return null;
73    }
74  }
75}
Note: See TracBrowser for help on using the repository browser.