LabViewPanel.cs

Go to the documentation of this file.

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

namespace Seci.LabView
{
    class LabViewPanel
    {
        private strongnameLabview.VirtualInstrument _VI;

        private Dictionary<String, Controls.LvControl> _controls;

        private String _frontPanelTitle; //The name on the front panel - needed for winapi calls

        //Properties
        public strongnameLabview.VirtualInstrument VI { get { return _VI; } }
        public String FrontPanelTitle { get { return _frontPanelTitle; } }

        public LabViewPanel(strongnameLabview.VirtualInstrument VI)
        {
            //Create an new instance of the Controls
            _controls = new Dictionary<String, Controls.LvControl>();

            //Assign VI
            _VI = VI;
        }

        public void GetFrontPanelTitle(strongnameLabview.VirtualInstrument exporter, String fileName)
        {
            exporter.SetControlValue("VI Path", fileName);
            exporter.Run(false);
            _frontPanelTitle = exporter.GetControlValue("Title").ToString();
            exporter.SetControlValue("Title", ""); //Clear for future use
        }

        #region Get Controls

        public void getVIControls(strongnameLabview.VirtualInstrument exporter, String fileName, Boolean includeClusters)
        {
            try
            {
                String savefile = Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData) + "\\LVPanelControls.txt";
                exportVIControls(exporter, fileName, savefile);
                extractVIControls(savefile, includeClusters);
            }
            catch (GetControlsException e)
            {
                //Log it and carry on
                Helpers.ErrorLogger.LabViewError("GetControls", e.Message + ": " + fileName);
            }
            catch (Exception e)
            {
                //throw error up to next level
                throw new LabViewException(e.Message);
            }
        }

        private static void exportVIControls(strongnameLabview.VirtualInstrument exporter, String fileName, String saveFile)
        {
            //Check dump file deleted
            FileInfo fi = new FileInfo(saveFile);

            if (fi.Exists)
            {
                fi.Delete();
            }

            //First export the control list
            exporter.SetControlValue("VI Path", fileName);
            exporter.SetControlValue("Output Path", saveFile);
            exporter.Run(false);
        }

        private void extractVIControls(String fileName, Boolean includeClusters)
        {
            //Extract the name of the controls on the frontpanel from the textfile
            try
            {
                //Check file exists
                FileInfo FI = new FileInfo(fileName);

                if (FI.Exists)
                {
                    //Create new StreamReader
                    using (StreamReader sr = new StreamReader(fileName))
                    {
                        //Readlines until <CONTENT> is found; this is the start of the control list
                        bool FoundStart = false;

                        do
                        {
                            String temp = sr.ReadLine();

                            if (temp.StartsWith("<CONTENT>", StringComparison.Ordinal))
                            {
                                FoundStart = true;
                                break;
                            }

                        } while (sr.Peek() >= 0); //end if next line is EOF

                        //Now look for controls
                        if (FoundStart == true) //else end of file was reached and there are no controls
                        {
                            String myLine;
                            String controlType;
                            String controlName;

                            do
                            {
                                //Read next line and trim whitespace
                                myLine = sr.ReadLine();
                                myLine = myLine.Trim();

                                //Check to see if line starts with <PARTS>, if so readline until </PARTS>
                                if (myLine.StartsWith("<PARTS>", StringComparison.Ordinal))
                                {
                                    do
                                    {
                                        //Step through
                                        myLine = sr.ReadLine();
                                        myLine = myLine.Trim();
                                    } while (!myLine.Contains("</PARTS>"));
                                }

                                if (myLine.Contains("<LF>"))
                                {
                                    //control name contains a \n!!
                                    //So read next line and cobble together the correct string
                                    String myLine2 = sr.ReadLine();
                                    myLine = myLine.Substring(0, myLine.IndexOf("<LF>", StringComparison.Ordinal)) + myLine2;
                                    myLine = myLine.Trim();
                                }

                                //Debug
                                //Console.WriteLine(myLine);

                                //Check for a control
                                if (myLine.StartsWith("<CONTROL ID"))
                                {
                                    //Find control name
                                    controlName = findControlName(myLine);

                                    //Only do if control name is not null
                                    if (controlName != null)
                                    {
                                        //Find control type
                                        controlType = findControlType(myLine);

                                        //Check to see the type of control
                                        if ((controlType == "Cluster"))
                                        {
                                            //it is a cluster
                                            getClusterInfo(sr, controlName, null, includeClusters);
                                        }
                                        else if (controlType == "Radio Buttons")
                                        {
                                            //It is a Radio button
                                            //When a radio button is queried for a value, it returns an integer
                                            //representing the option which is true.

                                            addRadioButton(sr, controlName, null);
                                        }
                                        else if (controlType == "Ring")
                                        {
                                            addRing(sr, controlName, null);
                                        }
                                        else if (controlType == "Listbox")
                                        {
                                            addListbox(sr, controlName, null);
                                        }
                                        else if (controlType == "Numeric" || controlType == "Boolean"
                                            || controlType == "String" || controlType == "Enum"
                                            || controlType == "Array")
                                        {
                                            //It is a numeric, boolean, enum, array, or string, so add it to the controls list
                                            addSimpleControl(sr, controlName, controlType, null);
                                        }
                                        else
                                        {
                                            //unknown control, do nothing
                                        }
                                    }
                                }
                                else
                                {
                                    //go to next line
                                }

                            } while (sr.Peek() >= 0); //read to end of file
                        }

                    } //End of using statement

                    //Delete the file                
                    FI.Delete();
                }
                else
                {
                    //throw error up to next level
                    throw new GetControlsException("Could not get control list");
                }
            }
            catch
            {
                //throw error up to next level
                throw;
            }
        }

