//-----------------------------------------------------------------------
// <copyright file="ProtocolInitException.cs" company="bedug.com">
//     Copyright © 2012 Nils Hammar. All rights reserved.
// </copyright>
//-----------------------------------------------------------------------
/*
 * Software to access vehicle information via the OBD-II connector.
 * 
 * Copyright © 2012 Nils Hammar
 * 
 * This program 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.
 * This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
 * 
 * Alternative licensing is possible, see the licensing document.
 * 
 * The above text may not be removed or modified.
 */

namespace Protocol
{
    using System;
    using System.Runtime.Serialization;

    /// <summary>
    /// Exception to throw when initialization of a protocol fails.
    /// </summary>
    [Serializable]
    public class ProtocolInitException : Exception
    {
        /// <summary>
        /// Initializes a new instance of the <see cref="ProtocolInitException" /> class.
        /// </summary>
        public ProtocolInitException()
        {
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="ProtocolInitException" /> class.
        /// </summary>
        /// <param name="msg">The error message that explains the reason for the exception.</param>
        public ProtocolInitException(string msg)
            : base(msg)
        {
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="ProtocolInitException" /> class.
        /// </summary>
        /// <param name="msg">The error message that explains the reason for the exception.</param>
        /// <param name="cause">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 ProtocolInitException(string msg, Exception cause)
            : base(msg, cause)
        {
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="ProtocolInitException" /> class.
        /// </summary>
        /// <param name="serializationInfo">The SerializationInfo that holds the serialized object data about the exception being thrown.</param>
        /// <param name="streamingContext">The StreamingContext that contains contextual information about the source or destination.</param>
        protected ProtocolInitException(SerializationInfo serializationInfo, StreamingContext streamingContext)
            : base(serializationInfo, streamingContext)
        {
        }
    }
}