Free cookie consent management tool by TermsFeed Policy Generator

source: branches/Operator Architecture Refactoring/HeuristicLab.Core/VariableEventArgs.cs @ 1589

Last change on this file since 1589 was 776, checked in by vdorfer, 16 years ago

Created API documentation for HeuristicLab.Core 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;
25
26namespace HeuristicLab.Core {
27  /// <summary>
28  /// Event arguments to be able to specify the affected variable.
29  /// </summary>
30  public class VariableEventArgs : ItemEventArgs {
31    /// <summary>
32    /// Gets the affected variable.
33    /// </summary>
34    /// <remarks>Uses property <see cref="ItemEventArgs.Item"/> of base class <see cref="ItemEventArgs"/>.
35    /// No own data storage present.</remarks>
36    public IVariable Variable {
37      get { return (IVariable)Item; }
38    }
39
40    /// <summary>
41    /// Initializes a new instance of <see cref="VariableEventArgs"/> with the specified
42    /// <paramref name="variable"/>.
43    /// </summary>
44    /// <remarks>Calls constructor of base class <see cref="ItemEventArgs"/>.</remarks>
45    /// <param name="variable">The affected variable.</param>
46    public VariableEventArgs(IVariable variable)
47      : base(variable) {
48    }
49  }
50}
Note: See TracBrowser for help on using the repository browser.