        private static String findControlType(String line)
        {
            //See what the type is and return that
            if (line.Contains("type=\"String\""))
            {
                return "String";
            }
            else if (line.Contains("type=\"Numeric\""))
            {
                return "Numeric";
            }
            else if (line.Contains("type=\"Boolean\""))
            {
                return "Boolean";
            }
            else if (line.Contains("type=\"Array\""))
            {
                return "Array";
            }
            else if (line.Contains("type=\"Cluster\""))
            {
                return "Cluster";
            }
            else if (line.Contains("type=\"Radio Buttons\""))
            {
                return "Radio Buttons";
            }
            else if (line.Contains("type=\"Enum\""))
            {
                return "Enum";
            }
            else if (line.Contains("type=\"Ring\""))
            {
                return "Ring";
            }
            else if (line.Contains("type=\"Listbox\""))
            {
                return "Listbox";
            }
            else if (line.Contains("type=\"Type Definition\""))
            {
                //Special case, as far as is known only the ILM uses these
                //for data that is likely to be shown as a block
                return "Numeric";
            }
            else if (line.Contains("type=\"Thermometer\""))
            {
                //Special case - treat as a numeric
                return "Numeric";
            }
            else if (line.Contains("type=\"Tank\""))
            {
                //Special case - treat as a numeric
                return "Numeric";
            }
            else if (line.Contains("type=\"Slide\""))
            {
                //Special case - treat as a numeric
                return "Numeric";
            }
            else if (line.Contains("type=\"Dial\""))
            {
                //Special case - treat as a numeric
                return "Numeric";
            }
            else if (line.Contains("type=\"Knob\""))
            {
                //Special case - treat as a numeric
                return "Numeric";
            }
            else if (line.Contains("type=\"Meter\""))
            {
                //Special case - treat as a numeric
                return "Numeric";
            }
            else
            {
                return null;
            }
        }

        private static String findControlName(String line)
        {
            //Split line where " occurs; we need the fourth portion
            String[] tempString = line.Split('\"');

            //If it is not the size expected then return null
            if (tempString.GetLength(0) == 5)
            {
                return tempString[3].ToString();
            }
            else
            {
                return null;
            }
        }

        private void addSimpleControl(StreamReader sr, String name, String type, SerialisableList<int> clusterIndices)
        {
            try
            {
                Controls.LvControl newControl;

                if (type == "Numeric")
                {
                    newControl = new Controls.LvNumeric(name, clusterIndices);

                    //Add the control to the dictionary
                    AddControlToDictionary(newControl);
                }
                else if (type == "String")
                {
                    newControl = new Controls.LvString(name, clusterIndices);

                    //Add the control to the dictionary
                    AddControlToDictionary(newControl);
                }
                else if (type == "Boolean")
                {
                    newControl = new Controls.LvBoolean(name, clusterIndices);

                    //Add the control to the dictionary
                    AddControlToDictionary(newControl);
                }
                else if (type == "Enum")
                {
                    newControl = new Controls.LvEnum(name, clusterIndices);

                    //Add the control to the dictionary
                    AddControlToDictionary(newControl);
                }
                else if (type == "Array")
                {
                    newControl = new Controls.LvArray(name, clusterIndices);

                    //Add the control to the dictionary
                    AddControlToDictionary(newControl);

                    //Need to skip past the remaining info in the array definition
                    String myLine;
                    int count = 1;

                    do
                    {
                        myLine = sr.ReadLine();
                        myLine = myLine.Trim();

                        if (myLine.Contains("<CONTROL"))
                        {
                            count++;
                        }
                        else if (myLine.Contains("</CONTROL>"))
                        {
                            count--;
                        }

                    } while (count != 0);
                }
            }
            catch (System.ArgumentException)
            {
                //Is most likely that the VI has two items with the same name,
                //in this case just carry on without adding it.
                //Won't log it as it is not a problem.
                //ErrorLogger.SeciError("addSimpleControl, ControlName: " + name, e);
            }
            catch (Exception e)
            {
                //throw error up to next level
                throw new ArgumentException(e.Message);
            }
        }

