source: trunk/sources/HeuristicLab.Parameters/3.3/ScopeParameter.cs @ 7259

Last change on this file since 7259 was 7259, checked in by swagner, 11 years ago

Updated year of copyrights to 2012 (#1716)

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