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

    /// <summary>
    /// Interface to class that handles the filters used.
    /// </summary>
    public interface IFilterHandler
    {
        /// <summary>
        /// Gets Filter list.
        /// </summary>
        ICollection<IFilterItem> filters { get; }

        /// <summary>
        /// Remove all known filters from the connection.
        /// </summary>
        void removeAllFilters();

        /// <summary>
        /// Set default logger filter depending on protocol.
        /// </summary>
        void setDefaultLoggerFilter();

        /// <summary>
        /// Set a filter according to the given parameters.
        /// </summary>
        /// <param name="filterType">Type of filter.</param>
        /// <param name="protocol">Protocol for filter.</param>
        /// <param name="mask">Filter mask.</param>
        /// <param name="pattern">Filter pattern.</param>
        /// <param name="flow">Filter Flow pattern.</param>
        /// <param name="datasize">Data Size</param>
        /// <returns>'true' on success.</returns>
        bool setISO15765LoggerFilter(uint filterType, Protocols protocol, uint mask, uint pattern, uint flow, int datasize);

        /// <summary>
        /// Set the filter for the data we want to receive.
        /// </summary>
        void setRawLoggerFilter();

        /// <summary>
        /// Stop selected filter.
        /// </summary>
        /// <param name="msgId">ID of filter to stop.</param>
        /// <returns>'true' if successful.</returns>
        bool stopFilter(int msgId);
    }
}