Changeset 5178 for branches/ParallelEngine/HeuristicLab.Core/3.3/Interfaces/IOperator.cs

Timestamp:

12/28/10 01:44:33 (14 years ago)

Author:

swagner

Message:

Revoked changes of r5177 (#1333)

File:

• branches/ParallelEngine/HeuristicLab.Core/3.3/Interfaces/IOperator.cs (modified) (1 diff)

branches/ParallelEngine/HeuristicLab.Core/3.3/Interfaces/IOperator.cs

@@ -23 +23 @@
 
 namespace HeuristicLab.Core {
+  /// <summary>
+  /// Interface to represent an operator (e.g. GreaterThanComparator,...), 
+  /// a basic instruction of an algorithm.
+  /// </summary>
   public interface IOperator : IParameterizedNamedItem {
+    /// <summary>
+    /// Gets or sets a boolean value whether the engine should stop here during the run.
+    /// </summary>
     bool Breakpoint { get; set; }
 
+    /// <summary>
+    /// Executes the current instance on the specified <paramref name="scope"/>.
+    /// </summary>
+    /// <param name="scope">The scope where to execute the current instance.</param>
+    /// <returns>The next operation.</returns>
     IOperation Execute(IExecutionContext context);
+    /// <summary>
+    /// Aborts the current operator.
+    /// </summary>
     void Abort();
 
+    /// <summary>
+    /// Occurs when the breakpoint flag of the current instance was changed.
+    /// </summary>
     event EventHandler BreakpointChanged; 
+    /// <summary>
+    /// Occurs when the current instance is executed.
+    /// </summary>
     event EventHandler Executed;
   }