namespace DTS.Common.Interface.DASFactory.ARM
{
    public interface IArmStatusData
    {
        /// <summary>
        /// returns true if unit received InvalidMode to query commands during initial setup
        /// 15932 Error when performing test when S6A is streaming
        /// this is used in some places currently to detect when a unit is streaming
        /// </summary>
        bool ReceivedInvalidModeDuringSetup { get; set; }
        /// <summary>
        /// clears any flags set or needed for triggercheck
        /// </summary>
        void ClearTriggerCheckStatus();

        /// <summary>
        /// Is the DAS currently armed?
        /// </summary>
        bool IsArmed { get; set; }

        /// <summary>
        /// Has the DAS sensed a trigger?
        /// </summary>
        bool IsTriggered { get; set; }

        /// <summary>
        /// a little bit distinct from IsTriggered
        /// in that IsTriggerShorted is only set during TriggerCheck
        /// while IsTriggered is set in many places
        /// </summary>
        bool IsTriggerShorted { get; set; }

        /// <summary>
        /// indicates that trigger was shorted
        /// is only set during triggercheck
        /// </summary>
        bool IsStartShorted { get; set; }

        /// <summary>
        /// Is the DAS currently recording sample data?
        /// </summary>
        bool IsRecording { get; set; }

        /// <summary>
        /// Has the DAS faulted?
        /// </summary>
        bool IsFaulted { get; set; }

        /// <summary>
        /// Is the DAS in real time mode?
        /// </summary>
        bool IsInRealtime { get; set; }

        /// <summary>
        /// is the DAS in flash write (G5)
        /// </summary>
        bool IsInFlashWrite { get; set; }

        /// <summary>
        /// used for the times when TDAS ARM STAT READ just doesn't return anything
        /// </summary>
        bool IsUndefined { get; set; }

        /// <summary>
        /// Is the DAS in post test diagnostics
        /// </summary>
        bool IsInPostTestDiagnostics { get; set; }

        /// <summary>
        /// How many seconds are left of recording?
        /// </summary>
        double TimeRemainingSeconds { get; set; }

        /// <summary>
        /// what percentage is complete [flashwrite]
        /// </summary>
        double PercentComplete { get; set; }

        /// <summary>
        /// How many samples total will the DAS be recording this test?
        /// </summary>
        ulong TotalSamples { get; set; }

        /// <summary>
        /// What sample are we currently recording?
        /// </summary>
        ulong CurrentSample { get; set; }

        /// <summary>
        /// At what sample rate are we currently recording?
        /// </summary>
        uint SampleRate { get; set; }

        /// <summary>
        /// What's the current input voltage?
        /// </summary>
        double? InputMilliVolts { get; set; }

        /// <summary>
        /// What's the current battery voltage (null if no battery)?
        /// </summary>
        double? BatteryMilliVolts { get; set; }

        /// <summary>
        /// Which event number is currently being recorded?
        /// </summary>
        int? EventNumber { get; set; }
        //FB 26817
        /// <summary>
        /// The Max number of events supported by a device
        /// </summary>
        ushort? MaxEventsPossible { get; set; }
        int RecordingMode { get; set; }
        /// <summary>
        /// optional fault message if there is a fault
        /// (software will flag some faults and when we do we know what caused it)
        /// </summary>
        string FaultMessage { get; set; }

        bool IsRearming { get; set; }

        bool HasBeenRecording { get; set; }

        double? TimeLeftInArm { get; set; }
    }
}