Free cookie consent management tool by TermsFeed Policy Generator

Changeset 851


Ignore:
Timestamp:
11/28/08 11:41:03 (16 years ago)
Author:
vdorfer
Message:

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

Location:
trunk/sources/HeuristicLab.SequentialEngine
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • trunk/sources/HeuristicLab.SequentialEngine/HeuristicLabSequentialEnginePlugin.cs

    r582 r851  
    2626
    2727namespace HeuristicLab.SequentialEngine {
     28  /// <summary>
     29  /// Plugin class for HeuristicLab.SequentialEngine plugin.
     30  /// </summary>
    2831  [ClassInfo(Name = "HeuristicLab.SequentialEngine-3.2")]
    2932  [PluginFile(Filename = "HeuristicLab.SequentialEngine-3.2.dll", Filetype = PluginFileType.Assembly)]
  • trunk/sources/HeuristicLab.SequentialEngine/SequentialEngine.cs

    r2 r851  
    2727
    2828namespace HeuristicLab.SequentialEngine {
     29  /// <summary>
     30  /// Represents an engine that executes its steps sequentially, also if they could be executed
     31  /// in parallel.
     32  /// </summary>
    2933  public class SequentialEngine : EngineBase, IEditable {
    3034    private IOperator currentOperator;
    3135
     36    /// <summary>
     37    /// Creates a new instance of <see cref="SequentialEngineEditor"/>.
     38    /// </summary>
     39    /// <returns>The created view as <see cref="SequentialEngineEditor"/>.</returns>
    3240    public override IView CreateView() {
    3341      return new SequentialEngineEditor(this);
    3442    }
     43
     44    /// <summary>
     45    /// Creates a new instance of <see cref="SequentialEngineEditor"/>.
     46    /// </summary>
     47    /// <returns>The created editor as <see cref="SequentialEngineEditor"/>.</returns>
    3548    public virtual IEditor CreateEditor() {
    3649      return new SequentialEngineEditor(this);
    3750    }
    3851
     52    /// <summary>
     53    /// Aborts the current operator.
     54    /// </summary>
     55    /// <remarks>Calls <see cref="EngineBase.Abort"/> of base class <see cref="EngineBase"/> and
     56    /// <see cref="IOperator.Abort"/> of the current <see cref="IOperator"/>.</remarks>
    3957    public override void Abort() {
    4058      base.Abort();
     
    4361    }
    4462
     63    /// <summary>
     64    /// Deals with the next operation, if it is an <see cref="AtomicOperation"/> it is executed,
     65    /// if it is a <see cref="CompositeOperation"/> its single operations are pushed on the execution stack.
     66    /// </summary>
     67    /// <remarks>If an error occurs during the execution the operation is aborted and the operation
     68    /// is pushed on the stack again.<br/>
     69    /// If the execution was successful <see cref="EngineBase.OnOperationExecuted"/> is called.</remarks>
    4570    protected override void ProcessNextOperation() {
    4671      IOperation operation = myExecutionStack.Pop();
  • trunk/sources/HeuristicLab.SequentialEngine/SequentialEngineEditor.cs

    r2 r851  
    3030
    3131namespace HeuristicLab.SequentialEngine {
     32  /// <summary>
     33  /// Visual representation of a <see cref="SequentialEngine"/>.
     34  /// </summary>
    3235  public partial class SequentialEngineEditor : EngineBaseEditor {
     36    /// <summary>
     37    /// Gets or set the engine to represent visually.
     38    /// </summary>
     39    /// <remarks>Uses property <see cref="EngineBaseEditor.Engine"/> of base class
     40    /// <see cref="EngineBaseEditor"/>. No own data storage present.</remarks>
    3341    public SequentialEngine SequentialEngine {
    3442      get { return (SequentialEngine)Engine; }
     
    3644    }
    3745
     46    /// <summary>
     47    /// Initializes a new instance of <see cref="SequentialEngineEditor"/>.
     48    /// </summary>
    3849    public SequentialEngineEditor() {
    3950      InitializeComponent();
    4051    }
     52    /// <summary>
     53    /// Initializes a new instance of <see cref="SequentialEngineEditor"/> with the given
     54    /// <paramref name="sequentialEngine"/>.
     55    /// </summary>
     56    /// <param name="sequentialEngine">The engine to display.</param>
    4157    public SequentialEngineEditor(SequentialEngine sequentialEngine)
    4258      : this() {
Note: See TracChangeset for help on using the changeset viewer.