/*
 * DTS.Slice.Control.Event.Module.Channel.DataValues.cs
 * 
 * Copyright © 2009
 * Diversified Technical Systems, Inc.
 * All Rights Reserved
 */

using DTS.Common.Utilities;
using DTS.Common.Utilities.DotNetProgrammingConstructs;

namespace DTS.Slice.Control
{
    // *** see DTS.Slice.Control.Event.cs ***
    public partial class Event
    {

        // *** see DTS.Slice.Control.Event.Module.cs ***
        public partial class Module
        {

            // *** see DTS.Slice.Control.Event.Module.Channel.cs ***
            public partial class Channel
            {

                /// <summary>
                /// Representation of a channel's data.
                /// </summary>
                public class DataValues : Exceptional
                {
                    /// <summary>
                    /// Initialize an instance of this class.
                    /// </summary>
                    public DataValues()
                        : this(true)
                    {
                    }

                    /// <summary>
                    /// Initialize an instance of this class.
                    /// </summary>
                    /// 
                    /// <param name="useMemoryMappedFile">
                    /// A <see cref="bool"/> determining whether or not this data class will use memory mapped files
                    /// to store data (necessary for data sets that exceed internal process memory limitations). 
                    /// </param>
                    /// 
                    public DataValues(bool useMemoryMappedFile)
                    {
                        try
                        {
                            UseMemoryMappedFile = useMemoryMappedFile;

                            if (UseMemoryMappedFile)
                            {
                            }
                        }

                        catch (System.Exception ex)
                        {
                            throw new Exception("encountered problem constructing " + GetType().FullName, ex);
                        }
                    }

                    /// <summary>
                    /// Get/set the switch that will cause this class to use memory mapped files in lieu
                    /// of in-memory list.
                    /// </summary>
                    public bool UseMemoryMappedFile
                    {
                        get => _UseMemoryMappedFile.Value;
                        set => _UseMemoryMappedFile.Value = value;
                    }
                    private readonly Property<bool> _UseMemoryMappedFile =
                        new Property<bool>(
                            typeof(DataValues).Namespace + ".UseMemoryMappedFile",
                            false,
                            false
                        );
                }
            } // *** End Event.Module.Channel ***
        } // *** End Event.Module ***
    } // *** End Event ***
}