LabViewMessageQueue.cs

Go to the documentation of this file.

using System;
using System.Collections;
using System.Collections.Generic;
using System.Text;
using System.IO;
using Seci.Definitions;

namespace Seci.Standard
{
    public static class MessageQueue
    {
        private static String _filePath;     // The location of the Message Panel VI

        private static SerialisableList<MessageInfo> _messages = new SerialisableList<MessageInfo>();

        //Timeouts
        private static int _timeoutTime = 1;  // If message is set to time out then use this value (in minutes).
        private static int _defaultPeriod = 60;   // If message is not set to time out then delete after this many minutes.

        //Properties
        public static SerialisableList<MessageInfo> Messages { get { return _messages; } }

        public static void InitialiseMessQVI()
        {
            _filePath = Status.MessagePanelVI;

            //Load VI
            LabView.LabViewApp.LoadVI(_filePath, true);

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

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

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

        public static Boolean UpdateMessages()
        {
            Boolean updates = removeMessages();
            Boolean newmessages = getMessageQ();  

            return (newmessages || updates);
        }

        private static Boolean getMessageQ()
        {
            //Take the message panel off hold and then wait for the done flag.
            //Basically when the panel is taken off hold it reads the queue and 
            //then the done light comes on.
            Boolean MessagesChanged = false;

            try
            {
                LabView.LabViewApp.SetValue(_filePath, "Hold", false);

                int counter = 0;

                while (LabView.LabViewApp.GetValue(_filePath, "Done")[0].ToLower() != "true")
                {
                    System.Threading.Thread.Sleep(50);
                    counter++;

                    //Safety valve - if this takes too long assume the VI has a problem
                    if (counter > 500)
                    {
                        //Problem, so throw exception
                        throw new LabView.LabViewException("getErrorQ - Could not get information from message panel VI.");
                    }
                }

                //Reset the duplicate counts
                for (int i = 0; i < _messages.Count; ++i)
                {
                    _messages[i].Count = 1;
                }

                //brief pause to allow LabVIEW to catch up
                System.Threading.Thread.Sleep(250);

                //Process the queue
                Object[] temp = LabView.LabViewApp.GetCluster(_filePath, "Queue");

                for (int i = 0; i < temp.GetLength(0); ++i)
                {
                    Object[] Qmember = (Object[])temp[i];

                    MessageInfo newMess = new MessageInfo();

                    newMess.Message = Qmember[0].ToString();
                    newMess.OriginalMess = Qmember[0].ToString();
                    newMess.YesText = Qmember[1].ToString();
                    newMess.NoText = Qmember[2].ToString();
                    newMess.Timeout = (Boolean)Qmember[3];
                    newMess.WaitForResponse = (Boolean)Qmember[4];
                    newMess.VIName = Qmember[5].ToString();
                    newMess.UserReplied = (Boolean)Qmember[6];
                    newMess.Timestamp = Qmember[8].ToString();

                    if (newMess.UserReplied)
                    {
                        //Just in case an answered question slips through
                        continue;
                    }

                    //Replace \n \r chars in Message with spaces
                    newMess.Message = newMess.Message.Replace('\n', ' ');
                    newMess.Message = newMess.Message.Replace('\r', ' ');

                    //See if error already exists by comparing VIname and Message
                    Boolean duplicate = false;

                    for (int j = 0; j < _messages.Count; ++j)
                    {
                        if ((_messages[j].Message == newMess.Message) && (_messages[j].VIName == newMess.VIName))
                        {
                            //it is a duplicate, so increase count
                            if (_messages[j].Timestamp != newMess.Timestamp)
                            {
                                _messages[j].Count += 1;
                                if (_messages[j].Count > 1000)
                                {
                                    //Just in case
                                    _messages[j].Count = 1000;
                                }
                            }
                            duplicate = true;
                            break;
                        }
                    }

                    if (duplicate)
                    {
                        MessagesChanged = true;
                    }
                    else
                    {
                        //Set time added
                        newMess.TimeAdded = DateTime.Now;
                        _messages.Add(newMess);

                        //Log the message
                        Seci.Helpers.ErrorLogger.LabViewError(newMess.VIName, newMess.Message);

                        //Flag that the messages have changed
                        MessagesChanged = true;
                    }
                }
            }
            catch (Exception err)
            {
                Seci.Helpers.ErrorLogger.SeciError("getMessageQ", err);
            }

            return MessagesChanged;
        }

        private static Boolean removeMessages()
        {
            //Send the data back to the message panel VI
            Boolean anyReplies = false;

            try
            {
                //First create a cluster from the message array list
                Object[] qVals = LabView.LabViewApp.GetCluster(_filePath, "Queue");

                List<int> repliedTo = new List<int>();

                for (int i = 0; i < _messages.Count; ++i)
                {
                    for (int j = 0; j < qVals.GetLength(0); ++j)
                    {
                        Object[] Qmember = (Object[])qVals[j];

                        //Message = Qmember[0]
                        //VI = Qmember[5]
                        //Replied = Qmember[6]
                        //Response = Qmember[7]

                        if (_messages[i].UserReplied && _messages[i].Message == Qmember[0].ToString() && _messages[i].VIName == Qmember[5].ToString())
                        {
                            //Then we have a reply
                            anyReplies = true;
                            Qmember[6] = true;
                            Qmember[7] = _messages[i].Response;
                            repliedTo.Add(i);
                        }
                        else if (_messages[i].Timeout == true && _messages[i].Message == Qmember[0].ToString() && _messages[i].VIName == Qmember[5].ToString())
                        {
                            //Set to timeout
                            if (_messages[i].TimeAdded <= DateTime.Now.Subtract(new TimeSpan(0, 0, _timeoutTime, 0, 0)))
                            {
                                if (!_messages[i].UserReplied)
                                {
                                    //Mark for removal, by replying false
                                    Qmember[6] = true;
                                    Qmember[7] = false;
                                    anyReplies = true;
                                    repliedTo.Add(i);
                                }
                            }
                        }
                        else if (_messages[i].TimeAdded <= DateTime.Now.Subtract(new TimeSpan(0, 0, _defaultPeriod, 0, 0)))
                        {
                            //Not set to timeout
                            if (!_messages[i].UserReplied)
                            {
                                //Mark for removal, by replying false
                                Qmember[6] = true;
                                Qmember[7] = false;
                                anyReplies = true;
                                repliedTo.Add(i);
                            }
                        }

                        qVals[j] = Qmember;
                    }
                }

                LabView.LabViewApp.SetCluster(_filePath, "Queue", qVals);

                //remove any messages where the user responded and the response has been sent to the VI
                for (int i = repliedTo.Count - 1; i >= 0; i--)
                {
                    if (_messages.Count > repliedTo[i])
                    {
                        _messages.RemoveAt(repliedTo[i]);
                    }
                }
            }
            catch (Exception err)
            {
                Seci.Helpers.ErrorLogger.SeciError("removeMessages", err);
            }

            return anyReplies;
        }

        public static void SendReply(String questionMessage, String source, Boolean reply)
        {
            //Find the message number
            int messNumb = -1;

            for (int i = 0; i < _messages.Count; ++i)
            {
                if ((questionMessage == _messages[i].Message) && (source == _messages[i].VIName))
                {
                    //Found the right message
                    messNumb = i;
                    break;
                }
            }

            if (messNumb != -1)
            {
                //Change message to show that the user has replied
                _messages[messNumb].Response = reply;
                _messages[messNumb].UserReplied = true;

                //Log reply
                Seci.Helpers.ErrorLogger.LabViewError(_messages[messNumb].VIName, _messages[messNumb].Message + " - User replied " + _messages[messNumb].Response);
            }
        }
    }

