source: branches/HeuristicLab.Hive/sources/HeuristicLab.Hive/HeuristicLab.Hive.ExperimentManager/3.3/Jobs/OptimizerJob.cs @ 4760

#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.Collections.Generic;
using HeuristicLab.Common;
using HeuristicLab.Core;
using HeuristicLab.Hive.JobBase;
using HeuristicLab.Optimization;
using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;

namespace HeuristicLab.Hive.ExperimentManager.Jobs {
  [Item("Optimizer Job", "Represents Job which executes a IOptimizer object.")]
  [StorableClass]
  public class OptimizerJob : DeepCloneable, IJob {
    [Storable]
    protected IOptimizer optimizer;
    public IOptimizer Optimizer {
      get { return optimizer; }
      set {
        if (value != optimizer) {
          if (optimizer != null) DeregisterEvents();
          optimizer = value;
          if (optimizer != null) RegisterEvents();
          OnOptimizerChanged();
        }
      }
    }

    [Storable]
    protected ILog log;
    public ILog Log {
      get { return log; }
    }

    [Storable]
    protected bool computeInParallel;
    public bool ComputeInParallel {
      get { return computeInParallel; }
      set {
        if (computeInParallel != value) {
          computeInParallel = value;
          OnComputeInParallelChanged();
        }
      }
    }

    [Storable]
    private int indexInParentOptimizerList = -1;
    public int IndexInParentOptimizerList {
      get { return indexInParentOptimizerList; }
      set { this.indexInParentOptimizerList = value; }
    }


    [Storable]
    private bool collectChildJobs;
    public bool CollectChildJobs {
      get { return collectChildJobs; }
      set { collectChildJobs = value; }
    }

    public OptimizerJob() {
      this.log = new Log();
    }
    public OptimizerJob(IOptimizer optimizer)
      : this() {
      this.Optimizer = optimizer;

      if (optimizer is Optimization.Experiment) {
        this.ComputeInParallel = true;
      } else if (optimizer is Optimization.BatchRun) {
        this.ComputeInParallel = false;
      } else {
        this.ComputeInParallel = false;
      }
    }
    [StorableConstructor]
    protected OptimizerJob(bool deserializing) { }
    protected OptimizerJob(OptimizerJob original, Cloner cloner)
      : base(original, cloner) {
      this.Optimizer = cloner.Clone(original.Optimizer);
      this.log = cloner.Clone(original.Log);
      this.ComputeInParallel = original.ComputeInParallel;
      this.IndexInParentOptimizerList = original.IndexInParentOptimizerList;
      this.CollectChildJobs = original.CollectChildJobs;
      this.RegisterEvents();
    }
    public override IDeepCloneable Clone(Cloner cloner) {
      return new OptimizerJob(this, cloner);
    }
    public object Clone() {
      return Clone(new Cloner());
    }
    [StorableHook(HookType.AfterDeserialization)]
    protected virtual void AfterDeserialization() {
      RegisterEvents();
    }

    /// <summary>
    /// Casts the Optimizer to an Experiment. Returns null if cast was not successfull.
    /// </summary>
    public Optimization.Experiment OptimizerAsExperiment {
      get { return Optimizer as Optimization.Experiment; }
    }

    /// <summary>
    /// Casts the Optimizer to an BatchRun. Returns null if cast was not successfull.
    /// </summary>
    public Optimization.BatchRun OptimizerAsBatchRun {
      get { return Optimizer as Optimization.BatchRun; }
    }

    #region IJob Members

    public virtual ExecutionState ExecutionState {
      get { return optimizer.ExecutionState; }
    }

    public TimeSpan ExecutionTime {
      get { return optimizer.ExecutionTime; }
    }

    public virtual void Run() {
      throw new NotSupportedException();
    }

    public virtual void Prepare() {
      optimizer.Prepare();
    }

    public virtual void Start() {
      if ((optimizer is Optimization.Experiment && OptimizerAsExperiment.Optimizers.Count == 0) || // experiment would not fire OnStopped if it has 0 optimizers
          (optimizer is Optimization.BatchRun && OptimizerAsBatchRun.Algorithm == null)) { // batchrun would not fire OnStopped if algorithm == null
        OnJobStopped();
      } else {
        optimizer.Start();
      }
    }

    public virtual void Stop() {
      optimizer.Stop();
    }

    public virtual void Resume(IEnumerable<IJob> childJobs) {
      OnJobStopped();
    }

    public event EventHandler JobStopped;
    protected virtual void OnJobStopped() {
      EventHandler handler = JobStopped;
      if (handler != null) handler(this, EventArgs.Empty);
    }

    public event EventHandler JobFailed;
    protected virtual void OnJobFailed(EventArgs<Exception> e) {
      EventHandler handler = JobFailed;
      if (handler != null) handler(this, e);
    }

    public event EventHandler<EventArgs<IJob>> NewChildJob;
    protected virtual void OnNewChildJob(IJob job) {
      EventHandler<Common.EventArgs<IJob>> handler = NewChildJob;
      if (handler != null) handler(this, new EventArgs<IJob>(job));
    }

