Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Core/Interfaces/IVariableInfo.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.2 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 System.Xml;
26
27namespace HeuristicLab.Core {
28  /// <summary>
29  /// Interface to store meta-information about variables/parameters of operators.
30  /// </summary>
31  public interface IVariableInfo : IItem {
32    /// <summary>
33    /// Gets or sets the actual name of the variable info.
34    /// </summary>
35    string ActualName { get; set; }
36    /// <summary>
37    /// Gets or sets the formal name of the current instance.
38    /// </summary>
39    string FormalName { get; }
40    /// <summary>
41    /// Gets the description of the current instance.
42    /// </summary>
43    string Description { get; }
44    /// <summary>
45    /// Gets the data type of the current instance.
46    /// </summary>
47    Type DataType { get; }
48    /// <summary>
49    /// Gets the kind of the variable info (in, out, new,...).
50    /// </summary>
51    VariableKind Kind { get; }
52    /// <summary>
53    /// Gets or sets a boolean value whether the current instance is a local variable info.
54    /// </summary>
55    bool Local { get; set; }
56
57    /// <summary>
58    /// Occurs when the actual name of the current instance has been changed.
59    /// </summary>
60    event EventHandler ActualNameChanged;
61    /// <summary>
62    /// Occurs when the local flag has been changed.
63    /// </summary>
64    event EventHandler LocalChanged;
65  }
66}
Note: See TracBrowser for help on using the repository browser.