Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Core/3.3/Item.cs @ 3376

Last change on this file since 3376 was 3376, checked in by swagner, 12 years ago

Moved interfaces and classes for deep cloning from HeuristicLab.Core to HeuristicLab.Common (#975).

File size: 3.7 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2010 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.Drawing;
24using HeuristicLab.Common;
25using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
26
27namespace HeuristicLab.Core {
28  /// <summary>
29  /// Represents the base class for all basic item types.
30  /// </summary>
31  [StorableClass]
32  [Item("Item", "Base class for all HeuristicLab items.")]
33  public abstract class Item : IDeepCloneable, IItem {
34    public virtual string ItemName {
35      get { return ItemAttribute.GetName(this.GetType()); }
36    }
37    public virtual string ItemDescription {
38      get { return ItemAttribute.GetDescription(this.GetType()); }
39    }
40    public virtual Image ItemImage {
41      get { return HeuristicLab.Common.Resources.VS2008ImageLibrary.Class; }
42    }
43
44    [Storable]
45    private bool readOnlyView;
46    public virtual bool ReadOnlyView {
47      get { return readOnlyView; }
48      set {
49        if (readOnlyView != value) {
50          readOnlyView = value;
51          OnReadOnlyViewChanged();
52        }
53      }
54    }
55
56    protected Item()
57      : base() {
58      readOnlyView = false;
59    }
60    [StorableConstructor]
61    protected Item(bool deserializing) { }
62
63
64    /// <summary>
65    /// Creates a deep clone of this instance.
66    /// </summary>
67    /// <remarks>
68    /// This method is the entry point for creating a deep clone of a whole object graph.
69    /// </remarks>
70    /// <returns>A clone of this instance.</returns>
71    public object Clone() {
72      return Clone(new Cloner());
73    }
74
75    /// <summary>
76    /// Clones the current instance (deep clone).
77    /// </summary>
78    /// <param name="clonedObjects">Dictionary of all already cloned objects. (Needed to avoid cycles.)</param>
79    /// <returns>The cloned object as <see cref="Variable"/>.</returns>
80    public virtual IDeepCloneable Clone(Cloner cloner) {
81      Item clone = (Item)Activator.CreateInstance(this.GetType());
82      cloner.RegisterClonedObject(this, clone);
83      clone.readOnlyView = readOnlyView;
84      return clone;
85    }
86
87    /// <summary>
88    /// Gets the string representation of the current instance.
89    /// </summary>
90    /// <returns>The type name of the current instance.</returns>
91    public override string ToString() {
92      return ItemName;
93    }
94
95    public event EventHandler ItemImageChanged;
96    protected virtual void OnItemImageChanged() {
97      EventHandler handler = ItemImageChanged;
98      if (handler != null) handler(this, EventArgs.Empty);
99    }
100    public event EventHandler ReadOnlyViewChanged;
101    protected virtual void OnReadOnlyViewChanged() {
102      EventHandler handler = ReadOnlyViewChanged;
103      if (handler != null) handler(this, EventArgs.Empty);
104    }
105    public event EventHandler ToStringChanged;
106    protected virtual void OnToStringChanged() {
107      EventHandler handler = ToStringChanged;
108      if (handler != null) handler(this, EventArgs.Empty);
109    }
110  }
111}
Note: See TracBrowser for help on using the repository browser.