DAE.cs

Go to the documentation of this file.

using System;
using System.Collections;
using System.Collections.Generic;
using System.Text;
using System.Xml;
using System.Diagnostics;
using System.Runtime.InteropServices;

//This class stores all the values read off the DAE

namespace Seci.Standard
{
    public delegate void DaeEventHandler(DateTime time, String runNumber);

    public static class Dae
    {
        //Actual DAE Stuff
        private static String _filePath;     //the location of the DAE VI
        private static Boolean _visible;
        private static Boolean _inWaitingState;
        private static isisicpLib.dae _icp;    //This is used to talk to the ICP programme without going through LabVIEW

        private static String _daeData;           //This is passed to the icp programme to get values back
        private static float _updateRate = 1.0f;   //How often to update the DAE values (in seconds)
        private static DateTime _lastUpdated;     //Keeps track of when the DAE was last updated

        //Values
        //Basics
        private static String _runStatus;
        private static String _runNumber;
        private static String _rbNumber;
        private static String _userName;
        private static String _runTitle;
        private static String _startTime;
        private static String _runDurationTotal;
        private static String _runDurationPeriod;

        //Frames
        private static String _goodFramesTotal;
        private static String _goodFramesPeriod;
        private static String _rawFramesTotal;
        private static String _rawFramesPeriod;

        //Periods
        private static String _currentPeriod;
        private static String _numberOfPeriods;
        private static String _periodSequence;

        //Beam
        private static String _beamCurrent;
        private static String _totalUAmps;
        private static String _countRate;

        //DAE
        private static String _daeMemoryUsed;
        private static String _totalDaeCounts;
        private static String _DaeTimingSource;

        //Monitor
        private static String _monitorCounts;
        private static String _monitorSpectrum;
        private static String _monitorFrom;
        private static String _monitorTo;

        //Misc
        private static String _numberOfTimeChannels;
        private static String _numberOfSpectra;

        //Properties
        public static String RunStatus { get { return _runStatus; } }
        public static String RunNumber { get { return _runNumber; } }
        public static String RbNumber { get { return _rbNumber; } }
        public static String UserName { get { return _userName; } }
        public static String RunTitle { get { return _runTitle; } }
        public static String StartTime { get { return _startTime; } }
        public static String RunDurationTotal { get { return _runDurationTotal; } }
        public static String RunDurationPeriod { get { return _runDurationPeriod; } }
        public static String GoodFramesTotal { get { return _goodFramesTotal; } }
        public static String GoodFramesPeriod { get { return _goodFramesPeriod; } }
        public static String RawFramesTotal { get { return _rawFramesTotal; } }
        public static String RawFramesPeriod { get { return _rawFramesPeriod; } }
        public static String CurrentPeriod { get { return _currentPeriod; } }
        public static String NumberOfPeriods { get { return _numberOfPeriods; } }
        public static String PeriodSequence { get { return _periodSequence; } }
        public static String BeamCurrent { get { return _beamCurrent; } }
        public static String TotalUAmps { get { return _totalUAmps; } }
        public static String CountRate { get { return _countRate; } }
        public static String DaeMemoryUsed { get { return _daeMemoryUsed; } }
        public static String TotalDaeCounts { get { return _totalDaeCounts; } }
        public static String DaeTimingSource { get { return _DaeTimingSource; } }
        public static String MonitorCounts { get { return _monitorCounts; } }
        public static String MonitorSpectrum { get { return _monitorSpectrum; } }
        public static String MonitorFrom { get { return _monitorFrom; } }
        public static String MonitorTo { get { return _monitorTo; } }
        public static String NumberOfTimeChannels { get { return _numberOfTimeChannels; } }
        public static String NumberOfSpectra { get { return _numberOfSpectra; } }

        //Other properties
        public static String FilePath { get { return _filePath; } set { _filePath = value; } }
        internal static Boolean Visible { get { return _visible; } set { _visible = value; } }
        internal static Boolean InWaitingState { get { return _inWaitingState; } set { _inWaitingState = value; } }

