LabViewApp.cs

Go to the documentation of this file.

using System;
using System.Collections.Generic;
using System.Collections;
using System.Text;
using System.IO;
using System.Diagnostics;
using System.Runtime.InteropServices;
using Seci.Definitions;

//This is the main LabVIEW class and all code should go through here

namespace Seci.LabView
{
    static class LabViewApp
    {
        private static strongnameLabview.Application _LV;

        private static Dictionary<String, LabViewPanel> _VIs;

        private static SerialisableList<LabViewPanelInfo> _panelsSettings;

        private static strongnameLabview.VirtualInstrument _controlsExporter;

        private static strongnameLabview.VirtualInstrument _titleExporter;

        private static List<String> _VIsNotLoaded = new List<String>();

        //Properties
        public static List<String> VIsNotLoaded { get { return _VIsNotLoaded; } }

        public static Boolean IsNull { get { return _LV == null; } }

        #region Start/Stop LabVIEW

        public static Boolean StartLabView(String executionDir)
        {
            _VIs = new Dictionary<string, LabViewPanel>();
            _panelsSettings = new SerialisableList<LabViewPanelInfo>();

            //Change the LabVIEW settings
            configureLabVIEW();

            //Start LabVIEW
            try
            {
                _LV = new strongnameLabview.Application();

                //Load the ControlsExporter and titleExporter
                _controlsExporter = _LV.GetVIReference(executionDir + "\\Required VIs\\Controls_Exporter.vi", "", false, 0);
                _titleExporter = _LV.GetVIReference(executionDir + "\\Required VIs\\GetPanelName.vi", "", false, 0);

            }
            catch (Exception e)
            {
                //throw error up to next level
                throw new LabViewException("startLabView - " + e.Message);
            }

            return true;
        }

        public static Boolean StopLabView()
        {
            //Check LabVIEW is running and if so kill the process
            try
            {
                if (_LV != null)
                {
                    //Stop LabVIEW by killing the process, this avoids save sub-vi etc.
                    System.Diagnostics.Process[] procList;

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

                    if (procList.GetLength(0) > 0)
                    {
                        procList[0].Kill();
                    }

                    //Give it a second to close down
                    System.Threading.Thread.Sleep(1000);
                    _VIs.Clear();
                }

            }
            catch (Exception err)
            {
                Helpers.ErrorLogger.SeciError("stopLabView", err);
                return false;
            }

            return true;
        }

        private static void configureLabVIEW()
        {
            String text = "";
            String line = "";
            Boolean hidden = false;

            FileInfo fi = new FileInfo(Status.LabViewIniFilePath);

            if (fi.Exists)
            {
                //Open the existing file and read in
                fi.IsReadOnly = false;

                StreamReader SR = new StreamReader(fi.FullName);

                try
                {
                    while ((line = SR.ReadLine()) != null)
                    {
                        if (line.StartsWith("hideRootWindow", StringComparison.Ordinal) && !hidden)
                        {
                            text += "hideRootWindow=True" + Environment.NewLine;
                            hidden = true;
                        }
                        else if (!line.StartsWith("toolPaletteLoc", StringComparison.Ordinal) && !line.StartsWith("menu.", StringComparison.Ordinal))
                        {
                            text += line + Environment.NewLine;
                        }
                    }

                    if (hidden == false)
                    {
                        text += "hideRootWindow=True" + Environment.NewLine;
                    }
                }
                catch (Exception err)
                {
                    text = "";
                    Seci.Helpers.ErrorLogger.SeciError("ConfigureLabVIEW", err);
                }
                finally
                {
                    SR.Close();
                }

                //Write out the new file
                if (!String.IsNullOrEmpty(text))
                {
                    StreamWriter SW = new StreamWriter(fi.FullName);

                    try
                    {
                        SW.Write(text);
                    }
                    catch (Exception err)
                    {
                        Seci.Helpers.ErrorLogger.SeciError("ConfigureLabVIEW", err);
                    }
                    finally
                    {
                        SW.Close();
                    }
                }
            }
        }

        public static Boolean AreYouThere()
        {
            try
            {
                String version = _LV.Version;
                return true;
            }
            catch
            {
                return false;
            }
        }

        #endregion

        #region Load\Close and Start\Stop VI

        public static Boolean LoadVI(String fileName, Boolean includeClusters)
        {
            return loadVI(fileName, null, includeClusters);
        }

