Free cookie consent management tool by TermsFeed Policy Generator

source: stable/HeuristicLab.PluginInfrastructure/3.3/Interfaces/IPlugin.cs

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

#2875: Merged r17180 from trunk to stable

File size: 1.7 KB
RevLine 
[2]1#region License Information
2/* HeuristicLab
[17181]3 * Copyright (C) Heuristic and Evolutionary Algorithms Laboratory (HEAL)
[2]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  /// Represents a plugin.
26  /// Plugin developers have to include exactly one class that implements this interface in one of the
[2504]27  /// assemblies of the plugin.
28  /// OnLoad() and OnUnLoad() are called by the framework when the plugin is loaded/unloaded.
[2]29  /// </summary>
[2481]30  public interface IPlugin {
[2475]31    /// <summary>
32    /// Gets the name of the plugin.
33    /// </summary>
[2]34    string Name { get; }
35
36    /// <summary>
[1229]37    /// Called by the framework whenever the plugin is loaded.
[2475]38    /// Plugins are loaded when a new application is started from the starter.
[1229]39    /// </summary>
40    void OnLoad();
[2503]41
42    /// <summary>
43    /// Called by the framework whenever the plugin is unloaded.
44    /// Plugins are unloaded when an application exits.
45    /// </summary>
46    void OnUnload();
[2]47  }
48}
Note: See TracBrowser for help on using the repository browser.