source: trunk/sources/HeuristicLab.Data/3.3/ValueTypeArray.cs @ 9456

Last change on this file since 9456 was 9456, checked in by swagner, 9 years ago

Updated copyright year and added some missing license headers (#1889)

File size: 4.4 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    public virtual int Length {
46      get { return array.Length; }
47      #region Mono Compatibility
48      // this setter should be protected, but the Mono compiler couldn't handle it
49      set {
50        if (ReadOnly) throw new NotSupportedException("Length cannot be set. ValueTypeArray is read-only.");
51        if (value != Length) {
52          Array.Resize<T>(ref array, value);
53          OnReset();
54        }
55      }
56      #endregion
57    }
58    public virtual T this[int index] {
59      get { return array[index]; }
60      set {
61        if (ReadOnly) throw new NotSupportedException("Item cannot be set. ValueTypeArray is read-only.");
62        if (!value.Equals(array[index])) {
63          array[index] = value;
64          OnItemChanged(index);
65        }
66      }
67    }
68
69    [Storable]
70    protected bool readOnly;
71    public virtual bool ReadOnly {
72      get { return readOnly; }
73    }
74
75    [StorableConstructor]
76    protected ValueTypeArray(bool deserializing) : base(deserializing) { }
77    protected ValueTypeArray(ValueTypeArray<T> original, Cloner cloner)
78      : base(original, cloner) {
79      this.array = (T[])original.array.Clone();
80      this.readOnly = original.readOnly;
81    }
82    protected ValueTypeArray() {
83      array = new T[0];
84      readOnly = false;
85    }
86    protected ValueTypeArray(int length) {
87      array = new T[length];
88      readOnly = false;
89    }
90    protected ValueTypeArray(T[] elements) {
91      if (elements == null) throw new ArgumentNullException();
92      array = (T[])elements.Clone();
93      readOnly = false;
94    }
95
96    public virtual ValueTypeArray<T> AsReadOnly() {
97      ValueTypeArray<T> readOnlyValueTypeArray = (ValueTypeArray<T>)this.Clone();
98      readOnlyValueTypeArray.readOnly = true;
99      return readOnlyValueTypeArray;
100    }
101
102    public override string ToString() {
103      if (array.Length == 0) return "[]";
104
105      StringBuilder sb = new StringBuilder();
106      sb.Append("[");
107      sb.Append(array[0].ToString());
108      for (int i = 1; i < array.Length; i++) {
109        sb.Append(";").Append(array[i].ToString());
110        if (sb.Length > maximumToStringLength) {
111          sb.Append("...");
112          break;
113        }
114      }
115      sb.Append("]");
116      return sb.ToString();
117    }
118
119    public virtual IEnumerator<T> GetEnumerator() {
120      return array.Cast<T>().GetEnumerator();
121    }
122
123    IEnumerator IEnumerable.GetEnumerator() {
124      return GetEnumerator();
125    }
126
127    public event EventHandler<EventArgs<int>> ItemChanged;
128    protected virtual void OnItemChanged(int index) {
129      if (ItemChanged != null)
130        ItemChanged(this, new EventArgs<int>(index));
131      if (index < maximumToStringLength)
132        OnToStringChanged();
133    }
134    public event EventHandler Reset;
135    protected virtual void OnReset() {
136      if (Reset != null)
137        Reset(this, EventArgs.Empty);
138      OnToStringChanged();
139    }
140  }
141}
Note: See TracBrowser for help on using the repository browser.