    public event EventHandler WaitForChildJobs;
    protected virtual void OnWaitForChildJobs() {
      EventHandler handler = WaitForChildJobs;
      if (handler != null) handler(this, EventArgs.Empty);
    }

    public event EventHandler DeleteChildJobs;
    protected virtual void OnDeleteChildJobs() {
      EventHandler handler = DeleteChildJobs;
      if (handler != null) handler(this, EventArgs.Empty);
    }

    public event EventHandler ComputeInParallelChanged;
    protected virtual void OnComputeInParallelChanged() {
      EventHandler handler = ComputeInParallelChanged;
      if (handler != null) handler(this, EventArgs.Empty);
    }

    public event EventHandler OptimizerChanged;
    protected virtual void OnOptimizerChanged() {
      EventHandler handler = OptimizerChanged;
      if (handler != null) handler(this, EventArgs.Empty);
    }
    #endregion

    #region Optimizer Events
    protected virtual void RegisterEvents() {
      optimizer.Stopped += new EventHandler(optimizer_Stopped);
      optimizer.ExceptionOccurred += new EventHandler<Common.EventArgs<Exception>>(optimizer_ExceptionOccurred);
      optimizer.DescriptionChanged += new EventHandler(optimizer_DescriptionChanged);
      optimizer.ItemImageChanged += new EventHandler(optimizer_ItemImageChanged);
      optimizer.NameChanged += new EventHandler(optimizer_NameChanged);
      optimizer.NameChanging += new EventHandler<CancelEventArgs<string>>(optimizer_NameChanging);
      optimizer.ToStringChanged += new EventHandler(optimizer_ToStringChanged);
    }
    protected virtual void DeregisterEvents() {
      optimizer.Stopped -= new EventHandler(optimizer_Stopped);
      optimizer.ExceptionOccurred -= new EventHandler<EventArgs<Exception>>(optimizer_ExceptionOccurred);
      optimizer.DescriptionChanged -= this.DescriptionChanged;
      optimizer.ItemImageChanged -= this.ItemImageChanged;
      optimizer.NameChanged -= this.NameChanged;
      optimizer.NameChanging -= this.NameChanging;
      optimizer.ToStringChanged -= this.ToStringChanged;
    }

    void optimizer_ToStringChanged(object sender, EventArgs e) {
      this.OnToStringChanged();
    }

    void optimizer_NameChanging(object sender, CancelEventArgs<string> e) {
      this.OnNameChanging(e.Value, e.Cancel);
    }

    void optimizer_NameChanged(object sender, EventArgs e) {
      this.OnNameChanged();
    }

    void optimizer_ItemImageChanged(object sender, EventArgs e) {
      this.OnItemImageChanged();
    }

    void optimizer_DescriptionChanged(object sender, EventArgs e) {
      this.OnDescriptionChanged();
    }

    protected virtual void optimizer_ExceptionOccurred(object sender, Common.EventArgs<Exception> e) {
      OnJobFailed(e);
    }

    protected virtual void optimizer_Stopped(object sender, EventArgs e) {
      OnJobStopped();
    }
    #endregion

    #region INamedItem Members

    public bool CanChangeDescription {
      get { return optimizer.CanChangeDescription; }
    }

    public bool CanChangeName {
      get { return optimizer.CanChangeName; }
    }

    public string Description {
      get { return optimizer.Description; }
      set { optimizer.Description = value; }
    }

    public string Name {
      get { return optimizer.Name; }
      set { optimizer.Name = value; }
    }
    #endregion

    #region Events
    public event EventHandler DescriptionChanged;
    protected virtual void OnDescriptionChanged() {
      var handler = DescriptionChanged;
      if (handler != null) handler(this, EventArgs.Empty);
    }
    public event EventHandler ItemImageChanged;
    protected virtual void OnItemImageChanged() {
      var handler = ItemImageChanged;
      if (handler != null) handler(this, EventArgs.Empty);
    }
    public event EventHandler ToStringChanged;
    protected virtual void OnToStringChanged() {
      var handler = ToStringChanged;
      if (handler != null) handler(this, EventArgs.Empty);
    }
    public event EventHandler NameChanged;
    protected virtual void OnNameChanged() {
      var handler = NameChanged;
      if (handler != null) handler(this, EventArgs.Empty);
    }
    public event EventHandler<CancelEventArgs<string>> NameChanging;
    protected virtual void OnNameChanging(string value, bool cancel) {
      var handler = NameChanging;
      if (handler != null) handler(this, new CancelEventArgs<string>(value, cancel));
    }
    #endregion

    #region IItem Members

    public string ItemDescription {
      get { return optimizer.ItemDescription; }
    }

    public System.Drawing.Image ItemImage {
      get { return optimizer.ItemImage; }
    }

    public string ItemName {
      get { return optimizer.ItemName; }
    }

    public Version ItemVersion {
      get { return optimizer.ItemVersion; }
    }

    #endregion

    /// <summary>
    /// Gets the string representation of the current instance in the format: <c>Name: [null|Value]</c>.
    /// </summary>
    /// <returns>The current instance as a string.</returns>
    public override string ToString() {
      return Name;
    }

    public virtual bool IsParallelizable {
      get { return this.Optimizer is Optimization.Experiment || this.Optimizer is BatchRun; }
    }

  }
}