//******************************************************************************************************//  ChannelFrameParsingStateBase.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://  ----------------------------------------------------------------------------------------------------//  01/14/2005 - J. Ritchie Carroll//       Generated original version of source code.//  09/15/2009 - Stephen C. Wills//       Added new header and license agreement.//  10/5/2012 - Gavin E. Holden//       Added new header and license agreement.//  12/17/2012 - Starlynn Danyelle Gilliam//       Modified Header.////****************************************************************************************************** using System; namespace GSF.PhasorProtocols{    /// <summary>    /// Represents the protocol independent common implementation of the parsing state used by any <see cref="IChannelFrame"/>.    /// </summary>    /// <typeparam name="T"><see cref="Type"/> of <see cref="IChannelCell"/> referenced by <see cref="IChannelFrame"/> being parsed.</typeparam>    public abstract class ChannelFrameParsingStateBase<T> : ChannelParsingStateBase, IChannelFrameParsingState<T> where T : IChannelCell    {        #region [ Members ]         // Fields        private bool m_trustHeaderLength;        private bool m_validateCheckSum;         #endregion         #region [ Constructors ]         /// <summary>        /// Creates a new <see cref="ChannelFrameParsingStateBase{T}"/> from specified parameters.        /// </summary>        /// <param name="parsedBinaryLength">Binary length of the <see cref="IChannelFrame"/> being parsed.</param>        /// <param name="createNewCellFunction">Reference to delegate to create new <see cref="IChannelCell"/> instances.</param>        /// <param name="trustHeaderLength">Determines if header lengths should be trusted over parsed byte count.</param>        /// <param name="validateCheckSum">Determines if frame's check-sum should be validated.</param>        protected ChannelFrameParsingStateBase(int parsedBinaryLength, CreateNewCellFunction<T> createNewCellFunction, bool trustHeaderLength, bool validateCheckSum)        {            base.ParsedBinaryLength = parsedBinaryLength;            CreateNewCell = createNewCellFunction;            m_trustHeaderLength = trustHeaderLength;            m_validateCheckSum = validateCheckSum;        }         #endregion         #region [ Properties ]         /// <summary>        /// Gets reference to delegate used to create a new <see cref="IChannelCell"/> object.        /// </summary>        public virtual CreateNewCellFunction<T> CreateNewCell { get; }         /// <summary>        /// Gets or sets number of cells that are expected in associated <see cref="IChannelFrame"/> being parsed.        /// </summary>        public virtual int CellCount { get; set; }         /// <summary>        /// Gets or sets flag that determines if header lengths should be trusted over parsed byte count.        /// </summary>        /// <remarks>        /// It is expected that this will normally be left as <c>true</c>.        /// </remarks>        public virtual bool TrustHeaderLength        {            get => m_trustHeaderLength;            set => m_trustHeaderLength = value;        }         /// <summary>        /// Gets or sets flag that determines if frame's check-sum should be validated.        /// </summary>        /// <remarks>        /// It is expected that this will normally be left as <c>true</c>.        /// </remarks>        public virtual bool ValidateCheckSum        {            get => m_validateCheckSum;            set => m_validateCheckSum = value;        }         #endregion    }}