        public static event DaeEventHandler RunStarted;

        public static event DaeEventHandler RunEnded;

        internal static void Initialise(String fileName)
        {
            _filePath = fileName;

            //Read the dae data from the resource - the data values are irrelevant but it is necessary
            //to send the ICP programme something with the correct XML format
            _daeData = Seci.Properties.Resources.cluster;
            //Start VI
            LoadDaeVI();
        }

        private static void LoadDaeVI()
        {
            //Load VI
            LabView.LabViewApp.LoadVI(_filePath, false);

            //Start it running
            LabView.LabViewApp.StartVI(_filePath);

            connectToIcp();
        }

        private static void connectToIcp()
        {
            //Create instance of pcicp (actually gets the one already running)
            try
            {
                _icp = new isisicpLib.dae();
            }
            catch
            {
                Helpers.ErrorLogger.SeciError("LoadDaeVI", new Exception("Could not connect to DAE"));
            }
        }

        public static void KillIcp()
        {
            try
            {
                //Stop ICP by killing the process.
                Process[] procList;

                procList = Process.GetProcessesByName("isisicp");

                foreach (Process proc in procList)
                {
                    proc.Kill();
                }
            }
            catch
            {
            }
        }

        public static void KillIsisDataSvr()
        {
            try
            {
                //Stop ISIS Data Server by killing the process.
                Process[] procList;

                procList = Process.GetProcessesByName("isisdatasvr");

                foreach (Process proc in procList)
                {
                    try
                    {
                        proc.Kill();
                    }
                    catch
                    {
                    }
                }
            }
            catch
            {
            }
        }

        public static void ShowDae()
        {
            LabView.LabViewApp.ShowVI(_filePath);
        }

        public static void HideDae()
        {
            LabView.LabViewApp.HideVI(_filePath);
        }

        public static void SetTitleBarVisibility(Boolean visible)
        {
            LabView.LabViewApp.SetTitleBarVisibility(_filePath, visible);
        }

        internal static Boolean CheckDaeVIRunning()
        {
            return LabView.LabViewApp.IsVIRunning(_filePath);
        }

        internal static List<String> GetDaeControls()
        {
            return LabView.LabViewApp.GetListOfControls(_filePath);
        }

        public static void SetTitle(String title)
        {
            //Set value
            LabView.LabViewApp.SetValue(_filePath, "New Run Title", title);
            //Press button
            LabView.LabViewApp.SetValue(_filePath, "Set Title", true);
        }

        #region Update data

        internal static Boolean updateRunInformation()
        {
            try
            {
                //Check that it is time to log; if it is first time then _LastLogged is 01:01:0001, so it will log by default
                if (DateTime.Now >= _lastUpdated.AddSeconds(_updateRate))
                {
                    if (_icp != null)
                    {
                        String results = ""; //this is a dummy
                        //pass the current data and get the new data back
                        _icp.updateStatusXML(ref _daeData, out results);
                        getValuesFromXML();
                    }
                    _lastUpdated = DateTime.Now;

                    return true;
                }
            }
            catch (InvalidCastException e)
            {
                //See if there is an instance of the icp we can re-connect to
                System.Diagnostics.Process[] procList;

                procList = System.Diagnostics.Process.GetProcessesByName("isisicp");

                if (procList.Length > 0)
                {
                    connectToIcp();
                }

                throw new Exception(e.Message);
            }
            catch (COMException e)
            {
                //See if there is an instance of the icp we can re-connect to
                System.Diagnostics.Process[] procList;

                procList = System.Diagnostics.Process.GetProcessesByName("isisicp");

                if (procList.Length > 0)
                {
                    connectToIcp();
                }

                throw new Exception(e.Message);
            }
            catch (Exception e)
            {
                throw new Exception(e.Message);
            }

            return false;
        }

