source: branches/HeuristicLab.Hive_Milestone3/sources/HeuristicLab.PluginInfrastructure/BaseClasses/ApplicationBase.cs @ 4631

#region License Information
/* HeuristicLab
 * Copyright (C) 2002-2008 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

using System;
using System.Collections.Generic;
using System.Text;
using System.Diagnostics;

namespace HeuristicLab.PluginInfrastructure {
  /// <summary>
  /// Default implementation for the IApplication interface.
  /// </summary>
  public abstract class ApplicationBase : IApplication {
    private string name;
    private Version version;
    private string description;
    private bool autoRestart;

    /// <summary>
    /// Initializes a new instance of <see cref="ApplicationBase"/>.
    /// </summary>
    public ApplicationBase() {
      ReadAttributes();
    }

    private void ReadAttributes() {
      object[] pluginAttributes = this.GetType().GetCustomAttributes(typeof(ClassInfoAttribute), false);

      // exactly one attribute of the type ClassInfoAttribute must be given
      if(pluginAttributes.Length != 1) {
        throw new InvalidPluginException();
      }

      // after the assertion we are sure that the array access will not fail
      ClassInfoAttribute pluginAttribute = (ClassInfoAttribute)pluginAttributes[0];
      if(pluginAttribute != null) {
        // if the plugin name is not explicitly set in the attribute then the default plugin name is the FullName of the type
        if(pluginAttribute.Name != null) {
          this.name = pluginAttribute.Name;
        } else {
          this.name = this.GetType().FullName;
        }

        // if the version is not explicitly set in the attribute then the version of the assembly is used as default
        if(pluginAttribute.Version != null) {
          this.version = new Version(pluginAttribute.Version);
        } else {
          this.version = this.GetType().Assembly.GetName().Version;
        }

        // if the description is not explicitly set in the attribute then the name of name of the application is used as default
        if(pluginAttribute.Description != null) {
          this.description = pluginAttribute.Description;
        } else {
          this.description = name;
        }

        this.autoRestart = pluginAttribute.AutoRestart;
      }
    }


    #region IApplication Members

    /// <summary>
    /// Gets the name of the application.
    /// </summary>
    public string Name {
      get { return name; }
    }

    /// <summary>
    /// Gets the version of the application.
    /// </summary>
    public Version Version {
      get { return version; }
    }

    /// <summary>
    /// Gets the description of the application.
    /// </summary>
    public string Description {
      get { return description; }
    }

    /// <summary>
    /// Gets the boolean flag whether the application should automatically get restarted.
    /// </summary>
    public bool AutoRestart {
      get { return autoRestart; }
    }

    /// <summary>
    /// Runs the application.
    /// </summary>
    public abstract void Run();

    #endregion
  }
}