//******************************************************************************************************
//  ConfigurationErrorFrame.cs - Gbtc
//
//  Copyright © 2012, Grid Protection Alliance.  All Rights Reserved.
//
//  Licensed to the Grid Protection Alliance (GPA) under one or more contributor license agreements. See
//  the NOTICE file distributed with this work for additional information regarding copyright ownership.
//  The GPA licenses this file to you under the MIT License (MIT), the "License"; you may
//  not use this file except in compliance with the License. You may obtain a copy of the License at:
//
//      http://www.opensource.org/licenses/MIT
//
//  Unless agreed to in writing, the subject software distributed under the License is distributed on an
//  "AS-IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. Refer to the
//  License for the specific language governing permissions and limitations.
//
//  Code Modification History:
//  ----------------------------------------------------------------------------------------------------
//  04/23/2010 - James R. Carroll
//       Generated original version of source code.
//  10/5/2012 - Gavin E. Holden
//       Added new header and license agreement.
//  12/04/2012 - J. Ritchie Carroll
//       Migrated to PhasorProtocolAdapters project.
//  12/13/2012 - Starlynn Danyelle Gilliam
//       Modified Header.
//
//******************************************************************************************************

using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.Runtime.Serialization;
using GSF;
using GSF.Parsing;
using GSF.PhasorProtocols;
using GSF.TimeSeries;
using GSF.Units.EE;

namespace PhasorProtocolAdapters
{
    /// <summary>
    /// Represents an implementation of <see cref="IConfigurationFrame"/> that by existence only denotes an error state.
    /// </summary>
    /// <remarks>
    /// This class is used by <see cref="CommonPhasorServices"/> to return an error state when configuration could not be retrieved.
    /// </remarks>
    [Serializable]
    [SuppressMessage("Microsoft.Design", "CA1033:InterfaceMethodsShouldBeCallableByChildTypes", Scope = "method")]
    public sealed class ConfigurationErrorFrame : IConfigurationFrame
    {
        #region [ Constructors ]

        /// <summary>
        /// Creates a new instance of the <see cref="ConfigurationErrorFrame"/> class.
        /// </summary>
        public ConfigurationErrorFrame()
        {
        }

        /// <summary>
        /// Creates a new <see cref="ConfigurationErrorFrame"/> from serialization parameters.
        /// </summary>
        /// <param name="info">The <see cref="SerializationInfo"/> with populated with data.</param>
        /// <param name="context">The source <see cref="StreamingContext"/> for this deserialization.</param>
        private ConfigurationErrorFrame(SerializationInfo info, StreamingContext context)
        {
        }

        #endregion

        #region [ Methods ]

        /// <summary>
        /// Populates a <see cref="SerializationInfo"/> with the data needed to serialize the target object.
        /// </summary>
        /// <param name="info">The <see cref="SerializationInfo"/> to populate with data.</param>
        /// <param name="context">The destination <see cref="StreamingContext"/> for this serialization.</param>
        public void GetObjectData(SerializationInfo info, StreamingContext context)
        {
        }

        #endregion

        #region [ Explicit Interface Implementation ]

        ConfigurationCellCollection IConfigurationFrame.Cells => null;

        IConfigurationFrameParsingState IConfigurationFrame.State
        {
            get => null;
            set => throw new NotImplementedException();
        }

        ushort IConfigurationFrame.FrameRate
        {
            get => 0;
            set => throw new NotImplementedException();
        }

        decimal IConfigurationFrame.TicksPerFrame => 0;

        void IConfigurationFrame.SetNominalFrequency(LineFrequency value) => throw new NotImplementedException();

        FundamentalFrameType IChannelFrame.FrameType => FundamentalFrameType.ConfigurationFrame;

        object IChannelFrame.Cells => null;

        ushort IChannelFrame.IDCode
        {
            get => 0;
            set => throw new NotImplementedException();
        }

        UnixTimeTag IChannelFrame.TimeTag => null;

        Dictionary<string, string> IChannel.Attributes => null;

        IChannelParsingState IChannel.State
        {
            get => null;
            set => throw new NotImplementedException();
        }

        object IChannel.Tag
        {
            get => null;
            set => throw new NotImplementedException();
        }

        int ISupportBinaryImage.BinaryLength => 0;

        int ISupportBinaryImage.ParseBinaryImage(byte[] buffer, int startIndex, int length) => 0;

        int ISupportBinaryImage.GenerateBinaryImage(byte[] buffer, int startIndex) => 0;

        IMeasurement IFrame.LastSortedMeasurement
        {
            get => null;
            set => throw new NotImplementedException();
        }

        ConcurrentDictionary<MeasurementKey, IMeasurement> IFrame.Measurements => null;

        bool IFrame.Published
        {
            get => false;
            set => throw new NotImplementedException();
        }

        int IFrame.SortedMeasurements
        {
            get => -1;
            set => throw new NotImplementedException();
        }

        Ticks IFrame.Timestamp
        {
            get => 0;
            set => throw new NotImplementedException();
        }

        ShortTime IFrame.Lifespan => ShortTime.Now;

        Ticks IFrame.CreatedTimestamp => DateTime.UtcNow.Ticks;

        bool IEquatable<IFrame>.Equals(IFrame other) => false;

        int IComparable<IFrame>.CompareTo(IFrame other) => 1;

        int IComparable.CompareTo(object obj) => 1;

        #endregion
    }
}