        private static void getValuesFromXML()
        {
            //Create xml document
            XmlDocument xml = new XmlDocument();
            xml.InnerXml = _daeData;

            String oldRN = "";

            //Get the strings
            XmlNodeList nodelist = xml.SelectNodes("/Cluster/String");

            for (int i = 0; i < nodelist.Count; ++i)
            {
                if (nodelist[i].FirstChild.InnerText == "RBNumber")
                {
                    _rbNumber = nodelist[i].LastChild.InnerText;
                }
                else if (nodelist[i].FirstChild.InnerText == "RunTitle")
                {
                    _runTitle = nodelist[i].LastChild.InnerText;
                }
                else if (nodelist[i].FirstChild.InnerText == "UserName")
                {
                    _userName = nodelist[i].LastChild.InnerText;
                }
                else if (nodelist[i].FirstChild.InnerText == "RunNumber")
                {
                    oldRN = _runNumber;
                    _runNumber = nodelist[i].LastChild.InnerText;

                    //if (oldRN != null)
                    //{
                    //    if (_runNumber != oldRN)
                    //    {
                    //        if (RunEnded != null)
                    //        {
                    //            RunEnded(DateTime.Now, oldRN);
                    //        }
                    //    }
                    //}
                }
                else if (nodelist[i].FirstChild.InnerText == "StartTime")
                {
                    _startTime = nodelist[i].LastChild.InnerText;
                }
            }

            //Get the U32s
            nodelist = xml.SelectNodes("/Cluster/U32");

            for (int i = 0; i < nodelist.Count; ++i)
            {
                if (nodelist[i].FirstChild.InnerText == "GoodFramesTotal")
                {
                    _goodFramesTotal = nodelist[i].LastChild.InnerText;
                }
                else if (nodelist[i].FirstChild.InnerText == "RawFramesTotal")
                {
                    _rawFramesTotal = nodelist[i].LastChild.InnerText;
                }
                else if (nodelist[i].FirstChild.InnerText == "GoodFramesPeriod")
                {
                    _goodFramesPeriod = nodelist[i].LastChild.InnerText;
                }
                else if (nodelist[i].FirstChild.InnerText == "RawFramesPeriod")
                {
                    _rawFramesPeriod = nodelist[i].LastChild.InnerText;
                }
                else if (nodelist[i].FirstChild.InnerText == "RunDurationTotal")
                {
                    int time = Convert.ToInt32(nodelist[i].LastChild.InnerText);
                    TimeSpan actual = new TimeSpan(0, 0, 0, time);

                    _runDurationTotal = actual.ToString();
                }
                else if (nodelist[i].FirstChild.InnerText == "RunDurationPeriod")
                {
                    int time = Convert.ToInt32(nodelist[i].LastChild.InnerText);
                    TimeSpan actual = new TimeSpan(0, 0, 0, time);

                    _runDurationPeriod = actual.ToString();
                }
                else if (nodelist[i].FirstChild.InnerText == "NumberOfTimeChannels")
                {
                    _numberOfTimeChannels = nodelist[i].LastChild.InnerText;
                }
                else if (nodelist[i].FirstChild.InnerText == "DAEMemoryUsed")
                {
                    _daeMemoryUsed = nodelist[i].LastChild.InnerText;
                }
                else if (nodelist[i].FirstChild.InnerText == "NumberOfPeriods")
                {
                    _numberOfPeriods = nodelist[i].LastChild.InnerText;
                }
                else if (nodelist[i].FirstChild.InnerText == "CurrentPeriod")
                {
                    _currentPeriod = nodelist[i].LastChild.InnerText;
                }
                else if (nodelist[i].FirstChild.InnerText == "NumberOfSpectra")
                {
                    _numberOfSpectra = nodelist[i].LastChild.InnerText;
                }
                else if (nodelist[i].FirstChild.InnerText == "MonitorCounts")
                {
                    _monitorCounts = nodelist[i].LastChild.InnerText;
                }
                else if (nodelist[i].FirstChild.InnerText == "PeriodSequence")
                {
                    _periodSequence = nodelist[i].LastChild.InnerText;
                }
            }

            //Get the I32s
            nodelist = xml.SelectNodes("/Cluster/I32");

            for (int i = 0; i < nodelist.Count; ++i)
            {
                if (nodelist[i].FirstChild.InnerText == "MonitorSpectrum")
                {
                    _monitorSpectrum = nodelist[i].LastChild.InnerText;
                }
            }

            //Get the DBLs
            nodelist = xml.SelectNodes("/Cluster/DBL");

            for (int i = 0; i < nodelist.Count; ++i)
            {
                if (nodelist[i].FirstChild.InnerText == "BeamCurrent")
                {
                    _beamCurrent = nodelist[i].LastChild.InnerText;
                }
                else if (nodelist[i].FirstChild.InnerText == "TotalUAmps")
                {
                    _totalUAmps = nodelist[i].LastChild.InnerText;
                }
                else if (nodelist[i].FirstChild.InnerText == "TotalDAECounts")
                {
                    _totalDaeCounts = nodelist[i].LastChild.InnerText;
                }
                else if (nodelist[i].FirstChild.InnerText == "MonitorFrom")
                {
                    _monitorFrom = nodelist[i].LastChild.InnerText;
                }
                else if (nodelist[i].FirstChild.InnerText == "MonitorTo")
                {
                    _monitorTo = nodelist[i].LastChild.InnerText;
                }
                else if (nodelist[i].FirstChild.InnerText == "CountRate")
                {
                    _countRate = nodelist[i].LastChild.InnerText;
                }
            }

            //Get the EWs
            nodelist = xml.SelectNodes("/Cluster/EW");

            for (int i = 0; i < nodelist.Count; ++i)
            {
                if (nodelist[i].FirstChild.InnerText == "RunStatus")
                {
                    String val = nodelist[i].LastChild.InnerText;
                    String oldStatus = _runStatus;

                    if (val == "0")
                    {
                        _runStatus = "PROCESSING";
                    }
                    else if (val == "1")
                    {
                        _runStatus = "SETUP";
                    }
                    else if (val == "2")
                    {
                        _runStatus = "RUNNING";
                    }
                    else if (val == "3")
                    {
                        _runStatus = "PAUSED";
                    }
                    else if (val == "4")
                    {
                        _runStatus = "WAITING";
                    }
                    else if (val == "5")
                    {
                        _runStatus = "VETOING";
                    }
                    else if (val == "6")
                    {
                        _runStatus = "ENDING";
                    }
                    else if (val == "7")
                    {
                        _runStatus = "SAVING";
                    }
                    else
                    {
                        _runStatus = "UNKNOWN";
                    }

                    if (oldStatus == "SETUP" && _runStatus != "SETUP")
                    {
                        //run has started
                        if (RunStarted != null)
                        {
                            RunStarted(DateTime.Now, _runNumber);
                        }
                    }

                    if (oldStatus != "SETUP" && _runStatus == "SETUP")
                    {
                        if (RunEnded != null)
                        {
                            RunEnded(DateTime.Now, oldRN);
                        }
                    }

                }
                else if (nodelist[i].FirstChild.InnerText == "DAETimingSource")
                {
                    String val = nodelist[i].LastChild.InnerText;

                    if (val == "0")
                    {
                        _DaeTimingSource = "ISIS";
                    }
                    else if (val == "1")
                    {
                        _DaeTimingSource = "Internal";
                    }
                    else if (val == "2")
                    {
                        _DaeTimingSource = "SMP";
                    }
                    else if (val == "3")
                    {
                        _DaeTimingSource = "Muon";
                    }
                    else if (val == "4")
                    {
                        _DaeTimingSource = "Muon MS";
                    }
                    else if (val == "5")
                    {
                        _DaeTimingSource = "ISIS (first TS1)";
                    }
                }
            }
        }

