//-----------------------------------------------------------------------
// <copyright file="IDataLogInstance.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.DataLogging
{
    using System.Collections.Generic;
    using global::SharedObjects.DataLogging.Objects;
    using global::SharedObjects.Misc;

    /// <summary>
    /// Interface to implement for plotting service.
    /// </summary>
    public interface IDataLogInstance
    {
        /// <summary>
        /// Check if log file is open.
        /// </summary>
        /// <returns>'true' if log file is open.</returns>
        bool isLogOpen();

        /// <summary>
        /// Initialize log file.
        /// </summary>
        /// <param name="valueNames">Name of columns in log file, used at first line.</param>
        /// <param name="hasGps">'true' if logging of GPS data shall occur.</param>
        void initLog(StackedDictionary<uint, string> valueNames, bool hasGps);

        /// <summary>
        /// Log one data item.
        /// </summary>
        /// <param name="key">Key indicating which column that shall get the data.</param>
        /// <param name="value">Value to set on column.</param>
        void logData(uint[] key, double value);

        /// <summary>
        /// Log GPS data.
        /// </summary>
        /// <param name="lastGpsData">GPS position data.</param>
        /// <param name="lastGpsTime">Time for position data (used to determine age)</param>
        void logGps(GpsData lastGpsData, long lastGpsTime);

        /// <summary>
        /// Write one log row.
        /// </summary>
        void performLog();
    }
}