//-----------------------------------------------------------------------
// <copyright file="IPreferences.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.DataMgmt
{
    using System.Collections.Generic;

    /// <summary>
    /// Methods for getting and setting preferences for the application.
    /// </summary>
    public interface IPreferences
    {
        /// <summary>
        /// Gets refresh interval alternatives.
        /// </summary>
        IList<string> refreshIntervals { get; }

        /// <summary>
        /// Gets The currently selected unit category. (0=General, 1=Metric, 2=Imperial.)
        /// <para>
        /// Notice that "General" means that data will be presented in both metric and imperial.
        /// </para>
        /// </summary>
        int selectedUnitCategory { get; }

        /// <summary>
        /// Gets default timeout value.
        /// </summary>
        int defaultTimeout { get; }

        /// <summary>
        /// Gets threshold for when a secondary Y axis shall be used in charts.
        /// </summary>
        int secondaryYThreshold { get; }

        /// <summary>
        /// Gets default timeout value.
        /// </summary>
        string obdCodeDatabase { get; }

        /// <summary>
        /// Gets Name of GPS port.
        /// </summary>
        string gpsSerialPortName { get; }

        /// <summary>
        /// Gets a value indicating whether features useful for development shall be available.
        /// <para>
        /// Notice that some of the features may be dangerous.
        /// </para>
        /// </summary>
        bool developerMode { get; }

        /// <summary>
        /// Gets Time in milliseconds to pause after sending a message.
        /// </summary>
        int sendDelay { get; }

        /// <summary>
        /// Gets Number of blocks accepted from peer before sending CTS.
        /// </summary>
        byte blockSize { get; }

        /// <summary>
        /// Gets Time in milliseconds to request that peer spaces it's frames with.
        /// </summary>
        byte frameSpacing { get; }

        /// <summary>
        /// Get a preference as an integer value.
        /// Returns zero if the data was invalid.
        /// </summary>
        /// <param name="preferenceName">Name of preference.</param>
        /// <returns>Preference as an integer value.</returns>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1720:IdentifiersShouldNotContainTypeNames", MessageId = "int", Justification = "Suitable in this case.")]
        int getIntPreference(string preferenceName);

        /// <summary>
        /// Get a preference as a string value.
        /// Notice: May return 'null'.
        /// </summary>
        /// <param name="preferenceName">Name of preference.</param>
        /// <returns>Preference as a string value.</returns>
        string getPreference(string preferenceName);

        /// <summary>
        /// Store a preference with the given name and value.
        /// </summary>
        /// <param name="preferenceName">Name of preference.</param>
        /// <param name="value">Preference value.</param>
        void setPreference(string preferenceName, string value);
    }
}