        public static Boolean LoadVI(LabViewPanelInfo panelInfo, Boolean includeClusters)
        {
            return loadVI(panelInfo.FilePath, panelInfo, includeClusters);
        }

        private static bool loadVI(String filepath, LabViewPanelInfo panelInfo, Boolean includeClusters)
        {
            //Try to load the VI
            try
            {
                //Check VI has not already been loaded (this may happen if we are merging configs)
                if (!_VIs.ContainsKey(filepath.ToLower()))
                {
                    strongnameLabview.VirtualInstrument myVI;
                    myVI = _LV.GetVIReference(filepath, "", false, 0);

                    LabViewPanel newPanel = new LabViewPanel(myVI);
                    if (panelInfo != null)
                    {
                        _panelsSettings.Add(panelInfo);
                    }

                    _VIs.Add(filepath.ToLower(), newPanel);

                    GetControls(filepath, includeClusters);

                    getFrontPanelTitle(filepath);
                }
                else
                {
                    return false;
                }

            }
            catch (Exception e)
            {
                //throw error up to next level
                throw new LabViewException("loadVI - " + e.Message);
            }

            return true;
        }

        private static void getFrontPanelTitle(String fileName)
        {
            try
            {
                _VIs[fileName.ToLower()].GetFrontPanelTitle(_titleExporter, fileName);
            }
            catch (Exception e)
            {
                //throw error up to next level
                throw new LabViewException("getFrontPanelTitle - " + e.Message);
            }
        }

        public static String GetFrontPanelTitle(String fileName)
        {
            return _VIs[fileName.ToLower()].FrontPanelTitle;
        }

        public static void UpdateFrontPanelTitle(String fileName)
        {
            getFrontPanelTitle(fileName);
        }

        public static Boolean CloseVI(String fileName)
        {
            //Try to close the VI
            try
            {
                strongnameLabview.VirtualInstrument myVI;
                myVI = _VIs[fileName.ToLower()].VI;

                //Check it is not running first, if running then stop it
                if (myVI.ExecState != strongnameLabview.ExecStateEnum.eIdle)
                {
                    myVI.Abort();
                }

                //Panel must be visible before it can be closed
                myVI.FPWinOpen = true;

                myVI.CloseFrontPanel(); //This only closes the Frontpanel the vi is still in memory!

                _VIs.Remove(fileName.ToLower());   //Remove from dictionary

                //Now remove the panel settings
                foreach (LabViewPanelInfo panel in _panelsSettings)
                {
                    if (panel.FilePath.ToLower() == fileName.ToLower())
                    {
                        _panelsSettings.Remove(panel);
                        break;
                    }
                }

            }
            catch (Exception e)
            {
                //throw error up to next level
                throw new LabViewException("killVI - " + e.Message);
            }

            return true;
        }

        public static Boolean IsVIPresent(String fileName)
        {
            return _VIs.ContainsKey(fileName.ToLower());
        }

        public static Boolean IsVIRunning(String fileName)
        {
            //See if the VI is running
            try
            {
                strongnameLabview.VirtualInstrument VI = _VIs[fileName.ToLower()].VI;

                if (VI.ExecState == strongnameLabview.ExecStateEnum.eRunning || VI.ExecState == strongnameLabview.ExecStateEnum.eRunTopLevel)
                {
                    return true;
                }
                else
                {
                    return false;
                }
            }
            catch (Exception e)
            {
                //throw error up to next level
                throw new LabViewException("isVIRunning - " + e.Message);
            }
        }

        public static Boolean StartVI(String fileName)
        {
            //If the VI is not running then try and start it
            try
            {
                strongnameLabview.VirtualInstrument VI = _VIs[fileName.ToLower()].VI;

                if (VI.ExecState == strongnameLabview.ExecStateEnum.eIdle)
                {
                    VI.Run(true);
                }
            }
            catch (Exception e)
            {
                //throw error up to next level
                throw new LabViewException("startVI - " + e.Message);
            }

            return true;
        }

        public static Boolean StopVI(String fileName)
        {
            //If the VI is running stop it
            try
            {
                strongnameLabview.VirtualInstrument VI = _VIs[fileName.ToLower()].VI;

                if (VI.ExecState == strongnameLabview.ExecStateEnum.eIdle || VI.ExecState == strongnameLabview.ExecStateEnum.eRunTopLevel)
                {
                    VI.Abort();
                }

            }
            catch (Exception e)
            {
                //throw error up to next level
                throw new LabViewException("stopVI - " + e.Message);
            }

            return true;
        }

