Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Data/BoolArrayData.cs @ 800

Last change on this file since 800 was 763, checked in by gkronber, 16 years ago

removed visitor interfaces and methods in HeuristicLab.Data and fixed classes in HeuristicLab.Random to work without visitor methods. #343 (Rethink about usefulness of visitors for ObjectData and Constraints)

File size: 4.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;
27
28namespace HeuristicLab.Data {
29  /// <summary>
30  /// An array consisting of boolean values.
31  /// </summary>
32  public class BoolArrayData : ArrayDataBase {
33    /// <summary>
34    /// Gets or sets the boolean elements of the array.
35    /// </summary>
36    /// <remarks>Uses property <see cref="ArrayDataBase.Data"/> of base class <see cref="ArrayDataBase"/>.
37    /// No own data storage present.</remarks>
38    public new bool[] Data {
39      get { return (bool[])base.Data; }
40      set { base.Data = value; }
41    }
42
43    /// <summary>
44    /// Initializes a new instance of the <see cref="BoolArrayData"/> class.
45    /// </summary>
46    public BoolArrayData() {
47      Data = new bool[0];
48    }
49    /// <summary>
50    /// Initializes a new instance of the <see cref="BoolArrayData"/> class.
51    /// <note type="caution"> No CopyConstructor! <paramref name="data"/> is not copied!</note>
52    /// </summary>
53    /// <param name="data">The boolean array the instance should represent.</param>
54    public BoolArrayData(bool[] data) {
55      Data = data;
56    }
57
58    /// <summary>
59    /// Creates a new instance of the <see cref="BoolArrayDataView"/> class.
60    /// </summary>
61    /// <returns>The created instance of the <see cref="BoolArrayDataView"/>.</returns>
62    public override IView CreateView() {
63      return new BoolArrayDataView(this);
64    }
65
66    /// <summary>
67    /// Saves the current instance as <see cref="XmlNode"/> in the specified <paramref name="document"/>.
68    /// </summary>
69    /// <remarks>The boolean elements of the array are saved as string in the node's inner text, each element separated by a semicolon.</remarks>
70    /// <param name="name">The (tag)name of the <see cref="XmlNode"/>.</param>
71    /// <param name="document">The <see cref="XmlDocument"/> where to save the data.</param>
72    /// <param name="persistedObjects">A dictionary of all already persisted objects.
73    /// (Needed to avoid cycles.)</param>
74    /// <returns>The saved <see cref="XmlNode"/>.</returns>
75    public override XmlNode GetXmlNode(string name, XmlDocument document, IDictionary<Guid,IStorable> persistedObjects) {
76      XmlNode node = base.GetXmlNode(name, document, persistedObjects);
77      node.InnerText = ToString();
78      return node;
79    }
80    /// <summary>
81    /// Loads the persisted boolean array from the specified <paramref name="node"/>.
82    /// </summary>
83    /// <remarks> The elements of the boolean array must be saved in the node's inner
84    /// text as a string, each element separated by a semicolon
85    /// (see <see cref="GetXmlNode"/>).</remarks>
86    /// <param name="node">The <see cref="XmlNode"/> where the instance is saved.</param>
87    /// <param name="restoredObjects">A Dictionary of all already restored objects.
88    /// (Needed to avoid cycles.)</param>
89    public override void Populate(XmlNode node, IDictionary<Guid,IStorable> restoredObjects) {
90      base.Populate(node, restoredObjects);
91      string[] tokens = node.InnerText.Split(';');
92      bool[] data = new bool[tokens.Length];
93      for (int i = 0; i < data.Length; i++)
94        data[i] = bool.Parse(tokens[i]);
95      Data = data;
96    }
97  }
98}
Note: See TracBrowser for help on using the repository browser.