SampleParameters.cs

Go to the documentation of this file.

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

namespace Seci.Standard
{
    public static class SampleParameters
    {
        private static String _filePath;

        public static String FilePath { get { return _filePath; } }

        public static void Initialise()
        {
            _filePath = Status.SampleParametersVI;

            //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 String[,] GetParameters()
        {
            try
            {
                Object val = LabView.LabViewApp.GetRawValue(_filePath, "Additional Parameters");

                return (String[,])val;
            }
            catch
            {
                return null;
            }
        }

        public static List<String> GetParameterNames()
        {
            try
            {
                Object val = LabView.LabViewApp.GetRawValue(_filePath, "Standard Parameters");

                String[,] temp = (String[,])val;
                List<String> vals = new List<String>();

                for (int i = 0; i < temp.GetLength(0); ++i)
                {
                    vals.Add(temp[i, 1]);
                }

                return vals;
            }
            catch
            {
                return null;
            }
        }

        public static List<String> GetParameterTypes()
        {
            try
            {
                Object val = LabView.LabViewApp.GetRawValue(_filePath, "Types");

                return new List<String>((String[]) val);
            }
            catch
            {
                return null;
            }
        }

        public static void CreateParameter(int index, String value)
        {
            try
            {
                LabView.LabViewApp.SetRawValue(_filePath, "Standard Parameter Name", index);
                LabView.LabViewApp.SetRawValue(_filePath, "Standard Parameter Value", value);
                LabView.LabViewApp.SetRawValue(_filePath, "Add Standard Parameter", true);
            }
            catch (Exception e)
            {
                throw new Exception("Could not set parameter. Error message is: " + e.Message);
            }
        }

        public static void CreateParameter(String name, int typeIndex, String units, String value)
        {
            try
            {
                LabView.LabViewApp.SetRawValue(_filePath, "Custom Parameter Name", name);
                LabView.LabViewApp.SetRawValue(_filePath, "Custom Parameter Type", typeIndex);
                LabView.LabViewApp.SetRawValue(_filePath, "Custom Parameter Units", units);
                LabView.LabViewApp.SetRawValue(_filePath, "Custom Parameter Value", value);
                LabView.LabViewApp.SetRawValue(_filePath, "Add Custom parameter", true);
            }
            catch (Exception e)
            {
                throw new Exception("Could not set parameter. Error message is: " + e.Message);
            }
        }

        public static void RemoveParameter(String name)
        {
            try
            {
                List<String> stdNames = new List<String>(GetParameterNames());

                if (stdNames.Contains(name))
                {
                    //Is a standard parameter
                    //Remove using standard remove
                    int index = stdNames.IndexOf(name);
                    LabView.LabViewApp.SetRawValue(_filePath, "Standard Parameter Name", index);
                    LabView.LabViewApp.SetRawValue(_filePath, "Remove Standard Parameter", true);
                }
                else
                {
                    //Is a custom parameter
                    //Remove using custom remove
                    LabView.LabViewApp.SetRawValue(_filePath, "Custom Parameter Name", name);
                    LabView.LabViewApp.SetRawValue(_filePath, "Remove Custom Parameter", true);
                }
            }
            catch (Exception e)
            {
                throw new Exception("Could not remove parameter. Error message is: " + e.Message);
            }
        }


    }
}