        #endregion

        #region Get LLB info

        public static List<String> GetLLBInfo(String fileName)
        {
            //A LLB file contains a library of VIs. We need to get a list of the VIs in it.
            //The only way i have found to do this (and i don't like it) is to use a NI VI
            //to extract the data.

            //See if vi used to search llb files exists
            FileInfo fi = new FileInfo(Status.ExecutionDir + "\\Required VIs\\getlibraryinfo.vi");

            if (!fi.Exists)
            {
                throw new FileNotFoundException("Could not find getlibraryinfo.vi!");
            }

            try
            {
                //First load the LLB to find what it contains via the getlibraryinfo.vi
                strongnameLabview.VirtualInstrument readerVI = _LV.GetVIReference(Status.ExecutionDir + "\\Required VIs\\getlibraryinfo.vi", "", false, 0);
                readerVI.SetControlValue("Library Name", fileName);

                //Run the VI
                readerVI.Run(false);

                //Collect the VIs in llb
                String temp = readerVI.GetControlValue("VI Names").ToString();

                List<String> viDetails = new List<string>();
                viDetails.AddRange(temp.Split('\n'));

                return viDetails;
            }
            catch (Exception e)
            {
                //throw error up to next level
                throw new LabViewException("getLLBInfo - " + e.Message);
            }
        }

        #endregion

        #region Displaying VIs

        public static Boolean ShowVI(String fileName)
        {
            //Display the VI
            try
            {
                strongnameLabview.VirtualInstrument VI = _VIs[fileName.ToLower()].VI;
                VI.FPWinIsFrontMost = true;
                VI.FPWinOpen = true;

                try
                {
                    //Use win32 api to bring VI to front
                    String name = VI.FPWinTitle;
                    int handle = Helpers.NativeMethods.FindWindow(null, name);

                    if (handle == 0)
                    {
                        //If VI is not running then the window name may be different
                        handle = Helpers.NativeMethods.FindWindow(null, name + " Front Panel");

                        if (handle == 0)
                        {
                            //If VI has changed and not been saved the name may have a * on it
                            handle = Helpers.NativeMethods.FindWindow(null, name + " Front Panel *");
                        }
                    }

                    if (handle != 0)
                    {
                        Helpers.NativeMethods.SetForegroundWindow(handle);
                    }
                }
                catch (Exception err)
                {
                    //Don't worry if this does not work - it just means the VI is not 
                    //brought to the front.
                    Helpers.ErrorLogger.SeciError("DisplayVI", err);
                }
            }
            catch (Exception e)
            {
                //throw error up to next level
                throw new LabViewException("displayVI - " + e.Message);
            }

            return true;
        }

        public static Boolean HideVI(String fileName)
        {
            //Hide the VI
            try
            {
                strongnameLabview.VirtualInstrument VI = _VIs[fileName.ToLower()].VI;
                if (VI.FPWinOpen)
                {
                    VI.FPWinOpen = false;
                }
            }
            catch (Exception err)
            {
                //Not a fatal error, just log it
                Helpers.ErrorLogger.LabViewError("hideVI", err.Message);
            }

            return true;
        }

        public static Boolean HideAllVIs()
        {
            //Hide the VIs
            try
            {
                Dictionary<string, LabViewPanel>.KeyCollection keys = _VIs.Keys;

                foreach (String fileName in keys)
                {
                    HideVI(fileName);
                }
            }
            catch (Exception e)
            {
                //throw error up to next level
                throw new LabViewException("hideAllVIs - " + e.Message);
            }

            return true;
        }

        public static int[] GetBounds(String fileName)
        {
            //Return the bounds of the front panel as int[]
            try
            {
                strongnameLabview.VirtualInstrument VI = _VIs[fileName.ToLower()].VI;
                object[] obj = (Object[])VI.FPWinBounds;

                //Would like to convert obj to ints and tidy, but haven't done so yet!
                int[] bounds = new int[obj.GetLength(0)];

                for (int i = 0; i < obj.GetLength(0); ++i)
                {
                    bounds[i] = Convert.ToInt32(obj[i]);
                }

                return bounds;
            }
            catch (Exception err)
            {
                //Log error and return null array - this means the VI will appear at 
                //its default position next time
                Helpers.ErrorLogger.SeciError("getBounds", err);
                return null;
            }
        }

