Changeset 884 for trunk/sources/HeuristicLab.Routing.TSP/TSPTour.cs

Timestamp:

12/02/08 12:41:21 (16 years ago)

Author:

vdorfer

Message:

Created API documentation for HeuristicLab.Routing.TSP namespace (#331)

File:

• trunk/sources/HeuristicLab.Routing.TSP/TSPTour.cs (modified) (7 diffs)

trunk/sources/HeuristicLab.Routing.TSP/TSPTour.cs

@@ -29 +29 @@
 
 namespace HeuristicLab.Routing.TSP {
+  /// <summary>
+  /// Represent the tour of a TSP.
+  /// </summary>
   public class TSPTour : ItemBase, IVisualizationItem {
     private DoubleMatrixData myCoordinates;
+    /// <summary>
+    /// Gets or sets the coordinates of the current instance.
+    /// </summary>
     public DoubleMatrixData Coordinates {
       get { return myCoordinates; }
@@ -36 +42 @@
     }
     private Permutation.Permutation myTour;
+    /// <summary>
+    /// Gets or sets the current permutation/tour of the current instance.
+    /// </summary>
     public Permutation.Permutation Tour {
       get { return myTour; }
@@ -42 +51 @@
 
 
+    /// <summary>
+    /// Initializes a new instance of <see cref="TSPTour"/>.
+    /// </summary>
     public TSPTour() { }
+    /// <summary>
+    /// Initializes a new instance of <see cref="TSPTour"/> with the given <paramref name="coordinates"/>
+    /// and the given <paramref name="tour"/>.
+    /// </summary>
+    /// <param name="coordinates">The coordinates of the TSP.</param>
+    /// <param name="tour">The tour the current instance should represent.</param>
     public TSPTour(DoubleMatrixData coordinates, Permutation.Permutation tour) {
       myCoordinates = coordinates;
@@ -48 +66 @@
     }
 
-
+    /// <summary>
+    /// Clones the current instance (deep clone).
+    /// </summary>
+    /// <remarks>Uses <see cref="Auxiliary.Clone"/> method of class <see cref="Auxiliary"/> to clone
+    /// the coordinates.</remarks>
+    /// <param name="clonedObjects">Dictionary of all already cloned objects. (Needed to avoid cycles.)</param>
+    /// <returns>The cloned object as <see cref="TSPTour"/>.</returns>
     public override object Clone(IDictionary<Guid, object> clonedObjects) {
       TSPTour clone = (TSPTour)base.Clone(clonedObjects);
@@ -56 +80 @@
     }
 
+    /// <summary>
+    /// Creates a new instance of <see cref="TSPTourView"/> to display the current instance.
+    /// </summary>
+    /// <returns>The created view as <see cref="TSPTourView"/>.</returns>
     public override IView CreateView() {
       return new TSPTourView(this);
     }
 
+    /// <summary>
+    /// Occurs when the coordinates of the current instance have been changed.
+    /// </summary>
     public event EventHandler CoordinatesChanged;
+    /// <summary>
+    /// Fires a new <c>CoordinatesChanged</c> event.
+    /// </summary>
     protected virtual void OnCoordinatesChanged() {
       if (CoordinatesChanged != null)
         CoordinatesChanged(this, new EventArgs());
     }
+    /// <summary>
+    /// Occurs when the tour of the current instance has been changed.
+    /// </summary>
     public event EventHandler TourChanged;
+    /// <summary>
+    /// Fires a new <c>TourChanged</c> event.
+    /// </summary>
     protected virtual void OnTourChanged() {
       if (TourChanged != null)
@@ -72 +112 @@
 
     #region Persistence Methods
+    /// <summary>
+    /// Saves the current instance as <see cref="XmlNode"/> in the specified <paramref name="document"/>.
+    /// </summary>
+    /// <remarks>Calls <see cref="StorableBase.GetXmlNode"/> of base class <see cref="ItemBase"/>. <br/>
+    /// The coordinates and the tour are saved as a child node with the tag names <c>Coordinates</c> and 
+    /// <c>Tour</c>.</remarks>
+    /// <param name="name">The (tag)name of the <see cref="XmlNode"/>.</param>
+    /// <param name="document">The <see cref="XmlDocument"/> where to save the data.</param>
+    /// <param name="persistedObjects">The 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);
@@ -78 +129 @@
       return node;
     }
+    /// <summary>
+    /// Loads the persisted TSP tour from the specified <paramref name="node"/>.
+    /// </summary>
+    /// <remarks>Calls <see cref="StorableBase.Populate"/> of base class 
+    /// <see cref="ItemBase"/>.<br/>
+    /// The coordinates and the tour must be saved as child nodes with the tag names <c>Coordinates</c>
+    /// and <c>Tour</c> (see <see cref="GetXmlNode"/>).</remarks>
+    /// <param name="node">The <see cref="XmlNode"/> where the TSP tour 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);