Changeset 776 for trunk/sources/HeuristicLab.Core/Interfaces/IEngine.cs

Timestamp:

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

Author:

vdorfer

Message:

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

File:

• trunk/sources/HeuristicLab.Core/Interfaces/IEngine.cs (modified) (1 diff)

trunk/sources/HeuristicLab.Core/Interfaces/IEngine.cs

@@ -25 +25 @@
 
 namespace HeuristicLab.Core {
+  /// <summary>
+  /// Interface to represent one run. (An engine is an interpreter, holding the code, 
+  /// the data and the actual state, which is the runtime stack and a pointer onto the next operation.).
+  /// It is responsible for operator execution and able to deal with parallelism.
+  /// </summary>
   public interface IEngine : IItem {
+    /// <summary>
+    /// Gets the operator graph of the current instance.
+    /// </summary>
     IOperatorGraph OperatorGraph { get; }
+    /// <summary>
+    /// Gets the global scope of the current instance.
+    /// </summary>
     IScope GlobalScope { get; }
 
+    /// <summary>
+    /// Gets the execution time of the current instance.
+    /// </summary>
     TimeSpan ExecutionTime { get; }
 
+    /// <summary>
+    /// Gets information whether the engine is currently running.
+    /// </summary>
     bool Running { get; }
+    /// <summary>
+    /// Gets information whether the engine is canceled.
+    /// </summary>
     bool Canceled { get; }
+    /// <summary>
+    /// Gets information whether the engine has already terminated.
+    /// </summary>
     bool Terminated { get; }
 
+    /// <summary>
+    /// Executes the whole run.
+    /// </summary>
     void Execute();
+    /// <summary>
+    /// Executes one step (one operation).
+    /// </summary>
     void ExecuteStep();
+    /// <summary>
+    /// Executes the given number of steps.
+    /// </summary>
+    /// <param name="steps">The number of steps to execute.</param>
     void ExecuteSteps(int steps);
+    /// <summary>
+    /// Aborts the engine run.
+    /// </summary>
     void Abort();
+    /// <summary>
+    /// Resets the current instance.
+    /// </summary>
     void Reset();
 
+    /// <summary>
+    /// Occurs when the current instance is initialized.
+    /// </summary>
     event EventHandler Initialized;
+    /// <summary>
+    /// Occurs when an operation is executed.
+    /// </summary>
     event EventHandler<OperationEventArgs> OperationExecuted;
+    /// <summary>
+    /// Occurs when an exception was thrown.
+    /// </summary>
     event EventHandler<ExceptionEventArgs> ExceptionOccurred;
+    /// <summary>
+    /// Occurs when the execution time was changed.
+    /// </summary>
     event EventHandler ExecutionTimeChanged;
+    /// <summary>
+    /// Occurs when the engine is finished.
+    /// </summary>
     event EventHandler Finished;
   }