Free cookie consent management tool by TermsFeed Policy Generator

source: branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure/Interfaces/IPlugin.cs @ 2475

Last change on this file since 2475 was 2475, checked in by gkronber, 14 years ago

worked on plugin infrastructure refactoring. #799

File size: 2.0 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2008 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;
25
26namespace HeuristicLab.PluginInfrastructure {
27  /// <summary>
28  /// Represents a plugin.
29  /// Plugin developers have to include exactly one class that implements this interface in one of the
30  /// assemblies of the plugin. Plugin developers can use the properties of this interface to store
31  /// plugin data (name, version, files, update location ...).
32  /// The method OnLoad() is called by the framework when the plugin is loaded (application start).
33  /// </summary>
34  internal interface IPlugin {
35    /// <summary>
36    /// Gets the name of the plugin.
37    /// </summary>
38    string Name { get; }
39    /// <summary>
40    /// Gets the version of the plugin.
41    /// </summary>
42    Version Version { get; }
43    /// <summary>
44    /// Gets all file names that are bundled with this plugin including all assembly files (*.dll)
45    /// </summary>
46    IEnumerable<string> FileNames { get; }
47
48    /// <summary>
49    /// Called by the framework whenever the plugin is loaded.
50    /// Plugins are loaded when a new application is started from the starter.
51    /// </summary>
52    void OnLoad();
53  }
54}
Note: See TracBrowser for help on using the repository browser.