Cosmos/Users/Orvid/PlugViewer/Warnings/BaseWarning.cs

using System;
using System.Collections.Generic;
using System.Text;
using PlugViewer.TreeViewNodes;

namespace PlugViewer.Warnings
{
    /// <summary>
    /// The base class for all Warnings.
    /// </summary>
    public abstract class BaseWarning
    {
        /// <summary>
        /// The type of node this warning can apply to.
        /// </summary>
        public abstract TreeNodeType AppliesTo { get; }
        /// <summary>
        /// Evaluate the given node.
        /// </summary>
        /// <param name="node">The node to evaluate.</param>
        public abstract void EvaluateNode(OTreeNode node);
        /// <summary>
        /// Gets the name of the warning.
        /// </summary>
        public abstract string Name { get; }
        /// <summary>
        /// Gets the description of the warning,
        /// and how it applies in the current situation.
        /// </summary>
        public abstract string Description { get; }
    }
}