Changeset 737 for trunk/sources/HeuristicLab.Data/ConstrainedIntData.cs

Timestamp:

11/12/08 13:10:09 (16 years ago)

Author:

vdorfer

Message:

Created API documentation for HeuristLab.Data namespace (#331)

File:

• trunk/sources/HeuristicLab.Data/ConstrainedIntData.cs (modified) (5 diffs)

trunk/sources/HeuristicLab.Data/ConstrainedIntData.cs

@@ -28 +28 @@
 
 namespace HeuristicLab.Data {
+  /// <summary>
+  /// The representation of an int value having some constraints (e.g. smaller than 2).
+  /// </summary>
   public class ConstrainedIntData : ConstrainedObjectData {
+    /// <summary>
+    /// Gets or sets the int value of the current instance as <see cref="IntData"/>.
+    /// </summary>
+    /// <remarks>Uses property <see cref="ConstrainedObjectData.Data"/> of base class 
+    /// <see cref="ConstrainedObjectData"/>. No own data storage present.</remarks>
     public new int Data {
       get { return ((IntData)base.Data).Data; }
@@ -34 +42 @@
     }
 
+    /// <summary>
+    /// Initializes a new instance of <see cref="ConstrainedIntData"/> with default value <c>0</c>.
+    /// </summary>
     public ConstrainedIntData() : this (0) {
     }
+    /// <summary>
+    /// Initializes a new instance of <see cref="ConstrainedIntData"/> with the specified 
+    /// int value <paramref name="data"/> as <see cref="IntData"/>.
+    /// </summary>
+    /// <param name="data">The integer value to represent.</param>
     public ConstrainedIntData(int data) : base() {
       base.Data = new IntData(data);
     }
 
+    /// <inheritdoc cref="ConstrainedObjectData.TrySetData(object)"/>
     public virtual bool TrySetData(int data) {
       return base.TrySetData(new IntData(data));
     }
+    /// <inheritdoc cref="ConstrainedObjectData.TrySetData(object, out System.Collections.Generic.ICollection&lt;HeuristicLab.Core.IConstraint&gt;)"/>
     public virtual bool TrySetData(int data, out ICollection<IConstraint> violatedConstraints) {
       return base.TrySetData(new IntData(data), out violatedConstraints);
     }
 
+    /// <summary>
+    /// Creates a new instance of <see cref="ConstrainedIntDataView"/>.
+    /// </summary>
+    /// <returns>The created instance as <see cref="ConstrainedIntDataView"/>.</returns>
     public override IView CreateView() {
       return new ConstrainedIntDataView(this);
     }
 
+    /// <summary>
+    /// Clones the current instance.
+    /// </summary>
+    /// <remarks>Uses the <see cref="ConstrainedObjectData.Clone"/> implementation of base class <see cref="ConstrainedObjectData"/>.</remarks>
+    /// <param name="clonedObjects">A dictionary of all already cloned objects.</param>
+    /// <returns>The clone instance as <see cref="ConstrainedIntData"/>.</returns>
     public override object Clone(IDictionary<Guid, object> clonedObjects) {
       ConstrainedIntData clone = (ConstrainedIntData)base.Clone(clonedObjects);
@@ -56 +84 @@
     }
 
+    /// <summary>
+    /// Saves the current instance as <see cref="XmlNode"/> in the specified <paramref name="document"/>.
+    /// </summary>
+    /// <remarks>Uses the <see cref="ConstrainedItemBase.GetXmlNode"/> implementation of base class 
+    /// <see cref="ConstrainedObjectData"/>. The int value is saved as a <see cref="IntData"/> 
+    /// in a child node having the tag name <c>Value</c>.</remarks>
+    /// <param name="name">The (tag)name of the <see cref="XmlNode"/>.</param>
+    /// <param name="document">The <see cref="XmlDocument"/> where the data is saved.</param>
+    /// <param name="persistedObjects">A dictionary of all already persisted objects. (Needed to avoid cycles.)</param>
+    /// <returns>The saved <see cref="XmlNode"/>.</returns>
     public override XmlNode GetXmlNode(string name, XmlDocument document, IDictionary<Guid,IStorable> persistedObjects) {
       XmlNode node = base.GetXmlNode(name, document, persistedObjects);
@@ -61 +99 @@
       return node;
     }
+    /// <summary>
+    /// Loads the persisted int value from the specified <paramref name="node"/>.
+    /// </summary>
+    /// <remarks>The int value must be saved in the child node as a persisted <see cref="IntData"/>
+    /// having the tag name <c>Value</c> (see <see cref="GetXmlNode"/>).</remarks>
+    /// <param name="node">The <see cref="XmlNode"/> where the int is saved.</param>
+    /// <param name="restoredObjects">A dictionary of all already restored objects. (Needed to avoid cycles.)</param>
     public override void Populate(XmlNode node, IDictionary<Guid,IStorable> restoredObjects) {
       base.Populate(node, restoredObjects);
@@ -66 +111 @@
     }
 
+    /// <summary>
+    /// The point of intersection where an <see cref="IObjectDataVisitor"/> 
+    /// can change the int element.
+    /// </summary>
+    /// <param name="visitor">The visitor that changes the element.</param>
     public override void Accept(IObjectDataVisitor visitor) {
       visitor.Visit(this);