Free cookie consent management tool by TermsFeed Policy Generator

source: branches/HeuristicLab.Hive_Milestone3/sources/HeuristicLab.Data/3.3/StringData.cs @ 5532

Last change on this file since 5532 was 1853, checked in by epitzer, 16 years ago

Fix EmptyStorableClass attributes. (#603)

File size: 3.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 HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
28
29namespace HeuristicLab.Data {
30  /// <summary>
31  /// The representation of a string.
32  /// </summary>
33  [EmptyStorableClass]
34  public class StringData : ObjectData {
35    /// <summary>
36    /// Gets or sets the string value.
37    /// </summary>
38    /// <remarks>Uses property <see cref="ObjectData.Data"/> of base class <see cref="ObjectData"/>.
39    /// No own data storage present.</remarks>
40    public new string Data {
41      get { return (string)base.Data; }
42      set { base.Data = value; }
43    }
44
45    /// <summary>
46    /// Initializes a new instance of <see cref="StringData"/>
47    /// with the name of the type of the current instance as default value.
48    /// </summary>
49    public StringData() {
50      Data = this.GetType().Name;
51    }
52    /// <summary>
53    /// Initializes a new instance of <see cref="StringData"/> with the specified <paramref name="data"/>.
54    /// </summary>
55    /// <param name="data">The string value the current instance should represent.</param>
56    public StringData(string data) {
57      Data = data;
58    }
59   
60    /// <summary>
61    /// Creates a new instance of <see cref="StringDataView"/>.
62    /// </summary>
63    /// <returns>The created instance as <see cref="StringDataView"/>.</returns>
64    public override IView CreateView() {
65      return new StringDataView(this);
66    }
67
68    /// <summary>
69    /// Clones the current instance.
70    /// </summary>
71    /// <remarks>The current instance is added to the dictionary <paramref name="clonedObjects"/>.</remarks>
72    /// <param name="clonedObjects">A dictionary of all already cloned objects.</param>
73    /// <returns>The coned instance as <see cref="StringData"/>.</returns>
74    public override object Clone(IDictionary<Guid, object> clonedObjects) {
75      StringData clone = new StringData();
76      clonedObjects.Add(Guid, clone);
77      clone.Data = Data;
78      return clone;
79    }
80
81    /// <summary>
82    /// The string representation of the current instance.
83    /// </summary>
84    /// <returns>The string value.</returns>
85    public override string ToString() {
86      return Data;
87    }
88  }
89}
Note: See TracBrowser for help on using the repository browser.