    public class MessageInfo
    {
        //Members
        private String _message;              
        private String _originalMess;         
        private Boolean _timeout;             
        private DateTime _timeAdded;          
        private Boolean _waitForResponse;     
        private String _viName;               
        private String _yesText;              
        private String _noText;               
        private int _priority;                
        private int _count = 1;                   
        private String _timestamp;            
        private Boolean _response;            
        private Boolean _userReplied;         

        public String Message { get { return _message; } set { _message = value; } }
        public String OriginalMess { get { return _originalMess; } set { _originalMess = value; } }
        public Boolean Timeout { get { return _timeout; } set { _timeout = value; } }
        public Boolean WaitForResponse { get { return _waitForResponse; } set { _waitForResponse = value; } }
        public String VIName { get { return _viName; } set { _viName = value; } }
        public DateTime TimeAdded { get { return _timeAdded; } set { _timeAdded = value; } }
        public String YesText { get { return _yesText; } set { _yesText = value; } }
        public String NoText { get { return _noText; } set { _noText = value; } }
        public int Priority { get { return _priority; } set { _priority = value; } }
        public int Count { get { return _count; } set { _count = value; } }
        public String Timestamp { get { return _timestamp; } set { _timestamp = value; } }
        public Boolean Response { get { return _response; } set { _response = value; } }
        public Boolean UserReplied { get { return _userReplied; } set { _userReplied = value; } }

        public MessageInfo()
        {
        }

    }
}