Free cookie consent management tool by TermsFeed Policy Generator

source: branches/2435-alglib_3_15/HeuristicLab.Core/3.3/NamedItem.cs @ 17034

Last change on this file since 17034 was 17034, checked in by mkommend, 5 years ago

#2435: Updated branch with most recent trunk changes.

File size: 5.2 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2019 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 HeuristicLab.Common;
24using HEAL.Attic;
25
26namespace HeuristicLab.Core {
27  [Item("NamedItem", "Base class for items which have a name and an optional description.")]
28  [StorableType("7492EDE5-CA7C-45D5-B5CE-8709BFAC9239")]
29  public abstract class NamedItem : Item, INamedItem {
30    [Storable]
31    protected string name;
32    /// Gets and sets the name of the item.
33    /// <remarks>Calls <see cref="OnNameChanging"/> and also <see cref="OnNameChanged"/>
34    /// eventually in the setter.</remarks>
35    public string Name {
36      get { return name; }
37      set {
38        if (!CanChangeName) throw new NotSupportedException("Name cannot be changed.");
39        if (!(name.Equals(value) || (value == null) && (name == string.Empty))) {
40          CancelEventArgs<string> e = value == null ? new CancelEventArgs<string>(string.Empty) : new CancelEventArgs<string>(value);
41          OnNameChanging(e);
42          if (!e.Cancel) {
43            name = value == null ? string.Empty : value;
44            OnNameChanged();
45          }
46        }
47      }
48    }
49    public virtual bool CanChangeName {
50      get { return true; }
51    }
52    [Storable]
53    protected string description;
54    public string Description {
55      get { return description; }
56      set {
57        if (!CanChangeDescription) throw new NotSupportedException("Description cannot be changed.");
58        if (!(description.Equals(value) || (value == null) && (description == string.Empty))) {
59          description = value == null ? string.Empty : value;
60          OnDescriptionChanged();
61        }
62      }
63    }
64    public virtual bool CanChangeDescription {
65      get { return true; }
66    }
67
68    [StorableConstructor]
69    protected NamedItem(StorableConstructorFlag _) : base(_) { }
70    protected NamedItem(NamedItem original, Cloner cloner)
71      : base(original, cloner) {
72      name = original.name;
73      description = original.description;
74    }
75    /// <summary>
76    /// Initializes a new instance of <see cref="NamedItem"/> with name and description <c>string.Empty</c>
77    /// and value <c>null</c>.
78    /// </summary>
79    protected NamedItem() {
80      name = string.Empty;
81      description = string.Empty;
82    }
83    /// <summary>
84    /// Initializes a new instance of <see cref="NamedItem"/> with the specified <paramref name="name"/>
85    /// </summary>
86    /// <param name="name">The name of the current instance.</param>
87    protected NamedItem(string name) {
88      if (name == null) this.name = string.Empty;
89      else this.name = name;
90      description = string.Empty;
91    }
92    /// <summary>
93    /// Initializes a new instance of <see cref="NamedItem"/> with the specified <paramref name="name"/> and <paramref name="description"/>.
94    /// </summary>
95    protected NamedItem(string name, string description) {
96      if (name == null) this.name = string.Empty;
97      else this.name = name;
98      if (description == null) this.description = string.Empty;
99      else this.description = description;
100    }
101
102    /// <summary>
103    /// Gets the string representation of the current instance.
104    /// </summary>
105    /// <returns>The current instance as a string.</returns>
106    public override string ToString() {
107      return Name;
108    }
109
110    /// <inheritdoc/>
111    public event EventHandler<CancelEventArgs<string>> NameChanging;
112    /// <summary>
113    /// Fires a new <c>NameChanging</c> event.
114    /// </summary>
115    /// <param name="e">The event arguments of the changing.</param>
116    protected virtual void OnNameChanging(CancelEventArgs<string> e) {
117      var handler = NameChanging;
118      if (handler != null) handler(this, e);
119    }
120    /// <inheritdoc/>
121    public event EventHandler NameChanged;
122    /// <summary>
123    /// Fires a new <c>NameChanged</c> event.
124    /// </summary>
125    /// <remarks>Calls <see cref="Item.OnToStringChanged"/>.</remarks>
126    protected virtual void OnNameChanged() {
127      var handler = NameChanged;
128      if (handler != null) handler(this, EventArgs.Empty);
129      OnToStringChanged();
130    }
131    /// <inheritdoc/>
132    public event EventHandler DescriptionChanged;
133    /// <summary>
134    /// Fires a new <c>DescriptionChanged</c> event.
135    /// </summary>
136    protected virtual void OnDescriptionChanged() {
137      var handler = DescriptionChanged;
138      if (handler != null) handler(this, EventArgs.Empty);
139    }
140  }
141}
Note: See TracBrowser for help on using the repository browser.