source: trunk/sources/HeuristicLab.Optimization/3.3/Algorithm.cs @ 2882

#region License Information
/* HeuristicLab
 * Copyright (C) 2002-2010 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
 *
 * This file is part of HeuristicLab.
 *
 * HeuristicLab is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * HeuristicLab is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
 */
#endregion

using System;
using System.Drawing;
using HeuristicLab.Collections;
using HeuristicLab.Common;
using HeuristicLab.Core;
using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;

namespace HeuristicLab.Optimization {
  /// <summary>
  /// A base class for algorithms.
  /// </summary>
  [Item("Algorithm", "A base class for algorithms.")]
  public abstract class Algorithm : ParameterizedNamedItem, IAlgorithm {
    public override Image ItemImage {
      get { return HeuristicLab.Common.Resources.VS2008ImageLibrary.Event; }
    }

    public virtual Type ProblemType {
      get { return typeof(IProblem); }
    }

    private IProblem problem;
    [Storable]
    public IProblem Problem {
      get { return problem; }
      set {
        if (problem != value) {
          if ((value != null) && !ProblemType.IsInstanceOfType(value)) throw new ArgumentException("Invalid problem type.");
          if (problem != null) DeregisterProblemEvents();
          problem = value;
          if (problem != null) RegisterProblemEvents();
          OnProblemChanged();
          Prepare();
        }
      }
    }

    public abstract IObservableKeyedCollection<string, IVariable> Results { get; }

    public abstract TimeSpan ExecutionTime { get; }

    private bool running;
    public bool Running {
      get { return running; }
    }

    public abstract bool Finished { get; }

    private bool canceled;
    protected bool Canceled {
      get { return canceled; }
      private set {
        if (canceled != value) {
          canceled = value;
          OnCanceledChanged();
        }
      }
    }

    protected Algorithm() : base() { }
    protected Algorithm(string name) : base(name) { }
    protected Algorithm(string name, ParameterCollection parameters) : base(name, parameters) { }
    protected Algorithm(string name, string description) : base(name, description) { }
    protected Algorithm(string name, string description, ParameterCollection parameters) : base(name, description, parameters) { }

    public override IDeepCloneable Clone(Cloner cloner) {
      Algorithm clone = (Algorithm)base.Clone(cloner);
      clone.Problem = (IProblem)cloner.Clone(problem);
      clone.running = running;
      clone.Canceled = canceled;
      return clone;
    }

    public void Prepare() {
      running = false;
      Canceled = false;
      OnPrepared();
    }
    public void Start() {
      running = true;
      Canceled = false;
      OnStarted();
    }
    public void Stop() {
      Canceled = true;
    }

    #region Events
    public event EventHandler ProblemChanged;
    protected virtual void OnProblemChanged() {
      if (ProblemChanged != null)
        ProblemChanged(this, EventArgs.Empty);
      OnChanged();
    }
    public event EventHandler ExecutionTimeChanged;
    protected virtual void OnExecutionTimeChanged() {
      if (ExecutionTimeChanged != null)
        ExecutionTimeChanged(this, EventArgs.Empty);
      OnChanged();
    }
    public event EventHandler Prepared;
    protected virtual void OnPrepared() {
      if (Prepared != null)
        Prepared(this, EventArgs.Empty);
      OnChanged();
    }
    public event EventHandler Started;
    protected virtual void OnStarted() {
      if (Started != null)
        Started(this, EventArgs.Empty);
      OnChanged();
    }
    public event EventHandler Stopped;
    protected virtual void OnStopped() {
      if (Stopped != null)
        Stopped(this, EventArgs.Empty);
      OnChanged();
    }
    protected virtual void OnCanceledChanged() { }
    public event EventHandler<EventArgs<Exception>> ExceptionOccurred;
    protected virtual void OnExceptionOccurred(Exception exception) {
      if (ExceptionOccurred != null)
        ExceptionOccurred(this, new EventArgs<Exception>(exception));
    }
    protected virtual void DeregisterProblemEvents() {
      problem.SolutionCreatorChanged -= new EventHandler(Problem_SolutionCreatorChanged);
      problem.EvaluatorChanged -= new EventHandler(Problem_EvaluatorChanged);
      problem.Changed -= new ChangedEventHandler(Problem_Changed);
    }
    protected virtual void RegisterProblemEvents() {
      problem.SolutionCreatorChanged += new EventHandler(Problem_SolutionCreatorChanged);
      problem.EvaluatorChanged += new EventHandler(Problem_EvaluatorChanged);
      problem.Changed += new ChangedEventHandler(Problem_Changed);
    }

    protected virtual void Problem_SolutionCreatorChanged(object sender, EventArgs e) { }
    protected virtual void Problem_EvaluatorChanged(object sender, EventArgs e) { }
    private void Problem_Changed(object sender, ChangedEventArgs e) {
      OnChanged(e);
    }
    #endregion
  }
}