source: branches/HeuristicLab.Data Path DataTypes/HeuristicLab.Data/3.3/ValueTypeArray.cs @ 9704

Last change on this file since 9704 was 9704, checked in by mkommend, 6 years ago

#2081: Merged trunk changes into path datatypes branch.

File size: 5.8 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2013 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.Collections;
24using System.Collections.Generic;
25using System.Drawing;
26using System.Linq;
27using System.Text;
28using HeuristicLab.Common;
29using HeuristicLab.Core;
30using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
31
32namespace HeuristicLab.Data {
33  [Item("ValueTypeArray", "An abstract base class for representing arrays of value types.")]
34  [StorableClass]
35  public abstract class ValueTypeArray<T> : Item, IEnumerable<T> where T : struct {
36    private const int maximumToStringLength = 100;
37
38    public static new Image StaticItemImage {
39      get { return HeuristicLab.Common.Resources.VSImageLibrary.Class; }
40    }
41
42    [Storable]
43    protected T[] array;
44
45    [Storable]
46    protected List<string> elementNames;
47    public virtual IEnumerable<string> ElementNames {
48      get { return this.elementNames; }
49      set {
50        if (ReadOnly) throw new NotSupportedException("ElementNames cannot be set. ValueTypeArray is read-only.");
51        if (value == null || !value.Any())
52          elementNames = new List<string>();
53        else if (value.Count() > Length)
54          throw new ArgumentException("The number of element names must not exceed the array length.");
55        else
56          elementNames = new List<string>(value);
57        OnElementNamesChanged();
58      }
59    }
60
61    public virtual int Length {
62      get { return array.Length; }
63      #region Mono Compatibility
64      // this setter should be protected, but the Mono compiler couldn't handle it
65      set {
66        if (ReadOnly) throw new NotSupportedException("Length cannot be set. ValueTypeArray is read-only.");
67        if (value != Length) {
68          Array.Resize<T>(ref array, value);
69          while (elementNames.Count > value)
70            elementNames.RemoveAt(elementNames.Count - 1);
71          OnElementNamesChanged();
72          OnReset();
73        }
74      }
75      #endregion
76    }
77    public virtual T this[int index] {
78      get { return array[index]; }
79      set {
80        if (ReadOnly) throw new NotSupportedException("Item cannot be set. ValueTypeArray is read-only.");
81        if (!value.Equals(array[index])) {
82          array[index] = value;
83          OnItemChanged(index);
84        }
85      }
86    }
87
88    [Storable]
89    protected bool readOnly;
90    public virtual bool ReadOnly {
91      get { return readOnly; }
92    }
93
94    [StorableHook(HookType.AfterDeserialization)]
95    private void AfterDeserialization() {
96      if (elementNames == null) { elementNames = new List<string>(); }
97    }
98
99    [StorableConstructor]
100    protected ValueTypeArray(bool deserializing) : base(deserializing) { }
101    protected ValueTypeArray(ValueTypeArray<T> original, Cloner cloner)
102      : base(original, cloner) {
103      this.array = (T[])original.array.Clone();
104      this.readOnly = original.readOnly;
105      this.elementNames = new List<string>(original.elementNames);
106    }
107    protected ValueTypeArray() {
108      array = new T[0];
109      readOnly = false;
110      elementNames = new List<string>();
111    }
112    protected ValueTypeArray(int length) {
113      array = new T[length];
114      readOnly = false;
115      elementNames = new List<string>();
116    }
117    protected ValueTypeArray(T[] elements) {
118      if (elements == null) throw new ArgumentNullException();
119      array = (T[])elements.Clone();
120      readOnly = false;
121      elementNames = new List<string>();
122    }
123
124    public virtual ValueTypeArray<T> AsReadOnly() {
125      ValueTypeArray<T> readOnlyValueTypeArray = (ValueTypeArray<T>)this.Clone();
126      readOnlyValueTypeArray.readOnly = true;
127      return readOnlyValueTypeArray;
128    }
129
130    public override string ToString() {
131      if (array.Length == 0) return "[]";
132
133      StringBuilder sb = new StringBuilder();
134      sb.Append("[");
135      sb.Append(array[0].ToString());
136      for (int i = 1; i < array.Length; i++) {
137        sb.Append(";").Append(array[i].ToString());
138        if (sb.Length > maximumToStringLength) {
139          sb.Append("...");
140          break;
141        }
142      }
143      sb.Append("]");
144      return sb.ToString();
145    }
146
147    public virtual IEnumerator<T> GetEnumerator() {
148      return array.Cast<T>().GetEnumerator();
149    }
150
151    IEnumerator IEnumerable.GetEnumerator() {
152      return GetEnumerator();
153    }
154
155    public event EventHandler ElementNamesChanged;
156    protected virtual void OnElementNamesChanged() {
157      EventHandler handler = ElementNamesChanged;
158      if (handler != null)
159        handler(this, EventArgs.Empty);
160    }
161
162    public event EventHandler<EventArgs<int>> ItemChanged;
163    protected virtual void OnItemChanged(int index) {
164      if (ItemChanged != null)
165        ItemChanged(this, new EventArgs<int>(index));
166      if (index < maximumToStringLength)
167        OnToStringChanged();
168    }
169    public event EventHandler Reset;
170    protected virtual void OnReset() {
171      if (Reset != null)
172        Reset(this, EventArgs.Empty);
173      OnToStringChanged();
174    }
175  }
176}
Note: See TracBrowser for help on using the repository browser.