Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Data/3.3/ConstrainedDoubleData.cs @ 2351

Last change on this file since 2351 was 1853, checked in by epitzer, 15 years ago

Fix EmptyStorableClass attributes. (#603)

File size: 3.7 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;
28using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
29
30namespace HeuristicLab.Data {
31  /// <summary>
32  /// Represents a double value having some constraints (e.g. smaller than 5.3).
33  /// </summary>
34  [EmptyStorableClass]
35  public class ConstrainedDoubleData : ConstrainedObjectData {
36    /// <summary>
37    /// Gets or sets the double value of the current instance as <see cref="DoubleData"/>.
38    /// </summary>
39    /// <remarks>Uses property <see cref="ConstrainedObjectData.Data"/> of base
40    /// class <see cref="ConstrainedObjectData"/>. No own data storage present.</remarks>
41    public new double Data {
42      get { return ((DoubleData)base.Data).Data; }
43      set { ((DoubleData)base.Data).Data = value; }
44    }
45
46    /// <summary>
47    /// Initializes a new instance of <see cref="ConstrainedDoubleData"/> with default value <c>0.0</c>.
48    /// </summary>
49    public ConstrainedDoubleData()
50      : this(0.0) {
51    }
52    /// <summary>
53    /// Initializes a new instance of <see cref="ConstrainedDoubleData"/> with the specified
54    /// double value <paramref name="data"/> as <see cref="DoubleData"/>.
55    /// </summary>
56    /// <param name="data">The double value to represent.</param>
57    public ConstrainedDoubleData(double data)
58      : base() {
59      base.Data = new DoubleData(data);
60    }
61
62    /// <inheritdoc cref="ConstrainedObjectData.TrySetData(object)"/>
63    public virtual bool TrySetData(double data) {
64      return base.TrySetData(new DoubleData(data));
65    }
66    /// <inheritdoc cref="ConstrainedObjectData.TrySetData(object, out System.Collections.Generic.ICollection&lt;HeuristicLab.Core.IConstraint&gt;)"/>
67    public virtual bool TrySetData(double data, out ICollection<IConstraint> violatedConstraints) {
68      return base.TrySetData(new DoubleData(data), out violatedConstraints);
69    }
70
71    /// <summary>
72    /// Creates a new instance of <see cref="ConstrainedDoubleDataView"/>.
73    /// </summary>
74    /// <returns>The created instance as <see cref="ConstrainedDoubleDataView"/>.</returns>
75    public override IView CreateView() {
76      return new ConstrainedDoubleDataView(this);
77    }
78
79    /// <summary>
80    /// Clones the current instance.
81    /// </summary>
82    /// <remarks>Uses the <see cref="ConstrainedObjectData.Clone"/> implementation of base class <see cref="ConstrainedObjectData"/>.</remarks>
83    /// <param name="clonedObjects">A dictionary of all already cloned objects.</param>
84    /// <returns>The cloned instance as <see cref="ConstrainedDoubleData"/>.</returns>
85    public override object Clone(IDictionary<Guid, object> clonedObjects) {
86      ConstrainedDoubleData clone = (ConstrainedDoubleData)base.Clone(clonedObjects);
87      return clone;
88    }
89
90  }
91}
Note: See TracBrowser for help on using the repository browser.