        public static Boolean MoveFrontPanel(String fileName, int[] bounds)
        {
            //Set the bounds of the front panel
            try
            {
                if (bounds != null)
                {
                    strongnameLabview.VirtualInstrument VI = _VIs[fileName.ToLower()].VI;

                    Object[] oldBounds = (Object[])VI.FPWinBounds;

                    oldBounds[2] = Convert.ToInt16(oldBounds[2]) - Convert.ToInt16(oldBounds[0]) + bounds[0];
                    oldBounds[3] = Convert.ToInt16(oldBounds[3]) - Convert.ToInt16(oldBounds[1]) + bounds[1];
                    oldBounds[0] = bounds[0];
                    oldBounds[1] = bounds[1];

                    VI.FPWinBounds = oldBounds;
                }

            }
            catch (Exception e)
            {
                //throw error up to next level
                throw new LabViewException("setBounds - " + e.Message);
            }

            return true;
        }

        public static void MinimiseVI(String fileName)
        {
            if (fileName != null)
            {
                strongnameLabview.VirtualInstrument VI = _VIs[fileName.ToLower()].VI;
                VI.FPState = strongnameLabview.FPStateEnum.eFPMinimized;
            }
        }

        public static void RestoreVI(String fileName)
        {
            if (fileName != null)
            {
                strongnameLabview.VirtualInstrument VI = _VIs[fileName.ToLower()].VI;
                VI.FPWinOpen = true;
                VI.FPState = strongnameLabview.FPStateEnum.eFPStandard;
            }
        }

        public static Boolean IsVIHidden(String fileName)
        {
            if (fileName != null)
            {
                strongnameLabview.VirtualInstrument VI = _VIs[fileName.ToLower()].VI;

                if (VI.FPState == strongnameLabview.FPStateEnum.eFPClosed || VI.FPState == strongnameLabview.FPStateEnum.eFPHidden)
                {
                    return true;
                }
            }

            return false;
        }

        public static void SetTitleBarVisibility(String fileName, Boolean visible)
        {
            if (fileName != null)
            {
                strongnameLabview.VirtualInstrument VI = _VIs[fileName.ToLower()].VI;
                VI.FPTitleBarVisible = visible;
            }
        }

        #endregion

        #region Get Front panel controls

        public static Boolean GetControls(String fileName, Boolean includeClusters)
        {
            //Populate the control dictionary for this VI
            try
            {
                _VIs[fileName.ToLower()].getVIControls(_controlsExporter, fileName, includeClusters);
            }
            catch (Exception e)
            {
                //throw error up to next level
                throw new LabViewException("getControls - " + e.Message);
            }

            return true;

        }

        public static List<String> GetListOfControls(String fileName)
        {
            try
            {
                //Get the name of the controls
                return _VIs[fileName.ToLower()].getListOfControls();
            }
            catch (Exception e)
            {
                //throw error up to next level
                throw new LabViewException("getListOfControls - " + e.Message);
            }
        }

        public static String GetControlTime(String fileName, String control)
        {
            return _VIs[fileName.ToLower()].GetControlType(control);
        }

        #endregion

        #region Get control value

        public static String[] GetValue(String fileName, String controlName)
        {
            //Get value from a control, return as a string as we don't know what the control may be
            try
            {
                //Need to strip off (type) from end of name ie. num1 (Numeric)
                if (controlName.LastIndexOf(" (", StringComparison.Ordinal) != -1)
                {
                    controlName = controlName.Substring(0, controlName.LastIndexOf(" ("));
                }

                return _VIs[fileName.ToLower()].getControlValue(controlName);

            }
            catch (Exception e)
            {
                //throw error up to next level
                throw new LabViewException("getValue - " + e.Message);
            }
        }

        public static Object GetRawValue(String fileName, String controlName)
        {
            //Get the value from LV, don't check that the control exists or tidy the result up
            try
            {
                //Need to strip off (type) from end of name ie. num1 (Numeric)
                if (controlName.LastIndexOf(" (", StringComparison.Ordinal) != -1)
                {
                    controlName = controlName.Substring(0, controlName.LastIndexOf(" (", StringComparison.Ordinal));
                }

                return _VIs[fileName.ToLower()].getRawControlValue(controlName);

            }
            catch (Exception e)
            {
                //throw error up to next level
                throw new LabViewException("getRawValue - " + e.Message);
            }
        }

