DP44/DataPRO/IService/Interfaces/IArmActions.cs

using System;


namespace DTS.DASLib.Service
{
    internal interface IArmActions
    {
        void TurnOffT0Lights(ServiceCallback callback, object userData);

        /// <summary>
        /// initiates background flash erase for units that support it
        /// will return immediately after flash erase begins
        /// </summary>
        /// <param name="callbck"></param>
        /// <param name="userData"></param>
        void BeginBackgroundFlashErase(ServiceCallback callback, object userData);
        /// <summary>
        /// returns whether unit is capable of flash erase
        /// </summary>
        bool SupportsBackgroundFlashErase { get; }
        /// <summary>
        /// returns whether unit has started background flash erase
        /// </summary>
        bool BackgroundFlashEraseStarted { get; }
        DateTime? BackgroundFlashEraseStartTime { get; }

        /// <summary>
        /// Start an asynchronous flash erase on a single DAS.
        /// </summary>
        /// <param name="callback"></param>
        /// <param name="userData"></param>
        void BeginFlashErase(ServiceCallback callback, object userData, bool DummyArm);

        /// <summary>
        /// Query a single DAS for flash erase progress and an errors that have occurred.
        /// </summary>
        /// <param name="callback">The function to call with update information</param>
        /// <param name="userData"></param>
        void QueryFlashEraseStatus(ServiceCallback callback, object userData);

        void ReadyForArming(ServiceCallback callback, object userData, Guid eventGuid, int
                armNowTimeout, bool testingMode,
            int maxNumberEvents, bool DummyArm, bool SysMode);
        /// <summary>
        /// Arm a single DAS now
        /// </summary>
        /// <param name="callback">The function to call with information</param>
        /// <param name="userData">Whatever you want to pass along</param>
        /// <param name="eventGuid">A unique GUID that this event will be tagged 
        /// with</param>
        void ArmNow(ServiceCallback callback, object userData, Guid eventGuid, int
                armNowTimeout, bool testingMode,
            int maxNumberEvents, bool SysMode);

        void PrepareForArmNow(ServiceCallback callback, object userData, Guid eventGuid, int
                armNowTimeout, bool testingMode,
            int maxNumberEvents, bool SysMode);

        void PreparedArmNow(ServiceCallback callback, object userData, Guid eventGuid, int
                armNowTimeout, bool checkoutMode,
            int maxNumberEvents, bool SysMode);

        /// <summary>
        /// re-arm all units, potentially setting auto arm and repeat enable flags as well and whether to 
        /// call arm right away (or rely on the unit being restarted)
        /// </summary>
        void ReArm(ServiceCallback callback, object userData, bool autoArm, bool arm, bool repeatEnable);
        /// <summary>
        /// the UDP settings to broadcast auto arm status to on auto arm boot
        /// 17583 Monitor Test UI
        /// </summary>
        string AutoArmUDPSetting { get; set; }
        /// <summary>
        /// Auto Arm a single DAS now
        /// </summary>
        /// <param name="callback">The function to call with information</param>
        /// <param name="userData">Whatever you want to pass along</param>
        /// <param name="eventGuid">A unique GUID that this event will be tagged 
        /// with</param>
        void AutoArmNow(ServiceCallback callback, object userData, Guid eventGuid, int
            armNowTimeout, bool testingMode, UInt32 diagnosticsDelayMs, int MaxEventCount, bool repeatEnable, bool preserveDiagnostics);
        /// <summary>
        /// Arm multiple chained DAS now
        /// </summary>
        /// <param name="callback">The function to call with information</param>
        /// <param name="userData">Whatever you want to pass along</param>
        void EnableFaultChecking(ServiceCallback callback, object userData);

        /// <summary>
        /// checks all channels to see if the are level triggered
        /// sets the AlreadyLevelTriggered channel for the channel accordingly.
        /// </summary>
        /// <param name="callback"></param>
        /// <param name="userData"></param>
        void CheckAlreadyLevelTriggered(ServiceCallback callback, object userData);
        /// <summary>
        /// Disarm the DAS
        /// </summary>
        /// <param name="callback">The function to call with information</param>
        /// <param name="userData">Whatever you want to pass along</param>
        void Disarm(ServiceCallback callback, object userData);

        /// <summary>
        /// DisAutoArm the DAS
        /// </summary>
        /// <param name="callback">The function to call with information</param>
        /// <param name="userData">Whatever you want to pass along</param>
        void DisAutoArm(ServiceCallback callback, object userData);

        /// <summary>
        /// Retrieve the current arm status from the DAS
        /// </summary>
        /// <param name="callback">The function to call with information</param>
        /// <param name="userData">Whatever you want to pass along</param>
        void GetArmStatus(ServiceCallback callback, object userData, uint inputVoltageCutoff, int maxTimeout);

        /// <summary>
        /// Retrieve the current auto arm status from the DAS
        /// </summary>
        /// <param name="callback"></param>
        /// <param name="userData"></param>
        void GetAutoArmStatus(ServiceCallback callback, object userData);

        /// <summary>
        /// Set the DAS to low power mode
        /// </summary>
        /// <param name="callback">The function to call with information</param>
        /// <param name="userData">Whatever you want to pass along</param>
        void EnterLowPowerMode(ServiceCallback callback, object userData);

        /// <summary>
        /// Tells the DAS to start record
        /// </summary>
        /// <param name="callback">The function to call with information</param>
        /// <param name="userData">Whatever you want to pass along</param>
        void StartRecord(ServiceCallback callback, object userData);

        /// <summary>
        /// Sends trigger signal to HW
        /// </summary>
        /// <param name="callback">The function to call with information</param>
        /// <param name="userData">Whatever you want to pass along</param>
        void Trigger(ServiceCallback callback, object userData);
        /// <summary>
        /// queries for extended fault ids from hw
        /// </summary>
        /// <param name="callback"></param>
        /// <param name="userData"></param>
        void GetExtendedFaultIds(ServiceCallback callback, object userData);
    }
}