Free cookie consent management tool by TermsFeed Policy Generator

source: branches/HeuristicLab.Hive_Milestone3/sources/HeuristicLab.Data/3.2/StringData.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.5 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  /// The representation of a string.
31  /// </summary>
32  public class StringData : ObjectData {
33    /// <summary>
34    /// Gets or sets the string value.
35    /// </summary>
36    /// <remarks>Uses property <see cref="ObjectData.Data"/> of base class <see cref="ObjectData"/>.
37    /// No own data storage present.</remarks>
38    public new string Data {
39      get { return (string)base.Data; }
40      set { base.Data = value; }
41    }
42
43    /// <summary>
44    /// Initializes a new instance of <see cref="StringData"/>
45    /// with the name of the type of the current instance as default value.
46    /// </summary>
47    public StringData() {
48      Data = this.GetType().Name;
49    }
50    /// <summary>
51    /// Initializes a new instance of <see cref="StringData"/> with the specified <paramref name="data"/>.
52    /// </summary>
53    /// <param name="data">The string value the current instance should represent.</param>
54    public StringData(string data) {
55      Data = data;
56    }
57   
58    /// <summary>
59    /// Creates a new instance of <see cref="StringDataView"/>.
60    /// </summary>
61    /// <returns>The created instance as <see cref="StringDataView"/>.</returns>
62    public override IView CreateView() {
63      return new StringDataView(this);
64    }
65
66    /// <summary>
67    /// Clones the current instance.
68    /// </summary>
69    /// <remarks>The current instance is added to the dictionary <paramref name="clonedObjects"/>.</remarks>
70    /// <param name="clonedObjects">A dictionary of all already cloned objects.</param>
71    /// <returns>The coned instance as <see cref="StringData"/>.</returns>
72    public override object Clone(IDictionary<Guid, object> clonedObjects) {
73      StringData clone = new StringData();
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 string value is saved in the node's inner text.</remarks>
83    /// <param name="name">The (tag)name of the <see cref="XmlNode"/>.</param>
84    /// <param name="document">The <see cref="XmlDocument"/> where to save the data.</param>
85    /// <param name="persistedObjects">A dictionary of all already persisted objects.(Needed to avoid cycles.)</param>
86    /// <returns>The saved <see cref="XmlNode"/>.</returns>
87    public override XmlNode GetXmlNode(string name, XmlDocument document, IDictionary<Guid,IStorable> persistedObjects) {
88      XmlNode node = base.GetXmlNode(name, document, persistedObjects);
89      node.InnerText = Data;
90      return node;
91    }
92    /// <summary>
93    ///  Loads the persisted string value from the specified <paramref name="node"/>.
94    /// </summary>
95    /// <remarks>The string value must be saved in the node's inner text
96    /// (see <see cref="GetXmlNode"/>).</remarks>
97    /// <param name="node">The <see cref="XmlNode"/> where the string is saved.</param>
98    /// <param name="restoredObjects">A dictionary of all already restored objects. (Needed to avoid cycles.)</param>
99    public override void Populate(XmlNode node, IDictionary<Guid,IStorable> restoredObjects) {
100      base.Populate(node, restoredObjects);
101      Data = node.InnerText;
102    }
103
104    /// <summary>
105    /// The string representation of the current instance.
106    /// </summary>
107    /// <returns>The string value.</returns>
108    public override string ToString() {
109      return Data;
110    }
111  }
112}
Note: See TracBrowser for help on using the repository browser.