Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Parameters/3.3/OptionalValueParameter.cs @ 2994

Last change on this file since 2994 was 2994, checked in by epitzer, 14 years ago

Make StorableClass attribute compulsory for StorableSerializer to work, add named property StorableClassType to choose between Empty and MarkedOnly, later other options will be added. (#548)

File size: 3.6 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 HeuristicLab.Common;
24using HeuristicLab.Core;
25using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
26
27namespace HeuristicLab.Parameters {
28  /// <summary>
29  /// A parameter whose value is defined in the parameter itself or is null.
30  /// </summary>
31  [Item("OptionalValueParameter<T>", "A parameter whose value is defined in the parameter itself or is null.")]
32  [StorableClass(StorableClassType.MarkedOnly)]
33  public class OptionalValueParameter<T> : Parameter, IValueParameter<T> where T : class, IItem {
34    private T value;
35    [Storable]
36    public virtual T Value {
37      get { return this.value; }
38      set {
39        if (value != this.value) {
40          if (this.value != null) this.value.ToStringChanged -= new EventHandler(Value_ToStringChanged);
41          this.value = value;
42          if (this.value != null) this.value.ToStringChanged += new EventHandler(Value_ToStringChanged);
43          OnValueChanged();
44        }
45      }
46    }
47    IItem IValueParameter.Value {
48      get { return Value; }
49      set {
50        T val = value as T;
51        if ((value != null) && (val == null))
52          throw new InvalidOperationException(
53            string.Format("Type mismatch. Value is not a \"{0}\".",
54                          typeof(T).GetPrettyName())
55          );
56        Value = val;
57      }
58    }
59
60    public OptionalValueParameter()
61      : base("Anonymous", typeof(T)) {
62    }
63    public OptionalValueParameter(string name)
64      : base(name, typeof(T)) {
65    }
66    public OptionalValueParameter(string name, T value)
67      : base(name, typeof(T)) {
68      Value = value;
69    }
70    public OptionalValueParameter(string name, string description)
71      : base(name, description, typeof(T)) {
72    }
73    public OptionalValueParameter(string name, string description, T value)
74      : base(name, description, typeof(T)) {
75      Value = value;
76    }
77
78    public override IDeepCloneable Clone(Cloner cloner) {
79      OptionalValueParameter<T> clone = (OptionalValueParameter<T>)base.Clone(cloner);
80      clone.Value = (T)cloner.Clone(value);
81      return clone;
82    }
83
84    public override string ToString() {
85      return string.Format("{0}: {1} ({2})", Name, Value != null ? Value.ToString() : "null", DataType.GetPrettyName());
86    }
87
88    protected override IItem GetActualValue() {
89      return Value;
90    }
91    protected override void SetActualValue(IItem value) {
92      ((IValueParameter)this).Value = value;
93    }
94
95    public event EventHandler ValueChanged;
96    private void OnValueChanged() {
97      if (ValueChanged != null)
98        ValueChanged(this, EventArgs.Empty);
99      OnToStringChanged();
100    }
101    private void Value_ToStringChanged(object sender, EventArgs e) {
102      OnToStringChanged();
103    }
104  }
105}
Note: See TracBrowser for help on using the repository browser.