source: stable/HeuristicLab.Parameters/3.3/ValueLookupParameter.cs @ 17097

Last change on this file since 17097 was 17097, checked in by mkommend, 2 months ago

#2520: Merged 16565 - 16579 into stable.

File size: 6.7 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 System.Drawing;
24using HeuristicLab.Common;
25using HeuristicLab.Core;
26using HEAL.Attic;
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  [StorableType("B34BB41A-CF50-4275-9BCD-1861EBA7C58F")]
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    [StorableConstructor]
82    protected ValueLookupParameter(StorableConstructorFlag _) : base(_) { }
83    protected ValueLookupParameter(ValueLookupParameter<T> original, Cloner cloner)
84      : base(original, cloner) {
85      value = cloner.Clone(original.value);
86      getsCollected = original.getsCollected;
87      RegisterValueEvents();
88    }
89    public ValueLookupParameter()
90      : base() {
91      this.Hidden = false;
92      this.getsCollected = true;
93    }
94    public ValueLookupParameter(string name)
95      : base(name) {
96      this.Hidden = false;
97      this.getsCollected = true;
98    }
99    public ValueLookupParameter(string name, bool getsCollected)
100      : base(name) {
101      this.Hidden = false;
102      this.getsCollected = getsCollected;
103    }
104    public ValueLookupParameter(string name, T value)
105      : base(name) {
106      this.value = value;
107      this.Hidden = false;
108      this.getsCollected = true;
109      RegisterValueEvents();
110    }
111    public ValueLookupParameter(string name, T value, bool getsCollected)
112      : base(name) {
113      this.value = value;
114      this.Hidden = false;
115      this.getsCollected = getsCollected;
116      RegisterValueEvents();
117    }
118    public ValueLookupParameter(string name, string description)
119      : base(name, description) {
120      this.Hidden = false;
121      this.getsCollected = true;
122    }
123    public ValueLookupParameter(string name, string description, bool getsCollected)
124      : base(name, description) {
125      this.Hidden = false;
126      this.getsCollected = getsCollected;
127    }
128    public ValueLookupParameter(string name, string description, T value)
129      : base(name, description) {
130      this.value = value;
131      this.Hidden = false;
132      this.getsCollected = true;
133      RegisterValueEvents();
134    }
135    public ValueLookupParameter(string name, string description, T value, bool getsCollected)
136      : base(name, description) {
137      this.value = value;
138      this.Hidden = false;
139      this.getsCollected = getsCollected;
140      RegisterValueEvents();
141    }
142    public ValueLookupParameter(string name, string description, string actualName)
143      : base(name, description, actualName) {
144      this.Hidden = false;
145      this.getsCollected = true;
146    }
147    public ValueLookupParameter(string name, string description, string actualName, bool getsCollected)
148      : base(name, description, actualName) {
149      this.Hidden = false;
150      this.getsCollected = getsCollected;
151    }
152    #endregion
153
154    [StorableHook(HookType.AfterDeserialization)]
155    private void AfterDeserialization() {
156      RegisterValueEvents();
157    }
158
159    public override IDeepCloneable Clone(Cloner cloner) {
160      return new ValueLookupParameter<T>(this, cloner);
161    }
162
163    public override string ToString() {
164      if (Value != null)
165        return Name + ": " + Value.ToString();
166      else if (Name.Equals(ActualName))
167        return Name;
168      else
169        return Name + ": " + ActualName;
170    }
171
172    public event EventHandler ValueChanged;
173    protected virtual void OnValueChanged() {
174      EventHandler handler = ValueChanged;
175      if (handler != null) handler(this, EventArgs.Empty);
176      OnItemImageChanged();
177      OnToStringChanged();
178    }
179    public event EventHandler GetsCollectedChanged;
180    protected virtual void OnGetsCollectedChanged() {
181      EventHandler handler = GetsCollectedChanged;
182      if (handler != null) handler(this, EventArgs.Empty);
183    }
184
185    private void RegisterValueEvents() {
186      if (value != null) {
187        value.ItemImageChanged += new EventHandler(Value_ItemImageChanged);
188        value.ToStringChanged += new EventHandler(Value_ToStringChanged);
189      }
190    }
191    private void DeregisterValueEvents() {
192      if (value != null) {
193        value.ItemImageChanged -= new EventHandler(Value_ItemImageChanged);
194        value.ToStringChanged -= new EventHandler(Value_ToStringChanged);
195      }
196    }
197    private void Value_ItemImageChanged(object sender, EventArgs e) {
198      OnItemImageChanged();
199    }
200    private void Value_ToStringChanged(object sender, EventArgs e) {
201      OnToStringChanged();
202    }
203  }
204}
Note: See TracBrowser for help on using the repository browser.