Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Core/ItemBase.cs @ 1325

Last change on this file since 1325 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  /// Represents the base class for all basic item types.
30  /// </summary>
31  public abstract class ItemBase : StorableBase, IItem {
32    /// <summary>
33    /// Creates a new instance of <see cref="ItemBaseView"/> for
34    /// visual representation of the current instance.
35    /// </summary>
36    /// <returns>The created instance as <see cref="ItemBaseView"/>.</returns>
37    public virtual IView CreateView() {
38      return new ItemBaseView(this);
39    }
40
41    /// <summary>
42    /// Gets the string representation of the current instance.
43    /// </summary>
44    /// <returns>The type name of the current instance.</returns>
45    public override string ToString() {
46      return GetType().Name;
47    }
48
49    /// <summary>
50    /// Fires a new <c>Changed</c> event.
51    /// </summary>
52    /// <remarks>Calls <see cref="OnChanged"/>.</remarks>
53    public void FireChanged() {
54      OnChanged();
55    }
56
57    /// <summary>
58    /// Occurs when the current item was changed.
59    /// </summary>
60    public event EventHandler Changed;
61    /// <summary>
62    /// Fires a new <c>Changed</c> event.
63    /// </summary>
64    protected virtual void OnChanged() {
65      if (Changed != null)
66        Changed(this, new EventArgs());
67    }
68  }
69}
Note: See TracBrowser for help on using the repository browser.