Free cookie consent management tool by TermsFeed Policy Generator

source: stable/HeuristicLab.Parameters/3.3/ScopeParameter.cs

Last change on this file was 17181, checked in by swagner, 5 years ago

#2875: Merged r17180 from trunk to stable

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