[2] | 1 | #region License Information
|
---|
| 2 | /* HeuristicLab
|
---|
[2790] | 3 | * Copyright (C) 2002-2010 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
|
---|
[2] | 4 | *
|
---|
| 5 | * This file is part of HeuristicLab.
|
---|
| 6 | *
|
---|
| 7 | * HeuristicLab is free software: you can redistribute it and/or modify
|
---|
| 8 | * it under the terms of the GNU General Public License as published by
|
---|
| 9 | * the Free Software Foundation, either version 3 of the License, or
|
---|
| 10 | * (at your option) any later version.
|
---|
| 11 | *
|
---|
| 12 | * HeuristicLab is distributed in the hope that it will be useful,
|
---|
| 13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
|
---|
| 14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
---|
| 15 | * GNU General Public License for more details.
|
---|
| 16 | *
|
---|
| 17 | * You should have received a copy of the GNU General Public License
|
---|
| 18 | * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
|
---|
| 19 | */
|
---|
| 20 | #endregion
|
---|
| 21 |
|
---|
| 22 | using System;
|
---|
| 23 | using System.Collections.Generic;
|
---|
| 24 | using System.Text;
|
---|
| 25 | using System.Xml;
|
---|
[2653] | 26 | using System.Linq;
|
---|
[1823] | 27 | using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
|
---|
[2474] | 28 | using HeuristicLab.Common;
|
---|
[2653] | 29 | using HeuristicLab.Collections;
|
---|
[2] | 30 |
|
---|
| 31 | namespace HeuristicLab.Core {
|
---|
[776] | 32 | /// <summary>
|
---|
| 33 | /// Represents a graph of operators.
|
---|
| 34 | /// </summary>
|
---|
[3160] | 35 | [Item("Operator Graph", "Represents a graph of operators.")]
|
---|
| 36 | [Creatable("Algorithm Design")]
|
---|
[3017] | 37 | [StorableClass]
|
---|
[2664] | 38 | public class OperatorGraph : Item {
|
---|
[3317] | 39 | [Storable]
|
---|
[2653] | 40 | private OperatorSet operators;
|
---|
[776] | 41 | /// <summary>
|
---|
| 42 | /// Gets all operators of the current instance.
|
---|
| 43 | /// </summary>
|
---|
[2653] | 44 | public OperatorSet Operators {
|
---|
| 45 | get { return operators; }
|
---|
[2] | 46 | }
|
---|
[1667] | 47 |
|
---|
| 48 | [Storable]
|
---|
[2653] | 49 | private IOperator initialOperator;
|
---|
[776] | 50 | /// <summary>
|
---|
| 51 | /// Gets or sets the initial operator (the starting one).
|
---|
| 52 | /// </summary>
|
---|
| 53 | /// <remarks>Calls <see cref="OnInitialOperatorChanged"/> in the setter.</remarks>
|
---|
[2] | 54 | public IOperator InitialOperator {
|
---|
[2653] | 55 | get { return initialOperator; }
|
---|
[2] | 56 | set {
|
---|
[2653] | 57 | if (initialOperator != value) {
|
---|
| 58 | if (value != null) Operators.Add(value);
|
---|
| 59 | initialOperator = value;
|
---|
[2] | 60 | OnInitialOperatorChanged();
|
---|
| 61 | }
|
---|
| 62 | }
|
---|
| 63 | }
|
---|
| 64 |
|
---|
[2853] | 65 | [Storable]
|
---|
| 66 | private IDeepCloneable visualizationInfo;
|
---|
[776] | 67 | /// <summary>
|
---|
[2853] | 68 | /// Gets or sets the visualizationInfo.
|
---|
| 69 | /// </summary>
|
---|
| 70 | /// /// <remarks>The VisualizationInfo can only be set once and fires afterwards and InvalidOperationException</remarks>
|
---|
| 71 | public IDeepCloneable VisualizationInfo {
|
---|
| 72 | get { return visualizationInfo; }
|
---|
| 73 | set {
|
---|
| 74 | if (visualizationInfo != null)
|
---|
| 75 | throw new InvalidOperationException("The value of the property VisualizationInfo is already set and cannot be set again.");
|
---|
| 76 | visualizationInfo = value;
|
---|
| 77 | }
|
---|
| 78 | }
|
---|
| 79 |
|
---|
| 80 | /// <summary>
|
---|
[776] | 81 | /// Initializes a new instance of <see cref="OperatorGraph"/>.
|
---|
| 82 | /// </summary>
|
---|
[2] | 83 | public OperatorGraph() {
|
---|
[3317] | 84 | operators = new OperatorSet();
|
---|
[2653] | 85 | initialOperator = null;
|
---|
[2853] | 86 | visualizationInfo = null;
|
---|
[3317] | 87 | Initialize();
|
---|
[2] | 88 | }
|
---|
[3317] | 89 | [StorableConstructor]
|
---|
| 90 | protected OperatorGraph(bool deserializing) : base(deserializing) { }
|
---|
[2] | 91 |
|
---|
[3407] | 92 | //mkommend: IMPORTANT DO NOT REMOVE THIS PRIVATE EVENT
|
---|
[3386] | 93 | //needed to register OperatorGraph events in GraphVisualizationInfo
|
---|
| 94 | public event EventHandler DeserializationFinished;
|
---|
| 95 | private void OnOperatorGraphDeserializationFinished() {
|
---|
| 96 | EventHandler handler = DeserializationFinished;
|
---|
| 97 | if(handler != null)
|
---|
| 98 | handler(this,EventArgs.Empty);
|
---|
| 99 | }
|
---|
[3317] | 100 | [StorableHook(HookType.AfterDeserialization)]
|
---|
| 101 | private void Initialize() {
|
---|
| 102 | RegisterOperatorsEvents();
|
---|
[3386] | 103 | OnOperatorGraphDeserializationFinished();
|
---|
[3317] | 104 | }
|
---|
| 105 |
|
---|
[776] | 106 | /// <summary>
|
---|
| 107 | /// Clones the current instance (deep clone).
|
---|
| 108 | /// </summary>
|
---|
[2526] | 109 | /// <remarks>Deep clone through <see cref="cloner.Clone"/> method of helper class
|
---|
[776] | 110 | /// <see cref="Auxiliary"/>.</remarks>
|
---|
| 111 | /// <param name="clonedObjects">Dictionary of all already cloned objects. (Needed to avoid cycles.)</param>
|
---|
| 112 | /// <returns>The cloned object as <see cref="OperatorGraph"/>.</returns>
|
---|
[2653] | 113 | public override IDeepCloneable Clone(Cloner cloner) {
|
---|
[3317] | 114 | OperatorGraph clone = (OperatorGraph)base.Clone(cloner);
|
---|
| 115 | clone.operators = (OperatorSet)cloner.Clone(operators);
|
---|
[2653] | 116 | clone.initialOperator = (IOperator)cloner.Clone(initialOperator);
|
---|
[2968] | 117 | clone.visualizationInfo = cloner.Clone(visualizationInfo);
|
---|
[3317] | 118 | clone.Initialize();
|
---|
[2] | 119 | return clone;
|
---|
| 120 | }
|
---|
| 121 |
|
---|
[776] | 122 | /// <inheritdoc/>
|
---|
[2653] | 123 | public event EventHandler InitialOperatorChanged;
|
---|
| 124 | /// <summary>
|
---|
| 125 | /// Fires a new <c>InitialOperatorChanged</c> event.
|
---|
| 126 | /// </summary>
|
---|
| 127 | protected virtual void OnInitialOperatorChanged() {
|
---|
| 128 | if (InitialOperatorChanged != null)
|
---|
[2793] | 129 | InitialOperatorChanged(this, EventArgs.Empty);
|
---|
[2653] | 130 | }
|
---|
[2] | 131 |
|
---|
[2653] | 132 | #region Operators Events
|
---|
| 133 | private void AddOperator(IOperator op) {
|
---|
| 134 | RegisterOperatorEvents(op);
|
---|
| 135 | foreach (IParameter param in op.Parameters)
|
---|
| 136 | AddParameter(param);
|
---|
| 137 | }
|
---|
| 138 | private void RemoveOperator(IOperator op) {
|
---|
| 139 | foreach (IParameter param in op.Parameters)
|
---|
| 140 | RemoveParameter(param);
|
---|
| 141 | DeregisterOperatorEvents(op);
|
---|
| 142 |
|
---|
| 143 | // remove edges to removed operator
|
---|
[3729] | 144 | IValueParameter[] opParams = (from o in Operators
|
---|
| 145 | from p in o.Parameters
|
---|
| 146 | where p is IValueParameter
|
---|
| 147 | where typeof(IOperator).IsAssignableFrom(((IValueParameter)p).DataType)
|
---|
| 148 | where (((IValueParameter)p).Value != null) && (((IValueParameter)p).Value == op)
|
---|
| 149 | select (IValueParameter)p).ToArray();
|
---|
[3407] | 150 | foreach (IValueParameter opParam in opParams)
|
---|
[2653] | 151 | opParam.Value = null;
|
---|
| 152 | }
|
---|
| 153 | private void AddParameter(IParameter param) {
|
---|
[3407] | 154 | IValueParameter valueParam = param as IValueParameter;
|
---|
| 155 | if ((valueParam != null) && (typeof(IOperator).IsAssignableFrom(valueParam.DataType))) {
|
---|
| 156 | RegisterOperatorParameterEvents(valueParam);
|
---|
| 157 | if (valueParam.Value != null) Operators.Add((IOperator)valueParam.Value);
|
---|
[2] | 158 | }
|
---|
| 159 | }
|
---|
[2653] | 160 | private void RemoveParameter(IParameter param) {
|
---|
[3407] | 161 | IValueParameter valueParam = param as IValueParameter;
|
---|
| 162 | if ((valueParam != null) && (typeof(IOperator).IsAssignableFrom(valueParam.DataType))) {
|
---|
| 163 | DeregisterOperatorParameterEvents(valueParam);
|
---|
[2] | 164 | }
|
---|
| 165 | }
|
---|
[2653] | 166 |
|
---|
| 167 | private void RegisterOperatorsEvents() {
|
---|
| 168 | if (operators != null) {
|
---|
| 169 | operators.ItemsAdded += new CollectionItemsChangedEventHandler<IOperator>(Operators_ItemsAdded);
|
---|
| 170 | operators.ItemsRemoved += new CollectionItemsChangedEventHandler<IOperator>(Operators_ItemsRemoved);
|
---|
| 171 | operators.CollectionReset += new CollectionItemsChangedEventHandler<IOperator>(Operators_CollectionReset);
|
---|
[2790] | 172 | foreach (IOperator op in operators) {
|
---|
| 173 | RegisterOperatorEvents(op);
|
---|
[3407] | 174 | var opParams = from p in op.Parameters
|
---|
| 175 | where p is IValueParameter
|
---|
| 176 | where typeof(IOperator).IsAssignableFrom(((IValueParameter)p).DataType)
|
---|
| 177 | select (IValueParameter)p;
|
---|
| 178 | foreach (IValueParameter opParam in opParams)
|
---|
| 179 | RegisterOperatorParameterEvents(opParam);
|
---|
[2790] | 180 | }
|
---|
[2] | 181 | }
|
---|
| 182 | }
|
---|
[2653] | 183 | private void RegisterOperatorEvents(IOperator op) {
|
---|
| 184 | op.Parameters.ItemsAdded += new CollectionItemsChangedEventHandler<IParameter>(Parameters_ItemsAdded);
|
---|
| 185 | op.Parameters.ItemsRemoved += new CollectionItemsChangedEventHandler<IParameter>(Parameters_ItemsRemoved);
|
---|
| 186 | op.Parameters.ItemsReplaced += new CollectionItemsChangedEventHandler<IParameter>(Parameters_ItemsReplaced);
|
---|
| 187 | op.Parameters.CollectionReset += new CollectionItemsChangedEventHandler<IParameter>(Parameters_CollectionReset);
|
---|
| 188 | }
|
---|
| 189 | private void DeregisterOperatorEvents(IOperator op) {
|
---|
| 190 | op.Parameters.ItemsAdded -= new CollectionItemsChangedEventHandler<IParameter>(Parameters_ItemsAdded);
|
---|
| 191 | op.Parameters.ItemsRemoved -= new CollectionItemsChangedEventHandler<IParameter>(Parameters_ItemsRemoved);
|
---|
| 192 | op.Parameters.ItemsReplaced -= new CollectionItemsChangedEventHandler<IParameter>(Parameters_ItemsReplaced);
|
---|
| 193 | op.Parameters.CollectionReset -= new CollectionItemsChangedEventHandler<IParameter>(Parameters_CollectionReset);
|
---|
| 194 | }
|
---|
[3407] | 195 | private void RegisterOperatorParameterEvents(IValueParameter opParam) {
|
---|
[2653] | 196 | opParam.ValueChanged += new EventHandler(opParam_ValueChanged);
|
---|
| 197 | }
|
---|
[3407] | 198 | private void DeregisterOperatorParameterEvents(IValueParameter opParam) {
|
---|
[2653] | 199 | opParam.ValueChanged -= new EventHandler(opParam_ValueChanged);
|
---|
| 200 | }
|
---|
[2] | 201 |
|
---|
[2653] | 202 | private void Operators_ItemsAdded(object sender, CollectionItemsChangedEventArgs<IOperator> e) {
|
---|
| 203 | foreach (IOperator op in e.Items)
|
---|
| 204 | AddOperator(op);
|
---|
[2] | 205 | }
|
---|
[2653] | 206 | private void Operators_ItemsRemoved(object sender, CollectionItemsChangedEventArgs<IOperator> e) {
|
---|
| 207 | foreach (IOperator op in e.Items)
|
---|
| 208 | RemoveOperator(op);
|
---|
| 209 | if (!Operators.Contains(InitialOperator)) InitialOperator = null;
|
---|
[2] | 210 | }
|
---|
[2653] | 211 | private void Operators_CollectionReset(object sender, CollectionItemsChangedEventArgs<IOperator> e) {
|
---|
| 212 | foreach (IOperator op in e.OldItems)
|
---|
| 213 | RemoveOperator(op);
|
---|
| 214 | foreach (IOperator op in e.Items)
|
---|
| 215 | AddOperator(op);
|
---|
| 216 | if (!Operators.Contains(InitialOperator)) InitialOperator = null;
|
---|
[2] | 217 | }
|
---|
[2653] | 218 | private void Parameters_ItemsAdded(object sender, CollectionItemsChangedEventArgs<IParameter> e) {
|
---|
| 219 | foreach (IParameter param in e.Items)
|
---|
| 220 | AddParameter(param);
|
---|
| 221 | }
|
---|
| 222 | private void Parameters_ItemsRemoved(object sender, CollectionItemsChangedEventArgs<IParameter> e) {
|
---|
| 223 | foreach (IParameter param in e.Items)
|
---|
| 224 | RemoveParameter(param);
|
---|
| 225 | }
|
---|
| 226 | private void Parameters_ItemsReplaced(object sender, CollectionItemsChangedEventArgs<IParameter> e) {
|
---|
| 227 | foreach (IParameter param in e.OldItems)
|
---|
| 228 | RemoveParameter(param);
|
---|
| 229 | foreach (IParameter param in e.Items)
|
---|
| 230 | AddParameter(param);
|
---|
| 231 | }
|
---|
| 232 | private void Parameters_CollectionReset(object sender, CollectionItemsChangedEventArgs<IParameter> e) {
|
---|
| 233 | foreach (IParameter param in e.OldItems)
|
---|
| 234 | RemoveParameter(param);
|
---|
| 235 | foreach (IParameter param in e.Items)
|
---|
| 236 | AddParameter(param);
|
---|
| 237 | }
|
---|
| 238 | private void opParam_ValueChanged(object sender, EventArgs e) {
|
---|
[3407] | 239 | IValueParameter opParam = (IValueParameter)sender;
|
---|
| 240 | if (opParam.Value != null) Operators.Add((IOperator)opParam.Value);
|
---|
[2653] | 241 | }
|
---|
| 242 | #endregion
|
---|
[2] | 243 | }
|
---|
| 244 | }
|
---|