Free cookie consent management tool by TermsFeed Policy Generator

source: branches/3.2/sources/HeuristicLab.PluginInfrastructure/BaseClasses/PluginBase.cs

Last change on this file was 2790, checked in by swagner, 15 years ago

Operator architecture refactoring (#95)

  • implemented reviewers' comments
  • added additional plugins HeuristicLab.Evolutionary, HeuristicLab.Permutation, HeuristicLab.Selection, and HeuristicLab.Routing.TSP
File size: 2.2 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 System.Collections.Generic;
24using System.Text;
25using System.Reflection;
26using System.Diagnostics;
27using System.Linq;
28
29namespace HeuristicLab.PluginInfrastructure {
30  /// <summary>
31  /// Abstract base implementation of the IPlugin interface.
32  /// </summary>
33  public abstract class PluginBase : IPlugin {
34    /// <summary>
35    /// Initializes a new instance of <see cref="PluginBase"/>.
36    /// </summary>
37    public PluginBase() { }
38
39    private PluginAttribute PluginAttribute {
40      get {
41        object[] pluginAttributes = this.GetType().GetCustomAttributes(typeof(PluginAttribute), false);
42        // exactly one attribute of the type PluginDescriptionAttribute must be given
43        if (pluginAttributes.Length == 0) {
44          throw new InvalidPluginException("PluginAttribute on type " + this.GetType() + " is missing.");
45        } else if (pluginAttributes.Length > 1) {
46          throw new InvalidPluginException("Found multiple PluginAttributes on type " + this.GetType());
47        }
48        return (PluginAttribute)pluginAttributes[0];
49      }
50    }
51
52    #region IPlugin Members
53    /// <inheritdoc />
54    public string Name {
55      get {
56        return PluginAttribute.Name;
57      }
58    }
59
60    /// <inhertitdoc />
61    public virtual void OnLoad() { }
62    /// <inhertitdoc />
63    public virtual void OnUnload() { }
64    #endregion
65
66  }
67}
Note: See TracBrowser for help on using the repository browser.