Free cookie consent management tool by TermsFeed Policy Generator

source: branches/ParameterBinding/HeuristicLab.Parameters/3.3/OptionalValueParameter.cs @ 5379

Last change on this file since 5379 was 4722, checked in by swagner, 14 years ago

Merged cloning refactoring branch back into trunk (#922)

File size: 6.2 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.Core;
26using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
27
28namespace HeuristicLab.Parameters {
29  /// <summary>
30  /// A parameter whose value is defined in the parameter itself or is null.
31  /// </summary>
32  [Item("OptionalValueParameter", "A parameter whose value is defined in the parameter itself or is null.")]
33  [StorableClass]
34  public class OptionalValueParameter<T> : Parameter, IValueParameter<T> where T : class, IItem {
35    public override Image ItemImage {
36      get {
37        if (value != null) return value.ItemImage;
38        else return base.ItemImage;
39      }
40    }
41
42    [Storable]
43    private T value;
44    public virtual T Value {
45      get { return this.value; }
46      set {
47        if (value != this.value) {
48          DeregisterValueEvents();
49          this.value = value;
50          RegisterValueEvents();
51          OnValueChanged();
52        }
53      }
54    }
55    IItem IValueParameter.Value {
56      get { return Value; }
57      set {
58        T val = value as T;
59        if ((value != null) && (val == null))
60          throw new InvalidOperationException(
61            string.Format("Type mismatch. Value is not a \"{0}\".",
62                          typeof(T).GetPrettyName())
63          );
64        Value = val;
65      }
66    }
67
68    [Storable(DefaultValue = true)]
69    private bool getsCollected;
70    public bool GetsCollected {
71      get { return getsCollected; }
72      set {
73        if (value != getsCollected) {
74          getsCollected = value;
75          OnGetsCollectedChanged();
76        }
77      }
78    }
79
80    #region Constructors
81    [StorableConstructor]
82    protected OptionalValueParameter(bool deserializing) : base(deserializing) { }
83    protected OptionalValueParameter(OptionalValueParameter<T> original, Cloner cloner)
84      : base(original, cloner) {
85      value = cloner.Clone(original.value);
86      getsCollected = original.getsCollected;
87      RegisterValueEvents();
88    }
89    public OptionalValueParameter()
90      : base("Anonymous", typeof(T)) {
91      this.getsCollected = true;
92    }
93    public OptionalValueParameter(string name)
94      : base(name, typeof(T)) {
95      this.getsCollected = true;
96    }
97    public OptionalValueParameter(string name, bool getsCollected)
98      : base(name, typeof(T)) {
99      this.getsCollected = getsCollected;
100    }
101    public OptionalValueParameter(string name, T value)
102      : base(name, typeof(T)) {
103      this.value = value;
104      this.getsCollected = true;
105      RegisterValueEvents();
106    }
107    public OptionalValueParameter(string name, T value, bool getsCollected)
108      : base(name, typeof(T)) {
109      this.value = value;
110      this.getsCollected = getsCollected;
111      RegisterValueEvents();
112    }
113    public OptionalValueParameter(string name, string description)
114      : base(name, description, typeof(T)) {
115      this.getsCollected = true;
116    }
117    public OptionalValueParameter(string name, string description, bool getsCollected)
118      : base(name, description, typeof(T)) {
119      this.getsCollected = getsCollected;
120    }
121    public OptionalValueParameter(string name, string description, T value)
122      : base(name, description, typeof(T)) {
123      this.value = value;
124      this.getsCollected = true;
125      RegisterValueEvents();
126    }
127    public OptionalValueParameter(string name, string description, T value, bool getsCollected)
128      : base(name, description, typeof(T)) {
129      this.value = value;
130      this.getsCollected = getsCollected;
131      RegisterValueEvents();
132    }
133    #endregion
134
135    [StorableHook(HookType.AfterDeserialization)]
136    private void AfterDeserialization() {
137      RegisterValueEvents();
138    }
139
140    public override IDeepCloneable Clone(Cloner cloner) {
141      return new OptionalValueParameter<T>(this, cloner);
142    }
143
144    public override string ToString() {
145      return Name + ": " + (Value != null ? Value.ToString() : "null");
146    }
147
148    protected override IItem GetActualValue() {
149      return Value;
150    }
151    protected override void SetActualValue(IItem value) {
152      ((IValueParameter)this).Value = value;
153    }
154
155    public event EventHandler ValueChanged;
156    protected virtual void OnValueChanged() {
157      EventHandler handler = ValueChanged;
158      if (handler != null) handler(this, EventArgs.Empty);
159      OnItemImageChanged();
160      OnToStringChanged();
161    }
162    public event EventHandler GetsCollectedChanged;
163    protected virtual void OnGetsCollectedChanged() {
164      EventHandler handler = GetsCollectedChanged;
165      if (handler != null) handler(this, EventArgs.Empty);
166    }
167
168    private void RegisterValueEvents() {
169      if (value != null) {
170        value.ItemImageChanged += new EventHandler(Value_ItemImageChanged);
171        value.ToStringChanged += new EventHandler(Value_ToStringChanged);
172      }
173    }
174    private void DeregisterValueEvents() {
175      if (value != null) {
176        value.ItemImageChanged -= new EventHandler(Value_ItemImageChanged);
177        value.ToStringChanged -= new EventHandler(Value_ToStringChanged);
178      }
179    }
180    private void Value_ItemImageChanged(object sender, EventArgs e) {
181      OnItemImageChanged();
182    }
183    private void Value_ToStringChanged(object sender, EventArgs e) {
184      OnToStringChanged();
185    }
186  }
187}
Note: See TracBrowser for help on using the repository browser.