/*
 * DTS.Slice.Control.DAS.Channel.IFilterable.cs
 * 
 * Copyright © 2009
 * Diversified Technical Systems, Inc.
 * All Rights Reserved
 */

using System.Collections.Generic;
using DTS.Slice.Control;

namespace DTS.Common.SerializationPlus
{
    /// <summary>
    /// Methodical definition of a filterable slice control event module channle.
    /// </summary>
    public interface IFilterable
    //: DTS.Common.DAS.ConceptsIFilterable<Event.Module.Channel, short[]>
    {
        /// <summary>
        /// Get/set the <see cref="bool"/> switch to (de)activate filter caching.
        /// </summary>
        bool UseFilterCaching
        {
            get;
            set;
        }

        /// <summary>
        /// Get the list of available filters for this object.
        /// </summary>
        List<IFilter> AvailableFilters
        {
            get;
        }

        /// <summary>
        /// The currently applied filter.
        /// </summary>
        IFilter CurrentFilter
        {
            get;
            set;
        }

        /// <summary>
        /// Get the specified filtering for this object.
        /// </summary>
        /// 
        /// <param name="filter">
        /// The <see cref="DTS.Slice.Control.CAS.Channel.IFilter"/> to be applied to this object.
        /// </param>
        /// 
        /// <param name="displayUnits">
        /// Choose the output <see cref="DTS.Slice.Control.DAS.Channel.Data.DisplayUnits"/>.
        /// </param>
        /// 
        /// <returns>
        /// An array of <see cref="double"/> data reflecting the specified parameters.
        /// </returns>
        /// 
        double[] GetDataFilteredBy(IFilter filter, Event.Module.Channel.DataDisplayUnits displayUnits);
    }
}