Free cookie consent management tool by TermsFeed Policy Generator

source: branches/HeuristicLab.Hive_Milestone3/sources/HeuristicLab.Data/3.2/BoolData.cs @ 3155

Last change on this file since 3155 was 1529, checked in by gkronber, 16 years ago

Moved source files of plugins AdvancedOptimizationFrontEnd ... Grid into version-specific sub-folders. #576

File size: 4.2 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  /// Class to represent boolean values.
31  /// </summary>
32  public class BoolData : ObjectData {
33    /// <summary>
34    /// Gets or sets the boolean value.
35    /// </summary>
36    /// <remarks>Uses property <see cref="ObjectData.Data"/>
37    /// of base class <see cref="ObjectData"/>. 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 <see cref="BoolData"/> with default value <c>false</c>.
45    /// </summary>
46    public BoolData() {
47      Data = false;
48    }
49    /// <summary>
50    /// Initializes a new instance of <see cref="BoolData"/> with the boolean value <paramref name="data"/>.
51    /// </summary>
52    /// <param name="data">The boolean value to assign.</param>
53    public BoolData(bool data) {
54      Data = data;
55    }
56    /// <summary>
57    /// Creates a new instance of the <see cref="BoolDataView"/> class.
58    /// </summary>
59    /// <returns>The created instance of the <see cref="BoolDataView"/>.</returns>
60    public override IView CreateView() {
61      return new BoolDataView(this);
62    }
63
64    /// <summary>
65    /// Clones the current instance.
66    /// </summary>
67    /// <remarks>The cloned instance is added to the <paramref name="dictionary"/>.</remarks>
68    /// <param name="clonedObjects">Dictionary of all already cloned objects.</param>
69    /// <returns>The cloned instance as <see cref="BoolData"/>.</returns>
70    public override object Clone(IDictionary<Guid, object> clonedObjects) {
71      BoolData clone = new BoolData();
72      clonedObjects.Add(Guid, clone);
73      clone.Data = Data;
74      return clone;
75    }
76    /// <summary>
77    /// Saves the current instance as <see cref="XmlNode"/> in the specified <paramref name="document"/>.
78    /// </summary>
79    /// <remarks>The boolean value is saved as string in the inner text of the node.</remarks>
80    /// <param name="name">The (tag)name of the <see cref="XmlNode"/>.</param>
81    /// <param name="document">The <see cref="XmlDocument"/> where to save the data.</param>
82    /// <param name="persistedObjects">The dictionary of all already persisted objects. (Needed to avoid cycles.)</param>
83    /// <returns>The saved <see cref="XmlNode"/>.</returns>
84    public override XmlNode GetXmlNode(string name, XmlDocument document, IDictionary<Guid,IStorable> persistedObjects) {
85      XmlNode node = base.GetXmlNode(name, document, persistedObjects);
86      node.InnerText = ToString();
87      return node;
88    }
89    /// <summary>
90    /// Loads the persisted boolean value from the specified <paramref name="node"/>.
91    /// </summary>
92    /// <remarks> The boolean value must be saved as string in the node's inner text
93    /// (see <see cref="GetXmlNode"/>).</remarks>
94    /// <param name="node">The <see cref="XmlNode"/> where the boolean value is saved.</param>
95    /// <param name="restoredObjects">The dictionary of all already restored objects.
96    /// (Needed to avoid cycles.)</param>
97    public override void Populate(XmlNode node, IDictionary<Guid,IStorable> restoredObjects) {
98      base.Populate(node, restoredObjects);
99      Data = bool.Parse(node.InnerText);
100    }
101  }
102}
Note: See TracBrowser for help on using the repository browser.