        private void addRing(StreamReader sr, String ringName, SerialisableList<int> clusterIndices)
        {
            //Get the ring items
            try
            {
                String myLine;
                String[] items = null;

                do
                {
                    myLine = sr.ReadLine();
                    myLine = myLine.Trim();

                    //Debug
                    //Console.WriteLine(myLine);

                    //Check for a control
                    if (myLine.StartsWith("<PART ID=12 order=0 type=\"Ring Text\">", StringComparison.Ordinal))
                    {
                        //Find item names                      
                        String temp = myLine.Substring(myLine.IndexOf("<STRING>", StringComparison.Ordinal) + 8);
                        temp = temp.Remove(temp.IndexOf("</STRING></STRINGS>", StringComparison.Ordinal));
                        temp = temp.Replace("</STRING><STRING>", "|");

                        items = temp.Split('|');
                        break;
                    }

                } while (myLine.Contains("</CONTROL>") == false);

                //Add the control
                Controls.LvRing newControl = new Controls.LvRing(ringName, items, clusterIndices);

                //Add the control to the dictionary
                AddControlToDictionary(newControl);
            }
            catch (Exception e)
            {
                //throw error up to next level
                throw new ArgumentException(e.Message);
            }
        }

        private void addListbox(StreamReader sr, String boxName, SerialisableList<int> clusterIndices)
        {
            //Get the ring items
            try
            {
                String myLine;
                String[] items = null;

                do
                {
                    myLine = sr.ReadLine();
                    myLine = myLine.Trim();

                    //Debug
                    //Console.WriteLine(myLine);

                    //Check for a control
                    if (myLine.StartsWith("<PRIV><ITEMS><STRING>", StringComparison.Ordinal))
                    {
                        //Find item names                      
                        String temp = myLine.Substring(myLine.IndexOf("<STRING>", StringComparison.Ordinal) + 8);
                        temp = temp.Remove(temp.IndexOf("</STRING></ITEMS></PRIV", StringComparison.Ordinal));
                        temp = temp.Replace("</STRING><STRING>", "|");

                        items = temp.Split('|');
                        break;
                    }

                } while (myLine.Contains("</CONTROL>") == false);

                //Add the control
                Controls.LvRing newControl = new Controls.LvRing(boxName, items, clusterIndices);

                //Add the control to the dictionary
                AddControlToDictionary(newControl);
            }
            catch (Exception e)
            {
                //throw error up to next level
                throw new ArgumentException(e.Message);
            }
        }

        private void AddControlToDictionary(Controls.LvControl newControl)
        {
            try
            {
                if (!_controls.ContainsKey(newControl.Name))
                {
                    _controls.Add(newControl.Name, newControl);
                }
            }
            catch (Exception err)
            {
                //Fail silently and don't log anymore
                //Helpers.ErrorLogger.SeciError("addControlToDictionary", err);
            }
        }

        private void addRadioButton(StreamReader sr, String radioName, SerialisableList<int> clusterIndices)
        {
            //Get the radio buttons
            try
            {
                String myLine;
                List<String> items = new List<String>();

                do
                {
                    myLine = sr.ReadLine();
                    myLine = myLine.Trim();

                    //Check for a control
                    if (myLine.StartsWith("<CONTROL ID", StringComparison.Ordinal))
                    {
                        //Add the item name to the list
                        items.Insert(0, findControlName(myLine));
                    }

                } while (myLine.Contains("</CONTENT>") == false);

                //Add the control
                Controls.LvRadioButtons newControl = new Controls.LvRadioButtons(radioName, items.ToArray(), clusterIndices);

                //Add the control to the dictionary
                AddControlToDictionary(newControl);

            }
            catch (Exception e)
            {
                //throw error up to next level
                throw new ArgumentException(e.Message);
            }
        }

