Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Core/Interfaces/IVariable.cs @ 1360

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

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

File size: 2.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 System.Xml;
26
27namespace HeuristicLab.Core {
[776]28  /// <summary>
29  /// Interface to represent a variable (of an operator) having a name and a value.
30  /// </summary>
[2]31  public interface IVariable : IItem {
[776]32    /// <summary>
33    /// Gets or sets the name of the variable.
34    /// </summary>
[2]35    string Name { get; set; }
[776]36    /// <summary>
37    /// Gets or sets the value of the variable.
38    /// </summary>
[2]39    IItem Value { get; set; }
40
[776]41    /// <summary>
42    /// Gets the value of the variable.
43    /// </summary>
44    /// <typeparam name="T">The type of the variable's value.</typeparam>
45    /// <returns>The value of the current instance.</returns>
[2]46    T GetValue<T>() where T : class, IItem;
47
[776]48    /// <summary>
49    /// Occurs when the name of the variable is currently changing.
50    /// </summary>
[2]51    event EventHandler<NameChangingEventArgs> NameChanging;
[776]52    /// <summary>
53    /// Occurs when the name of the current instance has been changed.
54    /// </summary>
[2]55    event EventHandler NameChanged;
[776]56    /// <summary>
57    /// Occurs when the value of the current instance has been changed.
58    /// </summary>
[2]59    event EventHandler ValueChanged;
60  }
61}
Note: See TracBrowser for help on using the repository browser.