//-----------------------------------------------------------------------
// <copyright file="SerialPortParameters.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 DeviceApi.Serial
{
    using System.IO.Ports;
    using global::SharedObjects.Protocol;

    /// <summary>
    /// Wrapper class for serial port parameters.
    /// </summary>
    public class SerialPortParameters : ISerialPortParameters
    {
        /// <summary>
        /// Gets or sets name of serial port, e.g. COM1.
        /// </summary>
        public string serialPortName { get; set; }

        /// <summary>
        /// Gets or sets speed of serial port, e.g. 9600.
        /// </summary>
        public int serialPortSpeed { get; set; }

        /// <summary>
        /// Gets or sets data bits of serial port, e.g. 8.
        /// </summary>
        public int serialPortDatabits { get; set; }

        /// <summary>
        /// Gets or sets parity of serial port, e.g. None.
        /// </summary>
        public Parity serialPortParity { get; set; }

        /// <summary>
        /// Gets or sets stop bits of serial port, e.g. One.
        /// </summary>
        public StopBits serialPortStopbits { get; set; }

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

        /// <summary>
        /// Initializes a new instance of the <see cref="SerialPortParameters" /> class.
        /// </summary>
        /// <param name="master">Master data for parameter values.</param>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1062:Validate arguments of public methods", MessageId = "0", Justification = "Reviewed, intentional.")]
        public SerialPortParameters(SerialPortParameters master)
        {
            this.serialPortName = master.serialPortName;
            this.serialPortSpeed = master.serialPortSpeed;
            this.serialPortDatabits = master.serialPortDatabits;
            this.serialPortParity = master.serialPortParity;
            this.serialPortStopbits = master.serialPortStopbits;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="SerialPortParameters" /> class.
        /// </summary>
        /// <param name="serialPortSpeed">Requested speed for serial port.</param>
        /// <param name="serialPortDatabits">Requested number of data bits for serial port.</param>
        /// <param name="serialPortParity">Requested parity mode for serial port.</param>
        /// <param name="serialPortStopbits">Requested number of stop bits for serial port.</param>
        public SerialPortParameters(int serialPortSpeed, int serialPortDatabits, Parity serialPortParity, StopBits serialPortStopbits)
        {
            this.serialPortSpeed = serialPortSpeed;
            this.serialPortDatabits = serialPortDatabits;
            this.serialPortParity = serialPortParity;
            this.serialPortStopbits = serialPortStopbits;
        }
    }
}