Free cookie consent management tool by TermsFeed Policy Generator

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

Last change on this file since 4447 was 4332, checked in by swagner, 14 years ago

Enabled users to choose whether a parameter should be collected in each run or not (#1113)

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