Changeset 1176 for trunk/sources/HeuristicLab.Constraints/SubOperatorsTypeConstraint.cs

Timestamp:

01/27/09 09:31:06 (15 years ago)

Author:

vdorfer

Message:

Created API documentation for HeuristicLab.BitVector and HeuristicLab.Constraints namespace and changed a comment in HeuristicLab.IntVector namespace(#331)

File:

• trunk/sources/HeuristicLab.Constraints/SubOperatorsTypeConstraint.cs (modified) (11 diffs)

trunk/sources/HeuristicLab.Constraints/SubOperatorsTypeConstraint.cs

@@ -29 +29 @@
 
 namespace HeuristicLab.Constraints {
+  /// <summary>
+  /// Constraint where the sub-operator at a specific index has to be an element of a pre-defined group.
+  /// </summary>
   public class SubOperatorTypeConstraint : ConstraintBase {
     private IntData subOperatorIndex;
+    /// <summary>
+    /// Gets the index of the sub-operator.
+    /// </summary>
     public IntData SubOperatorIndex {
       get { return subOperatorIndex; }
@@ -36 +42 @@
 
     private List<IOperator> subOperators;
+    /// <summary>
+    /// Gets all allowed sub-operators.
+    /// </summary>
     public IList<IOperator> AllowedSubOperators {
       get {
@@ -42 +51 @@
     }
 
+    ///<inheritdoc select="summary"/>
     public override string Description {
       get { return "The sub-operator at a specific index has to be an element of a pre-defined group."; }
     }
 
+    /// <summary>
+    /// Initializes a new instance of <see cref="SubOperatorTypeConstraint"/>.
+    /// </summary>
     public SubOperatorTypeConstraint()
       : base() {
@@ -52 +65 @@
     }
 
+    /// <summary>
+    /// Initializes a new instance of <see cref="SubOperatorTypeConstraint"/> with the given
+    /// <paramref name="index"/>.
+    /// </summary>
+    /// <param name="index">The index of the sub-operator.</param>
     public SubOperatorTypeConstraint(int index) : base() {
       subOperatorIndex = new IntData(index);
@@ -57 +75 @@
     }
 
+    /// <summary>
+    /// Adds the given operator to the list of sub-operators.
+    /// </summary>
+    /// <remarks>Calls <see cref="ItemBase.FireChanged"/> of base class <see cref="ConstraintBase"/>.</remarks>
+    /// <param name="op">The operator to add.</param>
     public void AddOperator(IOperator op) {
       if(!subOperators.Contains(op)) {
@@ -64 +87 @@
     }
 
+    /// <summary>
+    /// Removes the given operator from the list of sub-operators.
+    /// </summary>
+    /// <remarks>Calls <see cref="ItemBase.FireChanged"/> of base class <see cref="ConstraintBase"/>.</remarks>
+    /// <param name="op">The operator to remove.</param>
     public void RemoveOperator(IOperator op) {
       if(subOperators.Contains(op)) {
@@ -71 +99 @@
     }
 
+    /// <summary>
+    /// Empties the list of sub-operators.
+    /// </summary>
     public void Clear() {
       subOperators.Clear();
     }
 
+    /// <summary>
+    /// Checks whether the given element fulfills the current constraint.
+    /// </summary>
+    /// <param name="data">The item to check.</param>
+    /// <returns><c>true</c> if the constraint could be fulfilled, <c>false</c> otherwise.</returns>
     public override bool Check(IItem data) {
       IOperator op = data as IOperator;
@@ -85 +121 @@
     }
 
+    /// <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 clone objects. (Needed to avoid cycles.)</param>
+    /// <returns>The cloned object as <see cref="SubOperatorTypeConstraint"/>.</returns>
     public override object Clone(IDictionary<Guid, object> clonedObjects) {
       SubOperatorTypeConstraint clone = new SubOperatorTypeConstraint();
@@ -95 +138 @@
     }
 
+    /// <summary>
+    /// Creates a new instance of <see cref="SubOperatorsTypeConstraintView"/> to represent the current 
+    /// instance visually.
+    /// </summary>
+    /// <returns>The created view as <see cref="SubOperatorsTypeConstraintView"/>.</returns>
     public override IView CreateView() {
       return new SubOperatorsTypeConstraintView(this);
@@ -100 +148 @@
 
     #region persistence
+    /// <summary>
+    /// Saves the current instance as <see cref="XmlNode"/> in the specified <paramref name="document"/>.
+    /// </summary>
+    /// <remarks>The index and the list of sub-operators are saved as child nodes with tag names 
+    /// <c>SubOperatorIndex</c> and <c>AllowedSubOperators</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">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);
@@ -113 +171 @@
     }
 
+    /// <summary>
+    /// Loads the persisted constraint from the specified <paramref name="node"/>.
+    /// </summary>
+    /// <remarks>The constraint must be saved in a specific way, see <see cref="GetXmlNode"/> for 
+    /// more information.</remarks>
+    /// <param name="node">The <see cref="XmlNode"/> where the instance 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);