//-----------------------------------------------------------------------
// <copyright file="IDataSource.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;
    using global::SharedObjects.Misc;

    /// <summary>
    /// Data Source Interface.
    /// </summary>
    public interface IDataSource
    {
        /// <summary>
        /// Gets commspeed list instance.
        /// </summary>
        IList<XmlClass.commspeed> commspeeds
        {
            get;
        }

        /// <summary>
        /// Gets vehicles list instance.
        /// </summary>
        IList<XmlClass.vehicle> vehicles
        {
            get;
        }

        /// <summary>
        /// Gets modes list instance.
        /// </summary>
        IList<XmlClass.modeitem> modes
        {
            get;
        }

        /// <summary>
        /// Gets pidgroups list instance.
        /// </summary>
        IList<XmlClass.pidgroup> pidgroups
        {
            get;
        }

        /// <summary>
        /// Gets pidgroups list instance.
        /// </summary>
        IList<XmlClass.pidgroup> restrictedPidgroups
        {
            get;
        }

        /// <summary>
        /// Gets units list instance.
        /// </summary>
        IList<XmlClass.unititem> units
        {
            get;
        }

        /// <summary>
        /// Gets parameter list instance.
        /// </summary>
        IList<XmlClass.parameteritem> parameters
        {
            get;
        }

        /// <summary>
        /// Gets units list instance.
        /// </summary>
        IList<XmlClass.icon> icons
        {
            get;
        }

        /// <summary>
        /// Gets List of supported icons.
        /// </summary>
        IList<XmlClass.filter> filters
        {
            get;
        }

        /// <summary>
        /// Gets List of supported gauges.
        /// </summary>
        IList<XmlClass.gaugeitem> gauges
        {
            get;
        }

        /// <summary>
        /// Gets List of supported telltales.
        /// </summary>
        IList<XmlClass.telltaleitem> telltales
        {
            get;
        }

        /// <summary>
        /// Load data from files.
        /// </summary>
        void load();

        /// <summary>
        /// Reload the pid group data.
        /// </summary>
        void loadPidgroups();

        /// <summary>
        /// Save the vehicle data to file.
        /// </summary>
        void saveCommspeeds();

        /// <summary>
        /// Save vehicle data.
        /// </summary>
        void saveVehicles();

        /// <summary>
        /// Save unit data.
        /// </summary>
        void saveUnits();

        /// <summary>
        /// Save parameter data.
        /// </summary>
        void saveParameters();

        /// <summary>
        /// Save the Modes data to file.
        /// </summary>
        void saveModes();

        /// <summary>
        /// Save PID Group data.
        /// </summary>
        void savePidgroups();

        /// <summary>
        /// Save the PID group data to file.
        /// </summary>
        void saveIcons();

        /// <summary>
        /// Save the Filters data to file.
        /// </summary>
        void saveFilters();

        /// <summary>
        /// Save the gauge data to file.
        /// </summary>
        void saveGauges();

        /// <summary>
        /// Save the gauge data to file.
        /// </summary>
        void saveTelltales();
    }
}