        internal static List<String> GetFormattedValues(Boolean includeUserInfo, Boolean isMuon)
        {
            List<String> lines = new List<String>();

            lines.Add("Run Status: " + _runStatus);
            lines.Add("Run Number: " + _runNumber);

            if (includeUserInfo)
            {
                lines.Add("RB Number: " + _rbNumber);
                lines.Add("User(s): " + _userName);
                lines.Add("Title: " + _runTitle);
            }
            else
            {
                lines.Add("RB Number: Unavailable");
                lines.Add("User(s): Unavailable");
                lines.Add("Title: Unavailable");
            }

            lines.Add("Start Time: " + _startTime);
            lines.Add("Total Run Time: " + _runDurationTotal);
            lines.Add("Period Run Time: " + _runDurationPeriod);
            lines.Add("Good Frames (Total): " + _goodFramesTotal);
            lines.Add("Good Frames (Period): " + _goodFramesPeriod);
            lines.Add("Raw Frames (Total): " + _rawFramesTotal);
            lines.Add("Raw Frames (Period): " + _rawFramesPeriod);
            lines.Add("Current Period: " + _currentPeriod);
            lines.Add("Number Of Periods: " + _numberOfPeriods);
            lines.Add("Period Sequence: " + _periodSequence);
            lines.Add("Beam Current: " + _beamCurrent);

            if (isMuon)
            {
                lines.Add("Total MEv: " + _totalDaeCounts);
            }
            else
            {
                lines.Add("Total UAmps: " + _totalUAmps);
            }

            lines.Add("Count-Rate: " + _countRate);

            if (!isMuon)
            {
                lines.Add("DAE Memory Used: " + _daeMemoryUsed);
                lines.Add("Total DAE Counts: " + _totalDaeCounts);
                lines.Add("DAE Timing Source: " + _DaeTimingSource);
                lines.Add("Monitor Counts: " + _monitorCounts);
                lines.Add("Monitor Spectrum: " + _monitorSpectrum);
                lines.Add("Monitor From: " + _monitorFrom);
                lines.Add("Monitor To: " + _monitorTo);
                lines.Add("Number Of Time Channels: " + _numberOfTimeChannels);
                lines.Add("Number Of Spectra: " + _numberOfSpectra);
            }

            return lines;
        }

