Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Parameters/3.3/ValueLookupParameter.cs @ 4695

Last change on this file since 4695 was 4477, checked in by gkronber, 14 years ago

Merged r4458, r4459,r4462,r4464 from data analysis exploration branch into trunk. #1142

File size: 6.3 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 either defined in the parameter itself or is retrieved from the scope.
31  /// </summary>
32  [Item("ValueLookupParameter", "A parameter whose value is either defined in the parameter itself or is retrieved from or written to a scope.")]
33  [StorableClass]
34  public class ValueLookupParameter<T> : LookupParameter<T>, IValueLookupParameter<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 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    public ValueLookupParameter()
82      : base() {
83      this.getsCollected = true;
84    }
85    public ValueLookupParameter(string name)
86      : base(name) {
87      this.getsCollected = true;
88    }
89    public ValueLookupParameter(string name, bool getsCollected)
90      : base(name) {
91      this.getsCollected = getsCollected;
92    }
93    public ValueLookupParameter(string name, T value)
94      : base(name) {
95      this.value = value;
96      this.getsCollected = true;
97      Initialize();
98    }
99    public ValueLookupParameter(string name, T value, bool getsCollected)
100      : base(name) {
101      this.value = value;
102      this.getsCollected = getsCollected;
103      Initialize();
104    }
105    public ValueLookupParameter(string name, string description)
106      : base(name, description) {
107      this.getsCollected = true;
108    }
109    public ValueLookupParameter(string name, string description, bool getsCollected)
110      : base(name, description) {
111      this.getsCollected = getsCollected;
112    }
113    public ValueLookupParameter(string name, string description, T value)
114      : base(name, description) {
115      this.value = value;
116      this.getsCollected = true;
117      Initialize();
118    }
119    public ValueLookupParameter(string name, string description, T value, bool getsCollected)
120      : base(name, description) {
121      this.value = value;
122      this.getsCollected = getsCollected;
123      Initialize();
124    }
125    public ValueLookupParameter(string name, string description, string actualName)
126      : base(name, description, actualName) {
127      this.getsCollected = true;
128    }
129    public ValueLookupParameter(string name, string description, string actualName, bool getsCollected)
130      : base(name, description, actualName) {
131      this.getsCollected = getsCollected;
132    }
133    [StorableConstructor]
134    protected ValueLookupParameter(bool deserializing) : base(deserializing) { }
135    #endregion
136
137    [StorableHook(HookType.AfterDeserialization)]
138    private void Initialize() {
139      RegisterValueEvents();
140    }
141
142    public override IDeepCloneable Clone(Cloner cloner) {
143      ValueLookupParameter<T> clone = (ValueLookupParameter<T>)base.Clone(cloner);
144      clone.value = (T)cloner.Clone(value);
145      clone.getsCollected = getsCollected;
146      clone.Initialize();
147      return clone;
148    }
149
150    public override string ToString() {
151      if (Value != null)
152        return Name + ": " + Value.ToString();
153      else if (Name.Equals(ActualName))
154        return Name;
155      else
156        return Name + ": " + ActualName;
157    }
158
159    public event EventHandler ValueChanged;
160    protected virtual void OnValueChanged() {
161      EventHandler handler = ValueChanged;
162      if (handler != null) handler(this, EventArgs.Empty);
163      OnItemImageChanged();
164      OnToStringChanged();
165    }
166    public event EventHandler GetsCollectedChanged;
167    protected virtual void OnGetsCollectedChanged() {
168      EventHandler handler = GetsCollectedChanged;
169      if (handler != null) handler(this, EventArgs.Empty);
170    }
171
172    private void RegisterValueEvents() {
173      if (value != null) {
174        value.ItemImageChanged += new EventHandler(Value_ItemImageChanged);
175        value.ToStringChanged += new EventHandler(Value_ToStringChanged);
176      }
177    }
178    private void DeregisterValueEvents() {
179      if (value != null) {
180        value.ItemImageChanged -= new EventHandler(Value_ItemImageChanged);
181        value.ToStringChanged -= new EventHandler(Value_ToStringChanged);
182      }
183    }
184    private void Value_ItemImageChanged(object sender, EventArgs e) {
185      OnItemImageChanged();
186    }
187    private void Value_ToStringChanged(object sender, EventArgs e) {
188      OnToStringChanged();
189    }
190  }
191}
Note: See TracBrowser for help on using the repository browser.