        public static Object[] GetCluster(String fileName, String clusterName)
        {
            //Get a cluster or an array as one big clump
            try
            {
                return _VIs[fileName.ToLower()].getWholeCluster(clusterName);
            }
            catch (Exception e)
            {
                //throw error up to next level
                throw new LabViewException("getCluster - " + e.Message);
            }
        }

        #endregion

        #region Set control value

        public static Boolean SetValue(String fileName, String controlName, Object value)
        {
            //Set value of control on panel
            try
            {
                //Need to strip off (type) from end of name ie. num1 (Numeric)
                if (controlName.LastIndexOf(" (") != -1)
                {
                    controlName = controlName.Substring(0, controlName.LastIndexOf(" ("));
                }

                _VIs[fileName.ToLower()].setControlValue(controlName, value);

                return true;

            }
            catch (Exception e)
            {
                //throw error up to next level
                throw new LabViewException("SetValue - " + e.Message);
            }
        }

        public static Boolean SetRawValue(String fileName, String controlName, Object value)
        {
            //Set value of control on panel
            try
            {
                //Need to strip off (type) from end of name ie. num1 (Numeric)
                if (controlName.LastIndexOf(" (", StringComparison.Ordinal) != -1)
                {
                    controlName = controlName.Substring(0, controlName.LastIndexOf(" (", StringComparison.Ordinal));
                }

                _VIs[fileName.ToLower()].setRawControlValue(controlName, value);

                return true;

            }
            catch (Exception e)
            {
                //throw error up to next level
                throw new LabViewException("SetRawValue - " + e.Message);
            }
        }

        public static Boolean SetCluster(String fileName, String clusterName, Object[] values)
        {
            //Set a cluster or an array as one big clump 
            try
            {
                _VIs[fileName.ToLower()].setWholeCluster(clusterName, values);

                return true;
            }
            catch (Exception e)
            {
                //throw error up to next level
                throw new LabViewException("setCluster - " + e.Message);
            }
        }

        #endregion

        internal static SerialisableList<LabViewPanelInfo> GetAllPanelsInfo()
        {
            SerialisableList<LabViewPanelInfo> list = _panelsSettings.Clone() as SerialisableList<LabViewPanelInfo>;
            return list;
        }

        internal static void SetPanelsInfo(SerialisableList<LabViewPanelInfo> panels)
        {
            _panelsSettings = panels;
        }

        internal static BlockInfo GetCorrectBlockDetails(BlockInfo block)
        {
            //Find key manually as the case of panel may be wrong
            List<String> keys = new List<string>();
            keys.AddRange(_VIs.Keys);

            foreach (String key in keys)
            {
                if (key.ToLower() == block.ParentVI.ToLower())
                {
                    //block.ParentVI = _VIs[key];
                    block.ReadControl = _VIs[key].FindControlNameAndType(block.ReadControl);

                    if (block.WriteControl != null)
                    {
                        block.WriteControl = _VIs[key].FindControlNameAndType(block.WriteControl);
                    }

                    if (block.GoButton != null)
                    {
                        block.GoButton = _VIs[key].FindControlNameAndType(block.GoButton);
                    }
                    break;
                }
            }

            return block;
        }


        internal static List<String> GetListOfAllVIs(Boolean includeDefault)
        {
            List<String> paths = new List<string>();

            if (includeDefault)
            {
                paths.AddRange(_VIs.Keys);
            }
            else
            {
                foreach (LabViewPanelInfo panel in _panelsSettings)
                {
                    paths.Add(panel.FilePath.ToLower());
                }
            }

            return paths;
        }

        internal static void SetVisibilityToDefault(String fileName)
        {
            if (_VIs.ContainsKey(fileName.ToLower()))
            {
                foreach (LabViewPanelInfo panel in _panelsSettings)
                {
                    if (panel.FilePath == fileName)
                    {
                        if (panel.ShowPanel)
                        {
                            ShowVI(fileName);
                        }
                        else
                        {
                            HideVI(fileName);
                        }

                        return;
                    }
                }
            }
        }
    }
}