source: branches/2839_HiveProjectManagement/HeuristicLab.Core/3.3/Scope.cs @ 16057

Last change on this file since 16057 was 16057, checked in by jkarder, 15 months ago

#2839:

File size: 5.3 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2018 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
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
22using System.Drawing;
23using HeuristicLab.Collections;
24using HeuristicLab.Common;
25using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
26
27namespace HeuristicLab.Core {
28  /// <summary>
29  /// Hierarchical container of variables (and of subscopes).
30  /// </summary>
31  [Item("Scope", "A scope which contains variables and sub-scopes.")]
32  [StorableClass]
33  public sealed class Scope : NamedItem, IScope {
34    public static new Image StaticItemImage {
35      get { return HeuristicLab.Common.Resources.VSImageLibrary.OrgChart; }
36    }
37
38    [Storable]
39    private IScope parent;
40    public IScope Parent {
41      get { return parent; }
42      set {
43        if (parent != value) {
44          parent = value;
45        }
46      }
47    }
48
49    [Storable]
50    private VariableCollection variables;
51    public VariableCollection Variables {
52      get { return variables; }
53    }
54
55    [Storable]
56    private ScopeList subScopes;
57    public ScopeList SubScopes {
58      get { return subScopes; }
59    }
60
61    [StorableConstructor]
62    private Scope(bool deserializing) : base(deserializing) { }
63    private Scope(Scope original, Cloner cloner)
64      : base(original, cloner) {
65      if (original.variables.Count > 0) variables = cloner.Clone(original.variables);
66      else variables = new VariableCollection();
67      if (original.subScopes.Count > 0) {
68        subScopes = cloner.Clone(original.subScopes);
69        foreach (IScope child in SubScopes)
70          child.Parent = this;
71      } else subScopes = new ScopeList();
72      RegisterSubScopesEvents();
73    }
74    /// <summary>
75    /// Initializes a new instance of <see cref="Scope"/> having "Anonymous" as default name.
76    /// </summary>
77    public Scope()
78      : base("Anonymous") {
79      parent = null;
80      variables = new VariableCollection();
81      subScopes = new ScopeList();
82      RegisterSubScopesEvents();
83    }
84    /// <summary>
85    /// Initializes a new instance of <see cref="Scope"/> with the given <paramref name="name"/>.
86    /// </summary>
87    /// <param name="name">The name of the scope.</param>
88    public Scope(string name)
89      : base(name) {
90      parent = null;
91      variables = new VariableCollection();
92      subScopes = new ScopeList();
93      RegisterSubScopesEvents();
94    }
95    public Scope(string name, string description)
96      : base(name, description) {
97      parent = null;
98      variables = new VariableCollection();
99      subScopes = new ScopeList();
100      RegisterSubScopesEvents();
101    }
102
103    [StorableHook(HookType.AfterDeserialization)]
104    private void AfterDeserialization() {
105      RegisterSubScopesEvents();
106    }
107
108    /// <inheritdoc/>
109    public void Clear() {
110      variables.Clear();
111      subScopes.Clear();
112    }
113
114    /// <inheritdoc/>
115    public override IDeepCloneable Clone(Cloner cloner) {
116      return new Scope(this, cloner);
117    }
118
119    #region SubScopes Events
120    private void RegisterSubScopesEvents() {
121      if (subScopes != null) {
122        subScopes.ItemsAdded += new CollectionItemsChangedEventHandler<IndexedItem<IScope>>(SubScopes_ItemsAdded);
123        subScopes.ItemsRemoved += new CollectionItemsChangedEventHandler<IndexedItem<IScope>>(SubScopes_ItemsRemoved);
124        subScopes.ItemsReplaced += new CollectionItemsChangedEventHandler<IndexedItem<IScope>>(SubScopes_ItemsReplaced);
125        subScopes.CollectionReset += new CollectionItemsChangedEventHandler<IndexedItem<IScope>>(SubScopes_CollectionReset);
126      }
127    }
128    private void SubScopes_ItemsAdded(object sender, CollectionItemsChangedEventArgs<IndexedItem<IScope>> e) {
129      foreach (IndexedItem<IScope> item in e.Items)
130        item.Value.Parent = this;
131    }
132    private void SubScopes_ItemsRemoved(object sender, CollectionItemsChangedEventArgs<IndexedItem<IScope>> e) {
133      foreach (IndexedItem<IScope> item in e.Items)
134        item.Value.Parent = null;
135    }
136    private void SubScopes_ItemsReplaced(object sender, CollectionItemsChangedEventArgs<IndexedItem<IScope>> e) {
137      foreach (IndexedItem<IScope> oldItem in e.OldItems)
138        oldItem.Value.Parent = null;
139      foreach (IndexedItem<IScope> item in e.Items)
140        item.Value.Parent = this;
141    }
142    private void SubScopes_CollectionReset(object sender, CollectionItemsChangedEventArgs<IndexedItem<IScope>> e) {
143      foreach (IndexedItem<IScope> oldItem in e.OldItems)
144        oldItem.Value.Parent = null;
145      foreach (IndexedItem<IScope> item in e.Items)
146        item.Value.Parent = this;
147    }
148    #endregion
149  }
150}
Note: See TracBrowser for help on using the repository browser.