Free cookie consent management tool by TermsFeed Policy Generator

source: branches/PausableBasicAlgorithm/HeuristicLab.Parameters/3.3/ScopeParameter.cs @ 13818

Last change on this file since 13818 was 12012, checked in by ascheibe, 10 years ago

#2212 merged r12008, r12009, r12010 back into trunk

File size: 2.3 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2015 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;
23using System.Threading;
24using HeuristicLab.Common;
25using HeuristicLab.Core;
26using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
27
28namespace HeuristicLab.Parameters {
29  /// <summary>
30  /// A parameter which represents the current scope.
31  /// </summary>
32  [Item("ScopeParameter", "A parameter which represents the current scope.")]
33  [StorableClass]
34  public class ScopeParameter : LookupParameter<IScope> {
35    public new IScope ActualValue {
36      get { return ExecutionContext.Scope; }
37    }
38
39
40    [StorableConstructor]
41    protected ScopeParameter(bool deserializing) : base(deserializing) { }
42    protected ScopeParameter(ScopeParameter original, Cloner cloner) : base(original, cloner) { }
43    public ScopeParameter()
44      : base("Anonymous") {
45      this.Hidden = true;
46    }
47    public ScopeParameter(string name)
48      : base(name) {
49      this.Hidden = true;
50    }
51    public ScopeParameter(string name, string description)
52      : base(name, description) {
53      this.Hidden = true;
54    }
55
56    public override IDeepCloneable Clone(Cloner cloner) {
57      return new ScopeParameter(this, cloner);
58    }
59
60    public override string ToString() {
61      return Name;
62    }
63
64    protected override IItem GetActualValue() {
65      return ExecutionContext.Scope;
66    }
67    protected override void SetActualValue(IItem value) {
68      throw new NotSupportedException("The actual value of a ScopeParameter cannot be set. It is always the current scope.");
69    }
70  }
71}
Note: See TracBrowser for help on using the repository browser.