Changeset 776 for trunk/sources/HeuristicLab.Core/OperatorGraph.cs

Timestamp:

11/19/08 12:12:39 (15 years ago)

Author:

vdorfer

Message:

Created API documentation for HeuristicLab.Core namespace (#331)

File:

• trunk/sources/HeuristicLab.Core/OperatorGraph.cs (modified) (9 diffs)

trunk/sources/HeuristicLab.Core/OperatorGraph.cs

@@ -26 +26 @@
 
 namespace HeuristicLab.Core {
+  /// <summary>
+  /// Represents a graph of operators.
+  /// </summary>
   public class OperatorGraph : ItemBase, IOperatorGraph {
     private IDictionary<Guid, IOperator> myOperators;
+    /// <summary>
+    /// Gets all operators of the current instance.
+    /// </summary>
     public ICollection<IOperator> Operators {
       get { return myOperators.Values; }
     }
     private IOperator myInitialOperator;
+    /// <summary>
+    /// Gets or sets the initial operator (the starting one).
+    /// </summary>
+    /// <remarks>Calls <see cref="OnInitialOperatorChanged"/> in the setter.</remarks>
     public IOperator InitialOperator {
       get { return myInitialOperator; }
@@ -42 +52 @@
     }
 
+    /// <summary>
+    /// Initializes a new instance of <see cref="OperatorGraph"/>.
+    /// </summary>
     public OperatorGraph() {
       myOperators = new Dictionary<Guid, IOperator>();
     }
 
+    /// <summary>
+    /// Creates a new instance of <see cref="OperatorGraphView"/> to represent the current instance
+    /// visually.
+    /// </summary>
+    /// <returns>The created view as <see cref="OperatorGraphView"/>.</returns>
     public override IView CreateView() {
       return new OperatorGraphView(this);
     }
 
+    /// <summary>
+    /// Clones the current instance (deep clone).
+    /// </summary>
+    /// <remarks>Deep clone through <see cref="Auxiliary.Clone"/> method of helper class 
+    /// <see cref="Auxiliary"/>.</remarks>
+    /// <param name="clonedObjects">Dictionary of all already cloned objects. (Needed to avoid cycles.)</param>
+    /// <returns>The cloned object as <see cref="OperatorGraph"/>.</returns>
     public override object Clone(IDictionary<Guid, object> clonedObjects) {
       OperatorGraph clone = new OperatorGraph();
@@ -60 +85 @@
     }
 
+    /// <inheritdoc/>
+    /// <remarks>Calls <see cref="OnOperatorAdded"/>.</remarks>
     public void AddOperator(IOperator op) {
       if (!myOperators.ContainsKey(op.Guid)) {
@@ -69 +96 @@
       }
     }
+    /// <inheritdoc/>
+    /// <remarks>Calls <see cref="OnOperatorRemoved"/>.</remarks>
     public void RemoveOperator(Guid guid) {
       IOperator op = GetOperator(guid);
@@ -87 +116 @@
       }
     }
+    /// <inheritdoc/>
     public IOperator GetOperator(Guid guid) {
       IOperator op;
@@ -94 +124 @@
         return null;
     }
+    /// <inheritdoc/>
     public void Clear() {
       Guid[] guids = new Guid[Operators.Count];
@@ -105 +136 @@
     }
 
+    /// <inheritdoc/>
     public event EventHandler<OperatorEventArgs> OperatorAdded;
+    /// <summary>
+    /// Fires a new <c>OperatorAdded</c> event.
+    /// </summary>
+    /// <param name="op">The operator that has been added.</param>
     protected virtual void OnOperatorAdded(IOperator op) {
       if (OperatorAdded != null)
         OperatorAdded(this, new OperatorEventArgs(op));
     }
+    /// <inheritdoc/>
     public event EventHandler<OperatorEventArgs> OperatorRemoved;
+    /// <summary>
+    /// Fires a new <c>OperatorRemoved</c> event.
+    /// </summary>
+    /// <param name="op">The operator that has been removed.</param>
     protected virtual void OnOperatorRemoved(IOperator op) {
       if (OperatorRemoved != null)
         OperatorRemoved(this, new OperatorEventArgs(op));
     }
+    /// <inheritdoc/>
     public event EventHandler InitialOperatorChanged;
+    /// <summary>
+    /// Fires a new <c>InitialOperatorChanged</c> event.
+    /// </summary>
     protected virtual void OnInitialOperatorChanged() {
       if (InitialOperatorChanged != null)
@@ -122 +167 @@
 
     #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/>
+    /// To save the operators of the current instance a child node is created with the tag name 
+    /// <c>Operators</c>. Beyond this child node all operators are saved as child nodes themselves.<br/>
+    /// The initial operator is saved as child node with the tag name <c>InitialOperator</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);
@@ -132 +189 @@
       return node;
     }
+    /// <summary>
+    /// Loads the persisted operator graph from the specified <paramref name="node"/>.
+    /// </summary>
+    /// <remarks>See <see cref="GetXmlNode"/> to get more information about how the graph must be saved. <br/>
+    /// Calls <see cref="StorableBase.Populate"/> of base class <see cref="ItemBase"/>.</remarks>
+    /// <param name="node">The <see cref="XmlNode"/> where the operator graph is saved.</param>
+    /// <param name="restoredObjects">The 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);