Free cookie consent management tool by TermsFeed Policy Generator

source: branches/Operator Architecture Refactoring/HeuristicLab.Data/ConstrainedIntData.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: 5.4 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  /// The representation of an int value having some constraints (e.g. smaller than 2).
32  /// </summary>
33  public class ConstrainedIntData : ConstrainedObjectData {
34    /// <summary>
35    /// Gets or sets the int value of the current instance as <see cref="IntData"/>.
36    /// </summary>
37    /// <remarks>Uses property <see cref="ConstrainedObjectData.Data"/> of base class
38    /// <see cref="ConstrainedObjectData"/>. No own data storage present.</remarks>
39    public new int Data {
40      get { return ((IntData)base.Data).Data; }
41      set { ((IntData)base.Data).Data = value; }
42    }
43
44    /// <summary>
45    /// Initializes a new instance of <see cref="ConstrainedIntData"/> with default value <c>0</c>.
46    /// </summary>
47    public ConstrainedIntData() : this (0) {
48    }
49    /// <summary>
50    /// Initializes a new instance of <see cref="ConstrainedIntData"/> with the specified
51    /// int value <paramref name="data"/> as <see cref="IntData"/>.
52    /// </summary>
53    /// <param name="data">The integer value to represent.</param>
54    public ConstrainedIntData(int data) : base() {
55      base.Data = new IntData(data);
56    }
57
58    /// <inheritdoc cref="ConstrainedObjectData.TrySetData(object)"/>
59    public virtual bool TrySetData(int data) {
60      return base.TrySetData(new IntData(data));
61    }
62    /// <inheritdoc cref="ConstrainedObjectData.TrySetData(object, out System.Collections.Generic.ICollection&lt;HeuristicLab.Core.IConstraint&gt;)"/>
63    public virtual bool TrySetData(int data, out ICollection<IConstraint> violatedConstraints) {
64      return base.TrySetData(new IntData(data), out violatedConstraints);
65    }
66
67    /// <summary>
68    /// Creates a new instance of <see cref="ConstrainedIntDataView"/>.
69    /// </summary>
70    /// <returns>The created instance as <see cref="ConstrainedIntDataView"/>.</returns>
71    public override IView CreateView() {
72      return new ConstrainedIntDataView(this);
73    }
74
75    /// <summary>
76    /// Clones the current instance.
77    /// </summary>
78    /// <remarks>Uses the <see cref="ConstrainedObjectData.Clone"/> implementation of base class <see cref="ConstrainedObjectData"/>.</remarks>
79    /// <param name="clonedObjects">A dictionary of all already cloned objects.</param>
80    /// <returns>The clone instance as <see cref="ConstrainedIntData"/>.</returns>
81    public override object Clone(IDictionary<Guid, object> clonedObjects) {
82      ConstrainedIntData clone = (ConstrainedIntData)base.Clone(clonedObjects);
83      return clone;
84    }
85
86    /// <summary>
87    /// Saves the current instance as <see cref="XmlNode"/> in the specified <paramref name="document"/>.
88    /// </summary>
89    /// <remarks>Uses the <see cref="ConstrainedItemBase.GetXmlNode"/> implementation of base class
90    /// <see cref="ConstrainedObjectData"/>. The int value is saved as a <see cref="IntData"/>
91    /// in a child node having the tag name <c>Value</c>.</remarks>
92    /// <param name="name">The (tag)name of the <see cref="XmlNode"/>.</param>
93    /// <param name="document">The <see cref="XmlDocument"/> where the data is saved.</param>
94    /// <param name="persistedObjects">A dictionary of all already persisted objects. (Needed to avoid cycles.)</param>
95    /// <returns>The saved <see cref="XmlNode"/>.</returns>
96    public override XmlNode GetXmlNode(string name, XmlDocument document, IDictionary<Guid,IStorable> persistedObjects) {
97      XmlNode node = base.GetXmlNode(name, document, persistedObjects);
98      node.AppendChild(PersistenceManager.Persist("Value", ((IntData)base.Data), document, persistedObjects));
99      return node;
100    }
101    /// <summary>
102    /// Loads the persisted int value from the specified <paramref name="node"/>.
103    /// </summary>
104    /// <remarks>The int value must be saved in the child node as a persisted <see cref="IntData"/>
105    /// having the tag name <c>Value</c> (see <see cref="GetXmlNode"/>).</remarks>
106    /// <param name="node">The <see cref="XmlNode"/> where the int is saved.</param>
107    /// <param name="restoredObjects">A dictionary of all already restored objects. (Needed to avoid cycles.)</param>
108    public override void Populate(XmlNode node, IDictionary<Guid,IStorable> restoredObjects) {
109      base.Populate(node, restoredObjects);
110      base.Data = (IntData)PersistenceManager.Restore(node.SelectSingleNode("Value"), restoredObjects);
111    }
112  }
113}
Note: See TracBrowser for help on using the repository browser.