source: addons/HeuristicLab.FitnessLandscapeAnalysis/HeuristicLab.Analysis.FitnessLandscape/MultiTrajectory/PreassignedSolutionCreator.cs @ 16573

using HeuristicLab.Common;
using HeuristicLab.Core;
using HeuristicLab.Data;
using HeuristicLab.Operators;
using HeuristicLab.Optimization;
using HeuristicLab.Parameters;
using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
using HEAL.Attic;

namespace HeuristicLab.Analysis.FitnessLandscape.MultiTrajectory {

  [StorableType("1F8136F9-FBED-40F7-ACA3-E3D05F623A28")]
  public abstract class PreassignedSolutionCreator : SingleSuccessorOperator, ISolutionCreator {

    #region Parameters
    public ValueParameter<IScope> SolutionCollectionParameter {
      get { return (ValueParameter<IScope>)Parameters["SolutionCollection"]; }
    }
    public ValueParameter<IntValue> CurrentSolutionIndexParameter {
      get { return (ValueParameter<IntValue>)Parameters["CurrentSolutionIndex"]; }
    }
    public ValueParameter<ISolutionCreator> OriginalSolutionCreatorParameter {
      get { return (ValueParameter<ISolutionCreator>)Parameters["OriginalSolutionCreator"]; }
    }
    #endregion

    #region Parameter Values
    public IScope SolutionCollection {
      get { return SolutionCollectionParameter.Value; }
      set { SolutionCollectionParameter.Value = value; }
    }
    public int CurrentSolutionIndex {
      get { return CurrentSolutionIndexParameter.Value.Value; }
      set { CurrentSolutionIndexParameter.Value = new IntValue(value); }
    }
    public ISolutionCreator OriginalSolutionCreator {
      get { return OriginalSolutionCreatorParameter.Value; }
      set { OriginalSolutionCreatorParameter.Value = value; }
    }
    #endregion

    [StorableConstructor]
    protected PreassignedSolutionCreator(StorableConstructorFlag _) : base(_) { }

    protected PreassignedSolutionCreator(PreassignedSolutionCreator original, Cloner cloner)
      : base(original, cloner) {
    }

    public PreassignedSolutionCreator() {
      Parameters.Add(new ValueParameter<IScope>("SolutionCollection", "Scope with subscopes that contains the list of solutions."));
      Parameters.Add(new ValueParameter<IntValue>("CurrentSolutionIndex", "Index of currently created solution."));
      Parameters.Add(new ValueParameter<ISolutionCreator>("OriginalSolutionCreator", "Original solution creator used for a certain problem."));
    }

    public abstract void Create(IScope scope);

    public sealed override IOperation Apply() {
      if (CurrentSolutionIndex < 0 && OriginalSolutionCreator != null) {
        OperationCollection collection = new OperationCollection();
        collection.Add(ExecutionContext.CreateOperation(OriginalSolutionCreator));
        collection.Add(base.Apply());
        return collection;
      } else {
        Create(SolutionCollection.SubScopes[CurrentSolutionIndex]);
        CurrentSolutionIndex = (CurrentSolutionIndex+1) % SolutionCollection.SubScopes.Count;
        return base.Apply();
      }
    }

  }
}