Free cookie consent management tool by TermsFeed Policy Generator

source: branches/CEDMA-Exporter-715/sources/HeuristicLab.Logging/3.3/Logger.cs @ 2716

Last change on this file since 2716 was 1530, checked in by gkronber, 16 years ago

Moved source files of plugins Hive ... Visualization.Test into version-specific sub-folders. #576

File size: 2.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;
27using HeuristicLab.Operators;
28
29namespace HeuristicLab.Logging {
30  /// <summary>
31  /// Logs a specified value into a specified log object.
32  /// </summary>
33  public class Logger : OperatorBase {
34    /// <inheritdoc select="summary"/>
35    public override string Description {
36      get { return @"TODO\r\nOperator description still missing ..."; }
37    }
38
39    /// <summary>
40    /// Initializes a new instance of <see cref="Logger"/> with two variable infos
41    /// (<c>Value</c> and <c>Log</c>).
42    /// </summary>
43    public Logger()
44      : base() {
45      AddVariableInfo(new VariableInfo("Value", "The value that should be logged", typeof(ObjectData), VariableKind.In));
46      AddVariableInfo(new VariableInfo("Log", "Log into which the values are written", typeof(Log), VariableKind.In | VariableKind.Out | VariableKind.New));
47    }
48
49    /// <summary>
50    /// Logs a specified value into a specified log object.
51    /// </summary>
52    /// <param name="scope">The current scope.</param>
53    /// <returns><c>null</c>.</returns>
54    public override IOperation Apply(IScope scope) {
55      ObjectData[] values = new ObjectData[scope.SubScopes.Count];
56
57      for (int i = 0; i < scope.SubScopes.Count; i++)
58        values[i] = (ObjectData)scope.SubScopes[i].GetVariableValue<ObjectData>("Value", false).Clone();
59
60      Log log = GetVariableValue<Log>("Log", scope, false, false);
61      if (log == null) {
62        log = new Log(new ItemList());
63        IVariableInfo info = GetVariableInfo("Log");
64        if (info.Local)
65          AddVariable(new Variable(info.ActualName, log));
66        else
67          scope.AddVariable(new Variable(scope.TranslateName(info.FormalName), log));
68      }
69      ItemList row = new ItemList();
70      row.AddRange(values);
71      log.Items.Add(row);
72
73      return null;
74    }
75  }
76}
Note: See TracBrowser for help on using the repository browser.