Free cookie consent management tool by TermsFeed Policy Generator

source: branches/Operator Architecture Refactoring/HeuristicLab.Data/DoubleData.cs @ 1181

Last change on this file since 1181 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.8 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  /// Class to represent double values.
32  /// </summary>
33  public class DoubleData : ObjectData {
34    /// <summary>
35    /// Gets or sets the double value.
36    /// </summary>
37    /// <remarks>Uses property <see cref="ObjectData.Data"/> of base class <see cref="ObjectData"></see>.
38    /// No own data storage present.</remarks>
39    public new double Data {
40      get { return (double)base.Data; }
41      set { base.Data = value; }
42    }
43
44    /// <summary>
45    /// Initializes a new instance of <see cref="DoubleData"/> with default value <c>0.0</c>.
46    /// </summary>
47    public DoubleData() {
48      Data = 0.0;
49    }
50    /// <summary>
51    /// Initializes a new instance of <see cref="DoubleData"/>.
52    /// <note type="caution"> No CopyConstructor! <paramref name="data"/> is not copied!</note>
53    /// </summary>
54    /// <param name="data">The double value the instance should represent.</param>
55    public DoubleData(double data) {
56      Data = data;
57    }
58
59    /// <summary>
60    /// Creates a new instance of the <see cref="DoubleDataView"/> class.
61    /// </summary>
62    /// <returns>The created instance of <see cref="DoubleDataView"/>.</returns>
63    public override IView CreateView() {
64      return new DoubleDataView(this);
65    }
66
67    /// <summary>
68    /// Clones the current instance and adds it to the dictionary <paramref name="clonedObjects"/>.
69    /// </summary>
70    /// <param name="clonedObjects">Dictionary of all already cloned objects.</param>
71    /// <returns>The cloned instance as <see cref="DoubleData"/>.</returns>
72    public override object Clone(IDictionary<Guid, object> clonedObjects) {
73      DoubleData clone = new DoubleData();
74      clonedObjects.Add(Guid, clone);
75      clone.Data = Data;
76      return clone;
77    }
78
79    /// <summary>
80    /// Saves the current instance as <see cref="XmlNode"/> in the specified <paramref name="document"/>.
81    /// </summary>
82    /// <remarks>The double value is saved in the node's inner text as string,
83    /// its format depending on the local culture info and its number format.</remarks>
84    /// <param name="name">The (tag)name of the <see cref="XmlNode"/>.</param>
85    /// <param name="document">The <see cref="XmlDocument"/> where the data is saved.</param>
86    /// <param name="persistedObjects">A dictionary of all already persisted objects. (Needed to avoid cycles.)</param>
87    /// <returns>The saved <see cref="XmlNode"/>.</returns>
88    public override XmlNode GetXmlNode(string name, XmlDocument document, IDictionary<Guid,IStorable> persistedObjects) {
89      XmlNode node = base.GetXmlNode(name, document, persistedObjects);
90      node.InnerText = Data.ToString("r", CultureInfo.InvariantCulture.NumberFormat);
91      return node;
92    }
93    /// <summary>
94    /// Loads the persisted double value from the specified <paramref name="node"/>.
95    /// </summary>
96    /// <remarks>The double value must be saved in the node's inner text as a string and
97    /// formatted according to the locale culture info and
98    /// its number format (see <see cref="GetXmlNode"/>).</remarks>
99    /// <exception cref="System.FormatException">Thrown when the saved value cannot be parsed as a double value.</exception>
100    /// <param name="node">The <see cref="XmlNode"/> where the double is saved.</param>
101    /// <param name="restoredObjects">A dictionary of all already restored objects. (Needed to avoid cycles.)</param>
102    public override void Populate(XmlNode node, IDictionary<Guid,IStorable> restoredObjects) {
103      base.Populate(node, restoredObjects);
104      double data;
105      if(double.TryParse(node.InnerText, NumberStyles.Float, CultureInfo.InvariantCulture.NumberFormat, out data) == true) {
106        Data = data;
107      } else {
108        throw new FormatException("Can't parse " + node.InnerText + " as double value.");       
109      }
110    }
111  }
112}
Note: See TracBrowser for help on using the repository browser.