source: branches/2924_DotNetCoreMigration/HeuristicLab.PluginInfrastructure/3.3/Interfaces/IApplication.cs @ 16984

#region License Information
/* HeuristicLab
 * Copyright (C) 2002-2018 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
 *
 * This file is part of HeuristicLab.
 *
 * HeuristicLab is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * HeuristicLab is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
 */
#endregion


namespace HeuristicLab.PluginInfrastructure {
  /// <summary>
  /// Interface that must be implemented by HeuristicLab applications.
  /// </summary>
  public interface IApplication {
    /// <summary>
    /// Gets the name of the application.
    /// </summary>
    string Name { get; }
    /// <summary>
    /// Gets the description of the application.
    /// </summary>
    string Description { get; }
    /// <summary>
    /// Main entry point for the application.
    /// </summary>
    void Run(ICommandLineArgument[] args);

    /// <summary>
    /// This method gets called when a cancellation is invoked.
    /// </summary>
    void OnCancel();

    /// <summary>
    /// This method gets called when a pause is invoked.
    /// </summary>
    void OnPause();

    /// <summary>
    /// This method gets called when a resume is invoked.
    /// </summary>
    void OnResume();
  }
}