Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Data/IntArrayData.cs @ 1009

Last change on this file since 1009 was 737, checked in by vdorfer, 16 years ago

Created API documentation for HeuristLab.Data namespace (#331)

File size: 5.1 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2008 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.Generic;
24using System.Text;
25using System.Xml;
26using HeuristicLab.Core;
27using System.Globalization;
28
29namespace HeuristicLab.Data {
30  /// <summary>
31  /// The representation of an array of integer values.
32  /// </summary>
33  public class IntArrayData : ArrayDataBase {
34    /// <summary>
35    /// Gets or sets the int elements of the array.
36    /// </summary>
37    /// <remarks>Uses property <see cref="ArrayDataBase.Data"/> of base class <see cref="ArrayDataBase"/>.
38    /// No own data storage present.</remarks>
39    public new int[] Data {
40      get { return (int[])base.Data; }
41      set { base.Data = value; }
42    }
43
44    /// <summary>
45    /// Initializes a new instance of <see cref="IntArrayData"/>.
46    /// </summary>
47    public IntArrayData() {
48      Data = new int[0];
49    }
50    /// <summary>
51    /// Initializes a new instance of <see cref="IntArrayData"/>.
52    /// <note type="caution"> No CopyConstructor! <paramref name="data"/> is not copied!</note>
53    /// </summary>
54    /// <param name="data">The array of integers to represent.</param>
55    public IntArrayData(int[] data) {
56      Data = data;
57    }
58
59    /// <summary>
60    /// Creates a enw instance of <see cref="IntArrayDataView"/>.
61    /// </summary>
62    /// <returns>The created instance as <see cref="IntArrayDataView"/>.</returns>
63    public override IView CreateView() {
64      return new IntArrayDataView(this);
65    }
66
67    /// <summary>
68    /// Saves the current instance as <see cref="XmlNode"/> in the specified <paramref name="document"/>.
69    /// </summary>
70    /// <remarks>The int elements of the array are saved in the node's inner text as string,
71    /// each element, whose format depends on the locale culture info, separated by a semicolon.</remarks>
72    /// <param name="name">The (tag)name of the <see cref="XmlNode"/>.</param>
73    /// <param name="document">The <see cref="XmlDocument"/> where the data is saved.</param>
74    /// <param name="persistedObjects">A dictionary of all already persisted objects. (Needed to avoid cycles.)</param>
75    /// <returns>The saved <see cref="XmlNode"></see>.</returns>
76    public override XmlNode GetXmlNode(string name, XmlDocument document, IDictionary<Guid,IStorable> persistedObjects) {
77      XmlNode node = base.GetXmlNode(name, document, persistedObjects);
78      node.InnerText = ToString(CultureInfo.InvariantCulture.NumberFormat);
79      return node;
80    }
81    /// <summary>
82    /// Loads the persisted int array from the specified <paramref name="node"/>.
83    /// </summary>
84    /// <remarks>The int elemets of the array must be saved in the inner text of the node as string,
85    /// each element separated by a semicolon and formatted according to the locale culture info and
86    /// its number format (see <see cref="GetXmlNode"/>).</remarks>
87    /// <param name="node">The <see cref="XmlNode"></see> where the instance is saved.</param>
88    /// <param name="restoredObjects">A dictionary of all already restored objects. (Needed to avoid cycles.)</param>
89    public override void Populate(XmlNode node, IDictionary<Guid,IStorable> restoredObjects) {
90      base.Populate(node, restoredObjects);
91      if (!node.InnerText.Equals("")) {
92        string[] tokens = node.InnerText.Split(';');
93        int[] data = new int[tokens.Length];
94        for (int i = 0; i < data.Length; i++)
95          data[i] = int.Parse(tokens[i], CultureInfo.InvariantCulture.NumberFormat);
96        Data = data;
97      }
98    }
99
100    /// <summary>
101    /// The string representation of the array, formatted according to the given <paramref name="format"/>.
102    /// </summary>
103    /// <param name="format">The <see cref="NumberFormatInfo"></see> the single int values
104    /// should be formatted accordingly.</param>
105    /// <returns>The elements of the array as string, each element separated by a semicolon
106    /// and formatted according to the parameter <paramref name="format"/>.</returns>
107    private string ToString(NumberFormatInfo format) {
108      StringBuilder builder = new StringBuilder();
109      for (int i = 0; i < Data.Length; i++) {
110        builder.Append(";");
111        builder.Append(Data[i].ToString(format));
112      }
113      if (builder.Length > 0) builder.Remove(0, 1);
114      return builder.ToString();
115    }
116  }
117}
Note: See TracBrowser for help on using the repository browser.