//-----------------------------------------------------------------------
// <copyright file="ISerialPortParameters.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 SharedObjects.Protocol
{
    /// <summary>
    /// Interface for wrapper class for serial port parameters.
    /// </summary>
    public interface ISerialPortParameters
    {
        /// <summary>
        /// Gets or sets data bits of serial port, e.g. 8.
        /// </summary>
        int serialPortDatabits { get; set; }

        /// <summary>
        /// Gets or sets name of serial port, e.g. COM1.
        /// </summary>
        string serialPortName { get; set; }

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

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

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