namespace Xylem.Common.CommonCore.Consts
{
    /// <summary>
    ///     data marker for incoming record being used at serialComPort receive event
    ///     to stamp a start/intermediate/end record for an accurate actual time,
    ///     additionally being used to decide if decoding will be executed at !SkipDecoding
    ///     to speed up processing time.
    /// </summary>
    public enum SyncMarkRecord
    {
        /// <summary>
        /// not synchronized stream, avoid decoding of protocol, this is not needed 
        /// </summary>
        SkipDecoding,

        /// <summary>
        /// find start package and decode protocol
        /// </summary>
        SyncStart,

        /// <summary>
        /// find end package and decode protocol
        /// </summary>
        SyncEnd,

        /// <summary>
        /// decode intermediate package for internal update of measurement
        /// </summary>
        DecodeIntermediate,


        /// <summary>
        /// decode intermediate package for internal checkmesurement quality
        /// </summary>
        DecodeIntermediateQuality,

        /// <summary>
        /// decode every package for logging, zero-flow etc.
        /// </summary>
        DecodeEveryPackage,

        /// <summary>
        /// just flush buffer, will not mark any package
        /// </summary>
        FlushBuffer
    }
}