namespace DTS.Common.Interface.DASFactory.ARM
{
    /// <summary>
    /// Arm interface for a DAS unit.
    /// </summary>
    public interface IArmStatus
    {
        /// <summary>
        /// marks the unit as being in arm        
        /// <paramref name="WriteToDb">whether to write to db or not</paramref>
        /// </summary>
        void SetInArm(bool WriteToDb);
        /// <summary>
        /// marks the unit as being in realtime
        /// <paramref name="WriteToDb">whether to write to db or not</paramref>
        /// </summary>
        void SetInRealtime(bool WriteToDb, bool ExitRealtimeIfPossible);
        /// <summary>
        /// returns true if the unit is in known to be in Arm
        /// does not query the hardware, just returns a flag if it has been set
        /// </summary>
        /// <returns></returns>
        bool GetIsInArm();
        /// <summary>
        /// returns true if unit is known to be in realtime
        /// does not query the hardware, just returns a flag if it has been set
        /// </summary>
        /// <returns></returns>
        bool GetIsInRealtime();
        /// <summary>
        /// returns true if the unit is known to be streaming
        /// does not query the hardware, just returns a flag if it has been set
        /// </summary>
        /// <returns></returns>
        bool GetIsStreaming();
        IArmStatusData DASArmStatus { get; set; }
        /// <summary>
        /// sets DASArmStatus and optionally stores in the db
        /// </summary>
        /// <param name="status"></param>
        /// <param name="bSetInDb"></param>
        void SetDASArmStatus(IArmStatusData status, bool bSetInDb);
        /// <summary>
        /// sets to the db (if connected) the current DASArmStatus
        /// </summary>
        void SetDASArmStatus();
    }
}