        private void getClusterInfo(StreamReader sr, String clusterName, SerialisableList<int> clusterList, Boolean includeClusters)
        {
            //Get all the controls in the cluster or array and add them to the list
            try
            {
                String myLine;
                String controlType;
                String controlName;
                int clusterCount = 0;

                //we use the arraylist to store all the indices of the cluster, this
                //should handle nested clusters
                if (clusterList == null)
                {
                    //If it is a toplevel cluster then we need to create the arraylist
                    clusterList = new SerialisableList<int>();
                }

                do
                {
                    myLine = sr.ReadLine();
                    myLine = myLine.Trim();

                    //Debug
                    //Console.WriteLine(myLine);

                    //Check for a control
                    if (myLine.StartsWith("<CONTROL ID", StringComparison.Ordinal))
                    {
                        //Find control name
                        controlName = findControlName(myLine);

                        //Find control type
                        controlType = findControlType(myLine);

                        //Check to see the type of control
                        if (controlType == "Cluster")
                        {
                            //it is a cluster 
                            //Add the index to the list
                            clusterList.Add(clusterCount);

                            //Fill the cluster - recursion!
                            getClusterInfo(sr, clusterName + ":" + controlName, clusterList, includeClusters);

                            //Remove the last index in case there are more controls to add in this cluster
                            clusterList.RemoveAt(clusterList.Count - 1);
                        }
                        else if (controlType == "Radio Buttons")
                        {
                            clusterList.Add(clusterCount);

                            if (includeClusters)
                            {
                                addRadioButton(sr, clusterName + ":" + controlName, clusterList);
                            }

                            //Remove the last index in case there are more controls to add in this cluster
                            clusterList.RemoveAt(clusterList.Count - 1);
                        }
                        else if (controlType == "Ring")
                        {
                            //Add the index to the list
                            clusterList.Add(clusterCount);

                            //Add the control
                            if (includeClusters)
                            {
                                addRing(sr, clusterName + ":" + controlName, clusterList);
                            }

                            //Remove the last index in case there are more controls to add in this cluster
                            clusterList.RemoveAt(clusterList.Count - 1);
                        }
                        else if (controlType == "Numeric" || controlType == "Boolean"
                            || controlType == "String" || controlType == "Enum"
                            || controlType == "Array")
                        {
                            //It is a numeric, boolean, array or string, so add it to the controls list
                            //Add the index to the list
                            clusterList.Add(clusterCount);

                            //Add the control
                            if (includeClusters)
                            {
                                addSimpleControl(sr, clusterName + ":" + controlName, controlType, clusterList);
                            }

                            //Remove the last index in case there are more controls to add in this cluster
                            clusterList.RemoveAt(clusterList.Count - 1);
                        }
                        else
                        {
                            //It is a unknown control
                        }
                        clusterCount++;
                    }

                } while (myLine.Contains("</CONTENT>") == false);

            }
            catch (Exception e)
            {
                //throw error up to next level
                throw new ArgumentException(e.Message);
            }
        }

        public List<String> getListOfControls()
        {
            try
            {
                Dictionary<string, Controls.LvControl>.KeyCollection keys = _controls.Keys;
                List<String> listControls = new List<String>(); //this is used to store the controls as they are added

                foreach (String name in keys)
                {
                    listControls.Add(_controls[name].GetNameAndType());
                }

                return listControls;
            }
            catch (Exception e)
            {
                //throw error up to next level
                throw new ArgumentException(e.Message);
            }
        }

        public String GetControlType(String name)
        {
            if (name.EndsWith(")"))
            {
                name = name.Substring(0, name.LastIndexOf('('));
            }

            return _controls[name.Trim()].GetControlType();
        }

        #endregion

        #region Get control value

        public String[] getControlValue(String controlName)
        {
            try
            {
                //Get the control
                Controls.LvControl control = _controls[controlName];

                return control.GetValue(ref _VI);
            }
            catch (Exception e)
            {
                //throw error up to next level
                throw new ArgumentException(e.Message);
            }
        }

        public Object getRawControlValue(String controlName)
        {
            //Just get the value straight from LV without doing any checks and do nothing to it
            try
            {
                return _VI.GetControlValue(controlName);
            }
            catch (Exception e)
            {
                //throw error up to next level
                throw new ArgumentException(e.Message);
            }
        }

        public Object[] getWholeCluster(string clusterName)
        {
            try
            {
                Object[] vals = (Object[])_VI.GetControlValue(clusterName);

                return vals;
            }
            catch (Exception e)
            {
                //throw error up to next level
                throw new ArgumentException(e.Message);
            }
        }

        #endregion

        #region Set values on Panel

        public void setControlValue(String controlName, Object value)
        {
            //Set the value on the front panel, this can also include pushing buttons
            Controls.LvControl control = _controls[controlName];

            control.SetValue(ref _VI, value);
        }

        public void setRawControlValue(String controlName, Object value)
        {
            _VI.SetControlValue(controlName, value);
        }

        public void setWholeCluster(string clusterName, Object[] values)
        {
            try
            {
                _VI.SetControlValue(clusterName, values);

            }
            catch (Exception e)
            {
                //throw error up to next level
                throw new ArgumentException(e.Message);
            }
        }

        #endregion

        internal String FindControlNameAndType(String partialName)
        {
            List<String> keys = new List<string>();
            keys.AddRange(_controls.Keys);

            foreach (String key in keys)
            {
                if (key == partialName)
                {
                    return _controls[key].GetNameAndType();
                }
            }

            return partialName;
        }
    }
}