Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.PluginInfrastructure/3.3/BaseClasses/PluginBase.cs @ 11808

Last change on this file since 11808 was 11171, checked in by ascheibe, 10 years ago

#2115 merged r11170 (copyright update) into trunk

File size: 2.1 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2014 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
22
23namespace HeuristicLab.PluginInfrastructure {
24  /// <summary>
25  /// Abstract base implementation of the IPlugin interface.
26  /// </summary>
27  public abstract class PluginBase : IPlugin {
28    /// <summary>
29    /// Initializes a new instance of <see cref="PluginBase"/>.
30    /// </summary>
31    protected PluginBase() { }
32
33    private PluginAttribute PluginAttribute {
34      get {
35        object[] pluginAttributes = this.GetType().GetCustomAttributes(typeof(PluginAttribute), false);
36        // exactly one attribute of the type PluginDescriptionAttribute must be given
37        if (pluginAttributes.Length == 0) {
38          throw new InvalidPluginException("PluginAttribute on type " + this.GetType() + " is missing.");
39        } else if (pluginAttributes.Length > 1) {
40          throw new InvalidPluginException("Found multiple PluginAttributes on type " + this.GetType());
41        }
42        return (PluginAttribute)pluginAttributes[0];
43      }
44    }
45
46    #region IPlugin Members
47    /// <inheritdoc />
48    public string Name {
49      get {
50        return PluginAttribute.Name;
51      }
52    }
53
54    /// <inhertitdoc />
55    public virtual void OnLoad() { }
56    /// <inhertitdoc />
57    public virtual void OnUnload() { }
58    #endregion
59
60  }
61}
Note: See TracBrowser for help on using the repository browser.