Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Operators/3.2/DoubleCounter.cs @ 2420

Last change on this file since 2420 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.3 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  /// Class to add a specified interval to a double value.
31  /// </summary>
32  public class DoubleCounter : OperatorBase {
33    /// <summary>
34    /// Gets the description of the current instance.
35    /// </summary>
36    public override string Description {
37      get { return @"Adds a given interval to a double value"; }
38    }
39
40    /// <summary>
41    /// Initializes a new instance of <see cref="DoubleCounter"/>, including two variable infos
42    /// (<c>Value</c> and <c>Interval</c>).
43    /// </summary>
44    public DoubleCounter()
45      : base() {
46      AddVariableInfo(new VariableInfo("Value", "Counter value", typeof(DoubleData), VariableKind.In | VariableKind.Out));
47      AddVariableInfo(new VariableInfo("Interval", "Interval value", typeof(DoubleData), VariableKind.In));
48    }
49
50    /// <summary>
51    /// Adds to a double value of the given <paramref name="scope"/> a specified interval.
52    /// </summary>
53    /// <param name="scope">The scope whose variable should be incremented.</param>
54    /// <returns><c>null</c>.</returns>
55    public override IOperation Apply(IScope scope) {
56      DoubleData value = GetVariableValue<DoubleData>("Value", scope, true);
57      double interval = GetVariableValue<DoubleData>("Interval", scope, true).Data;
58      value.Data += interval;
59      return null;
60    }
61  }
62}
Note: See TracBrowser for help on using the repository browser.