FitnessException.cs

using System;
using System.Runtime.Serialization;

namespace GeneticSharp
{
    /// <summary>
    /// Exception throw when an error occurs during the execution of fitness evaluation.
    /// </summary>
    [Serializable]
    public sealed class FitnessException : Exception
    {
        #region Constructors
        /// <summary>
        /// Initializes a new instance of the <see cref="GeneticSharp.Domain.Fitnesses.FitnessException"/> class.
        /// </summary>
        /// <param name="fitness">The fitness where occurred the error.</param>
        /// <param name="message">The error message.</param>
        public FitnessException(IFitness fitness, string message)
            : base("{0}: {1}".With(fitness != null ? fitness.GetType().Name : String.Empty, message))
        {
            Fitness = fitness;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="GeneticSharp.Domain.Fitnesses.FitnessException"/> class.
        /// </summary>
        /// <param name="fitness">The fitness where occurred the error.</param>
        /// <param name="message">The error message.</param>
        /// <param name="innerException">Inner exception.</param>
        public FitnessException(IFitness fitness, string message, Exception innerException)
            : base("{0}: {1}".With(fitness != null ? fitness.GetType().Name : String.Empty, message), innerException)
        {
            Fitness = fitness;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="FitnessException"/> class.
        /// </summary>
        public FitnessException()
        {
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="FitnessException"/> class.
        /// </summary>
        /// <param name="message">The message that describes the error.</param>
        public FitnessException(string message)
            : base(message)
        {
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="FitnessException"/> class.
        /// </summary>
        /// <param name="message">The error message that explains the reason for the exception.</param>
        /// <param name="innerException">The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified.</param>
        public FitnessException(string message, Exception innerException)
            : base(message, innerException)
        {
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="FitnessException"/> class.
        /// </summary>
        /// <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data about the exception being thrown.</param>
        /// <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains contextual information about the source or destination.</param>
        private FitnessException(SerializationInfo info, StreamingContext context)
            : base(info, context)
        {
        }
        #endregion

        #region Properties
        /// <summary>
        /// Gets the fitness.
        /// </summary>
        /// <value>The fitness.</value>
        public IFitness Fitness { get; private set; }
        #endregion

        #region Methods
        /// <summary>
        /// Sets the <see cref="T:System.Runtime.Serialization.SerializationInfo" /> with information about the exception.
        /// </summary>
        /// <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data about the exception being thrown.</param>
        /// <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains contextual information about the source or destination.</param> 
        public override void GetObjectData(SerializationInfo info, StreamingContext context)
        {
            base.GetObjectData(info, context);
            info.AddValue("Fitness", Fitness);
        }
        #endregion
    }
}