        #endregion

        #region Set run status

        internal static void BeginRun()
        {
            if (_icp != null)
            {
                String messages = "";
                _icp.beginRun(out messages);
            }
        }

        internal static void EndRun()
        {
            if (_icp != null)
            {
                String messages = "";
                _icp.endRun(out messages);
            }
        }

        internal static void PauseRun()
        {
            if (_icp != null)
            {
                String messages = "";
                _icp.pauseRun(out messages);
            }
        }

        internal static void ResumeRun()
        {
            if (_icp != null)
            {
                String messages = "";
                _icp.resumeRun(out messages);
            }
        }

        internal static void AbortRun()
        {
            if (_icp != null)
            {
                String messages = "";
                _icp.abortRun(out messages);
            }
        }

        internal static void SaveRun()
        {
            if (_icp != null)
            {
                String messages = "";
                _icp.saveRun(out messages);
            }
        }

        internal static void UpdateRun()
        {
            //Not implemented in pc-icp yet
        }

        internal static void StoreRun()
        {
            //Not implemented in pc-icp yet
        }

        internal static void BeginWaiting()
        {
            if (_icp != null)
            {
                String messages = "";
                _icp.startSEWait(out messages);
                _inWaitingState = true;
            }
        }

        internal static void EndWaiting()
        {
            if (_icp != null)
            {
                String messages = "";
                _icp.endSEWait(out messages);
                _inWaitingState = false;
            }
        }

        #endregion

    }
}