<?xml version="1.0"?>
<doc>
    <assembly>
        <name>UnigeFrontEnd.Scripting</name>
    </assembly>
    <members>
        <member name="T:UnigeFrontEnd.Scripting.IConfigLoader">
            <summary>
            IConfigLoader
            </summary>
        </member>
        <member name="M:UnigeFrontEnd.Scripting.IConfigLoader.NewConfig">
            <summary>
            NewConfig
            </summary>
        </member>
        <member name="M:UnigeFrontEnd.Scripting.IConfigLoader.OpenConfigFile(System.String)">
            <summary>
            OpenConfigFile
            </summary>
            <param name="x_filename"></param>
            <returns></returns>
        </member>
        <member name="M:UnigeFrontEnd.Scripting.IConfigLoader.SaveConfigFile(System.String)">
            <summary>
            SaveConfigFile
            </summary>
            <param name="x_filename"></param>
            <returns></returns>
        </member>
        <member name="T:UnigeFrontEnd.Scripting.BoardLinkScripting">
            <summary>
            Board scripting
            </summary>
        </member>
        <member name="P:UnigeFrontEnd.Scripting.BoardLinkScripting.Sync">
            <summary>
            Board scripting synchro
            </summary>
        </member>
        <member name="M:UnigeFrontEnd.Scripting.BoardLinkScripting.#ctor(UnigeFrontEnd.Board.BoardLink,UnigeFrontEnd.Scripting.IConfigLoader,UFE_UnigeFrontEnd.Scripting.UFE_IGenericSynchronization)">
            <summary>
            Board scripting ctor
            </summary>
            <param name="x_link">The instance of BoardLink to use to communicate with the board</param>
            <param name="x_configLoader">The config loader instance</param>
            <param name="x_sync">The generic synchronization instance</param>
        </member>
        <member name="M:UnigeFrontEnd.Scripting.BoardLinkScripting.NewConfig">
            <summary>
            Opens a new config
            </summary>
        </member>
        <member name="M:UnigeFrontEnd.Scripting.BoardLinkScripting.OpenConfigFile(System.String)">
            <summary>
            Opens an existing config file.
            Path is relative to the script file.
            </summary>
            <param name="x_filename">The filename for the config file</param>
            <returns>Whether or not the config file has been opened</returns>
        </member>
        <member name="M:UnigeFrontEnd.Scripting.BoardLinkScripting.SaveConfigFile(System.String)">
            <summary>
            Save the config to the given filename, or,
            if no filename is passed, overwrite the last opened config file
            </summary>
            <param name="x_filename">An optional filename</param>
            <returns>Whether or not the config file has been saved</returns>
        </member>
        <member name="P:UnigeFrontEnd.Scripting.BoardLinkScripting.IsTransferingData">
            <summary>
            Whether or not there is an ongoing DAQ acquisition
            </summary>
        </member>
        <member name="P:UnigeFrontEnd.Scripting.BoardLinkScripting.HasDevice">
            <summary>
            Whether or not the application has found a device
            </summary>
        </member>
        <member name="M:UnigeFrontEnd.Scripting.BoardLinkScripting.SetBoardId(System.Byte)">
            <summary>
            Set the board id
            </summary>
            <param name="x_id">The desired id</param>
        </member>
        <member name="M:UnigeFrontEnd.Scripting.BoardLinkScripting.ActivateConfigDevice(System.Byte,System.Boolean)">
            <summary>
            activate the selected device to be sent during board configuration
            </summary>
            <param name="x_index">The desired device index</param>
            <param name="x_activate">activate if true, deactivate if false</param>
        </member>
        <member name="M:UnigeFrontEnd.Scripting.BoardLinkScripting.SelectUsbDevice(System.Byte)">
            <summary>
            select the USB device
            </summary>
            <param name="x_busIndex">The desired USB bus connected to the USB device</param>
        </member>
        <member name="M:UnigeFrontEnd.Scripting.BoardLinkScripting.Reconnect">
            <summary>
            Reconnect the board
            </summary>
        </member>
        <member name="M:UnigeFrontEnd.Scripting.BoardLinkScripting.ReadStatus">
            <summary>
            Read the status from the board and update the UI
            </summary>
            <returns>Whether or not the operation was successful</returns>
        </member>
        <member name="M:UnigeFrontEnd.Scripting.BoardLinkScripting.GetFirmwareVersion">
            <summary>
            Get firmware version
            </summary>
            <returns></returns>
        </member>
        <member name="M:UnigeFrontEnd.Scripting.BoardLinkScripting.SetDirectParameters">
            <summary>
            Set the direct parameters of the board
            </summary>
            <returns>Whether or not the operation was successful</returns>
        </member>
        <member name="M:UnigeFrontEnd.Scripting.BoardLinkScripting.UpdateUserParameters(System.String)">
            <summary>
            Update User Parameters for a connected user set/get which is not a device used in board configure
            </summary>
            <param name="x_qualifiedName">the UpdateUser tree array to be updated</param>
            <returns>true if ok</returns>
        </member>
        <member name="M:UnigeFrontEnd.Scripting.BoardLinkScripting.BoardConfigure(UnigeFrontEnd.Board.ConfigureMode)">
            <summary>
            Configure the board (send and/or verify and/or apply)
            </summary>
            <param name="x_mode">The modes to use : None, Send, Verify, ValidWord, Apply, Read, SendVerifyApply</param>
            <returns>Whether or not the board configuration succeeded</returns>
        </member>
        <member name="M:UnigeFrontEnd.Scripting.BoardLinkScripting.VerifyConfig">
            <summary>
            Verify the configuration, return true on success, otherwise false
            </summary>
            <returns>True if succeeded, otherwise false</returns>
        </member>
        <member name="M:UnigeFrontEnd.Scripting.BoardLinkScripting.StartAcquisition(System.String,System.Boolean,System.Boolean)">
            <summary>
            Start a DAQ acquisition and saves the data at the given filename.
            Path is relative to the script file.
            If no filename is passed, it will reuse the last one.
            </summary>
            <param name="x_filename">Optional filename for saving the data</param>		
            <param name="x_async">Whether or not to not wait for the acquisition to complete</param>
            <param name="x_monitoring">open the monitoring queue also</param>
            <returns>true on success, else false on failure</returns>
        </member>
        <member name="M:UnigeFrontEnd.Scripting.BoardLinkScripting.StartAcquisition(System.String,System.Boolean)">
            <summary>
            Start a DAQ acquisition and saves the data at the given filename.
            Path is relative to the script file.
            If no filename is passed, it will reuse the last one.
            </summary>
            <param name="x_filename">Optional filename for saving the data</param>		
            <param name="x_async">Whether or not to not wait for the acquisition to complete</param>
            <returns>true on success, else false on failure</returns>
        </member>
        <member name="M:UnigeFrontEnd.Scripting.BoardLinkScripting.WaitForEndOfTransfer(System.Boolean)">
            <summary>
            If running a script, sleeps until the DAQ transfer completes
            </summary>
            <param name="x_verbose">Whether or not to print status messages</param>
        </member>
        <member name="M:UnigeFrontEnd.Scripting.BoardLinkScripting.StopAcquisition">
            <summary>
            Stop the currently running DAQ acquisition
            </summary>
        </member>
        <member name="M:UnigeFrontEnd.Scripting.BoardLinkScripting.AbortAcquisition">
            <summary>
            Will abort the acquisition, only required from scripting internal usage (not user allowed)
            </summary>
        </member>
        <member name="M:UnigeFrontEnd.Scripting.BoardLinkScripting.GetBoolVariable(System.String)">
            <summary>
            Get a Boolean variable from the config
            </summary>
            <param name="x_qualifiedName">Name of the config variable (case insensitive)</param>
            <returns>The value for the given name</returns>
        </member>
        <member name="M:UnigeFrontEnd.Scripting.BoardLinkScripting.GetByteVariable(System.String)">
            <summary>
            Get a Byte variable from the config
            </summary>
            <param name="x_qualifiedName">Name of the config variable (case insensitive)</param>
            <returns>The value for the given name</returns>
        </member>
        <member name="M:UnigeFrontEnd.Scripting.BoardLinkScripting.GetUInt16Variable(System.String)">
            <summary>
            Get a UInt16 variable from the config
            </summary>
            <param name="x_qualifiedName">Name of the config variable (case insensitive)</param>
            <returns>The value for the given name</returns>
        </member>
        <member name="M:UnigeFrontEnd.Scripting.BoardLinkScripting.GetUInt32Variable(System.String)">
            <summary>
            Get a UInt32 variable from the config
            </summary>
            <param name="x_qualifiedName">Name of the config variable (case insensitive)</param>
            <returns>The value for the given name</returns>
        </member>
        <member name="M:UnigeFrontEnd.Scripting.BoardLinkScripting.GetEnumVariable(System.String)">
            <summary>
            Get a Int16 variable from the config
            </summary>
            <param name="x_qualifiedName">Name of the config variable (case insensitive)</param>
            <returns>The value for the given name</returns>
        </member>
        <member name="M:UnigeFrontEnd.Scripting.BoardLinkScripting.SetVariable(System.String,System.Object)">
            <summary>
            Set a variable of the config
            </summary>
            <param name="x_qualifiedName">Name of the config variable (case insensitive)</param>
            <param name="x_value">The value to assign to the variable</param>
        </member>
        <member name="M:UnigeFrontEnd.Scripting.BoardLinkScripting.GetVariable(System.String,UnigeFrontEnd.Config.DescTreeVar.VarType)">
            <summary>
            Get a variable from the config and return its value as a string
            </summary>
            <param name="x_qualifiedName">Name of the config variable (case insensitive)</param>
            <param name="type">The expected type for the variable</param>
            <returns>The value for the given name</returns>
        </member>
        <member name="M:UnigeFrontEnd.Scripting.BoardLinkScripting.FindVariable(System.String,System.Boolean)">
            <summary>
            Search for Config.Variable object of the config
            matching the given name.
            It throws an exception if not found.
            </summary>
            <param name="x_qualifiedName">Name of the config variable (case insensitive)</param>
            <param name="x_writable">Whether or not the variable needs to be writable</param>
            <returns>The matching variable</returns>
        </member>
        <member name="M:UnigeFrontEnd.Scripting.BoardLinkScripting.FindTreeArray(System.String)">
            <summary>
            Search for Config.DataTreeArray object of the config
            matching the given name.
            It throws an exception if not found.
            </summary>
            <param name="x_qualifiedName">Name of the config array (case insensitive)</param>
            <returns>The matching variable</returns>
        </member>
        <member name="M:UnigeFrontEnd.Scripting.BoardLinkScripting.FindArrayNode(System.String,System.Boolean,System.Boolean)">
            <summary>
            Search for Config.Variable object of the config
            matching the given name.
            It throws an exception if not found.
            </summary>
            <param name="x_qualifiedName">Name of the config variable/node (case insensitive)</param>
            <param name="x_writable">Whether or not the variable needs to be writable (not used if x_variable=false)</param>
            <param name="x_variable">to find a variable or a node</param>
            <returns>The matching variable/node</returns>
        </member>
        <member name="T:UnigeFrontEnd.Scripting.Interpreter">
            <summary>
            Parser class
            </summary>
        </member>
        <member name="M:UnigeFrontEnd.Scripting.Interpreter.Tokenizer(System.String)">
            <summary>
            Separate a string in tokens
            </summary>
            <param name="x_snippet">string input to tokenize</param>
            <returns>tokens separated</returns>
        </member>
        <member name="M:UnigeFrontEnd.Scripting.Interpreter.FunctionAndArg(System.String[])">
            <summary>
            returns function and arguments only in an string array
            </summary>
            <param name="x_tokens"></param>
            <returns>function and arguments</returns>
        </member>
        <member name="M:UnigeFrontEnd.Scripting.Interpreter.CheckAndConvertArgs(System.Collections.Generic.List{System.Reflection.MemberInfo},System.String[],System.Reflection.MemberInfo@,System.String@)">
            <summary>
            Check that arguments are correct for this function and returns all converted parameters
            </summary>
            <param name="x_functionAndArg"></param>
            <param name="x_memberList">member to be checked</param>
            <param name="x_member"></param>
            <param name="x_lib">x_lib object to be called</param>
            <returns>method/property for 1st list element then all parameter</returns>
        </member>
        <member name="M:UnigeFrontEnd.Scripting.Interpreter.#ctor(UFE_UnigeFrontEnd.Scripting.UFE_IScriptDialogs,UFE_UnigeFrontEnd.Scripting.UFE_IGenericSynchronization,UnigeFrontEnd.Scripting.BoardLinkScripting,System.Object,System.Type,System.Type)">
            <summary>
            Interpereter Ctor
            </summary>
            <param name="x_dialogObj">dialog object</param>
            <param name="x_syncObj">associated synchronization object</param>
            <param name="x_boardLinkObj">board link object</param>
            <param name="x_appObj">app object</param> 
            <param name="x_attrType">normal attribute</param>
            <param name="x_attrTypeNoInvoke">Attribute when no invoke is set</param>
            <returns>all functions listed</returns>
        </member>
        <member name="M:UnigeFrontEnd.Scripting.Interpreter.Interpret(System.String)">
            <summary>
            Interpret a command and its argument in the correct context (Main Thread or current thread)
            </summary>
            <param name="x_snippet">snippet to be decoded</param>
            <returns>method or property return value</returns>
        </member>
        <member name="M:UnigeFrontEnd.Scripting.Interpreter.checkLibMember(System.Reflection.MemberInfo,System.String)">
            <summary>
            Check Lib and member
            </summary>
            <param name="x_member"></param>
            <param name="x_lib"></param>
            <returns>object to be called</returns>
        </member>
        <member name="T:UnigeFrontEnd.Scripting.VisibleFromScriptAttribute">
            <summary>
            Use this attribute to mark class methods that you want to be exposed to scripts.
            Calls to those methods from scripts will be forwarded to the main thread (in a synchronous manner).
            </summary>
        </member>
        <member name="M:UnigeFrontEnd.Scripting.VisibleFromScriptAttribute.#ctor">
            <summary>
            VisibleFromScriptAttribute
            </summary>
        </member>
        <member name="T:UnigeFrontEnd.Scripting.VisibleFromScriptNoInvokeAttribute">
            <summary>
            Use this attribute to mark class methods that you want to be exposed to scripts.
            Calls to those methods from scripts will run on the calling (scripting) thread.
            </summary>
        </member>
        <member name="M:UnigeFrontEnd.Scripting.VisibleFromScriptNoInvokeAttribute.#ctor">
            <summary>
            VisibleFromScriptNoInvokeAttribute
            </summary>
        </member>
        <member name="T:UnigeFrontEnd.Scripting.VisibleFromSocketAttribute">
            <summary>
            Use this attribute to mark class methods that you want to be exposed to socket.
             Calls to those methods from sockets will be forwarded to the main thread (in a synchronous manner).
            </summary>
        </member>
        <member name="M:UnigeFrontEnd.Scripting.VisibleFromSocketAttribute.#ctor">
            <summary>
            VisibleFromSocketAttribute
            </summary>
        </member>
        <member name="T:UnigeFrontEnd.Scripting.VisibleFromSocketNoInvokeAttribute">
            <summary>
            Use this attribute to mark class methods that you want to be exposed to socket.
            Calls to those methods from sockets will run on the calling (socket) thread.
            </summary>
        </member>
        <member name="M:UnigeFrontEnd.Scripting.VisibleFromSocketNoInvokeAttribute.#ctor">
            <summary>
            VisibleFromScriptNoInvokeAttributeVisibleFromSocketNoInvokeAttribute
            </summary>
        </member>
        <member name="T:UFE_UnigeFrontEnd.Scripting.UFE_GenericReflection">
            <summary>
            Generic implementation of Members reflection.
            </summary>
        </member>
        <member name="F:UFE_UnigeFrontEnd.Scripting.UFE_GenericReflection.m_separator">
            <summary>
            Separator
            </summary>
        </member>
        <member name="F:UFE_UnigeFrontEnd.Scripting.UFE_GenericReflection.m_appObjectName">
            <summary>
            App Object name used for script/socket
            </summary>
        </member>
        <member name="F:UFE_UnigeFrontEnd.Scripting.UFE_GenericReflection.m_syncObjectName">
            <summary>
            Sync Object name used for script/socket
            </summary>
        </member>
        <member name="F:UFE_UnigeFrontEnd.Scripting.UFE_GenericReflection.m_BoardLinkObjectName">
            <summary>
            BoardLib Object name used for script/socket
            </summary>
        </member>
        <member name="F:UFE_UnigeFrontEnd.Scripting.UFE_GenericReflection.m_DialogObjectName">
            <summary>
            Dialog Object name used for script/socket
            </summary>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_GenericReflection.GetTypeCSharpName(Microsoft.CSharp.CSharpCodeProvider,System.Type)">
            <summary>
            Get C sharp name
            </summary>
            <param name="x_compiler"></param>
            <param name="x_type"></param>
            <returns></returns>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_GenericReflection.GetMembers(System.Type,System.Type,System.Type)">
            <summary>
            Get members of a class
            </summary>
            <param name="x_class"></param>
            <param name="x_attrType"></param>
            <param name="x_attrTypeNoInvoke"></param>
            <returns></returns>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_GenericReflection.GetMembers(System.Object,System.Type,System.Type)">
            <summary>
            Get members of an object
            </summary>
            <param name="x_object"></param>
            <param name="x_attrType"></param>
            <param name="x_attrTypeNoInvoke"></param>
            <returns></returns>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_GenericReflection.AddMethodsAndProperties(Microsoft.CSharp.CSharpCodeProvider,System.Object,System.String,System.Text.StringBuilder,System.Collections.Generic.Dictionary{System.String,System.String},System.Type,System.Type)">
            <summary>
            Add Methods and properties for a given class to a give object for compiling usage
            </summary>
            <param name="x_compiler">compiler to be used</param>
            <param name="x_object"></param>
            <param name="x_objectName"> object name of the class</param>
            <param name="x_outSourceCode">string builded for the real script to be compiled</param>
            <param name="x_outAliases">dictionary of aliases</param>
            <param name="x_attrType">normal attribute</param>
            <param name="x_attrTypeNoInvoke">Attribute when no invoke is set</param>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_GenericReflection.AddProperty(Microsoft.CSharp.CSharpCodeProvider,System.String,System.Text.StringBuilder,System.Reflection.PropertyInfo,System.Type)">
            <summary>
            Add property
            </summary>
            <param name="x_compiler"></param>
            <param name="x_objectName"></param>
            <param name="x_outSourceCode"></param>
            <param name="l_property"></param>
            <param name="x_attrTypeNoInvoke"></param>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_GenericReflection.AddMethod(Microsoft.CSharp.CSharpCodeProvider,System.String,System.Text.StringBuilder,System.Collections.Generic.Dictionary{System.String,System.String},System.Reflection.MethodInfo,System.Type)">
            <summary>
            Add method
            </summary>
            <param name="x_compiler"></param>
            <param name="x_objectName"></param>
            <param name="x_outSourceCode"></param>
            <param name="x_outAliases"></param>
            <param name="x_method"></param>
            <param name="x_attrTypeNoInvoke"></param>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_GenericReflection.WriteException(System.Exception,System.String,System.String,System.Boolean)">
            <summary>
            Outputs the content of an exception (adjust stack trace string to show exact line number)
            </summary>
            <param name="x_exception">Exception to output</param>
            <param name="x_scriptFileName">Pathname of the script file</param>
            <param name="x_scriptMethName">The full name of the script method that was invoked</param>
            <param name="x_fullMessage">The full description of the exception is displayed</param>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_GenericReflection.FormatStackTrace(System.Exception,System.String,System.String)">
            <summary>
            Format stack trace of given exception to remove random script name references
            </summary>
            <param name="x_exception">Exception from which to read the stack trace</param>
            <param name="x_scriptFileName">Pathname of the script file</param>
            <param name="x_scriptMethName">The full name of the script method that was invoked</param>
            <returns>Formated stack trace</returns>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_GenericReflection.BuildHelp(System.Boolean,System.Type,System.Object,System.Type,System.Type)">
            <summary>
            Build help
            </summary>
            <param name="x_appScriptingObject">app scripting object</param>
            <param name="x_attrType">normal attribute</param>
            <param name="x_attrTypeNoInvoke">Attribute when no invoke is set</param>
            <param name="x_scriptDialogs">dialog enable</param>
            <param name="x_syncClass">associated synchronization class</param>
            <returns>all functions listed</returns>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_GenericReflection.BuildMembers(System.Collections.Generic.Dictionary{System.String,System.Object},UFE_UnigeFrontEnd.Scripting.UFE_IScriptDialogs,UFE_UnigeFrontEnd.Scripting.UFE_IGenericSynchronization,UnigeFrontEnd.Scripting.BoardLinkScripting,System.Object,System.Type,System.Type)">
            <summary>
            Build members for interpereter
            </summary>
            <param name="x_outObjectsLib">object directory association output for libraries</param>		
            <param name="x_dialogObj">dialog object</param>
            <param name="x_syncObj">associated synchronization object</param>
            <param name="x_boardLinkObj">board link object</param>
            <param name="x_appObj">app object</param> 
            <param name="x_attrType">normal attribute</param>
            <param name="x_attrTypeNoInvoke">Attribute when no invoke is set</param> 
            <returns>all functions listed</returns>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_GenericReflection.BuildMembersHelpFromXml(System.Collections.Generic.IEnumerable{System.Reflection.MemberInfo})">
            <summary>
            Build member help from XML members infos in c# file
            </summary>
            <param name="l_members"></param>
            <returns></returns>
        </member>
        <member name="T:UFE_UnigeFrontEnd.Scripting.UFE_GenericSynchronization">
            <summary>
            Generic implementation of Synchronization.
            </summary>
        </member>
        <member name="F:UFE_UnigeFrontEnd.Scripting.UFE_GenericSynchronization.m_logQueue">
            <summary>
            Log
            </summary>
        </member>
        <member name="F:UFE_UnigeFrontEnd.Scripting.UFE_GenericSynchronization.m_startTime">
            <summary>
            Time at which this instance was created
            </summary>
        </member>
        <member name="F:UFE_UnigeFrontEnd.Scripting.UFE_GenericSynchronization.m_addTimestamp">
            <summary>
            Whether or not to insert a timestamp in the log on the next call to AppendLogString
            </summary>
        </member>
        <member name="F:UFE_UnigeFrontEnd.Scripting.UFE_GenericSynchronization.m_logFileName">
            <summary>
            Underlying property field for LogFileName
            </summary>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_GenericSynchronization.#ctor">
            <summary>
            Constructor, build the logger
            </summary>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_GenericSynchronization.AppendLogString(System.String)">
            <summary>
            Add the given string to the log
            </summary>
            <param name="str">A string to be logged</param>
            <remarks>This method is thread safe</remarks>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_GenericSynchronization.FlushLog">
            <summary>
            Full console log
            </summary>
            <remarks>It's emptied once retrieved</remarks>
        </member>
        <member name="P:UFE_UnigeFrontEnd.Scripting.UFE_GenericSynchronization.LogFileName">
            <summary>
            File name where to save the log (can be left null, and no log will be saved).
            The date and time is automatically append to the file name.
            Path is relative to the script file.
            </summary>
        </member>
        <member name="T:UFE_UnigeFrontEnd.Scripting.UFE_ScriptEnvironment">
            <summary>
            Main class for running a dynamic script.
            The 'RunScript' method of UFE_ScriptSynchronization dynamically creates a sub-class of this one,
            and place the script's code in a method named 'Run'.
            As a consequence, the MainForm, Sync and Dialog properties are directly accessible
            from the script code.
            </summary>
        </member>
        <member name="P:UFE_UnigeFrontEnd.Scripting.UFE_ScriptEnvironment.Sync">
            <summary>
            Exposes the synchronization methods to scripts
            </summary>
        </member>
        <member name="P:UFE_UnigeFrontEnd.Scripting.UFE_ScriptEnvironment.Dialog">
            <summary>
            Exposed the dialog methods to scripts
            </summary>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_ScriptEnvironment.#ctor(UFE_UnigeFrontEnd.Scripting.UFE_IScriptSynchronization,UFE_UnigeFrontEnd.Scripting.UFE_IScriptDialogs)">
            <summary>
            Constructor to be called from the child class created dynamically for the script
            </summary>
            <param name="x_sync">The instance used to sync the script and the GUI</param>
            <param name="x_dialog">The instance used to display dialogs</param>
        </member>
        <member name="T:UFE_UnigeFrontEnd.Scripting.UFE_BaseSynchronization">
            <summary>
            Public base class for the application
            </summary>
        </member>
        <member name="P:UFE_UnigeFrontEnd.Scripting.UFE_BaseSynchronization.Sync">
            <summary>
            Sync interface to be initialized during script launch
            </summary>
        </member>
        <member name="T:UFE_UnigeFrontEnd.Scripting.UFE_IConsoleWindow">
            <summary>
            Window handling scripts.
            The log is displayed, and there are buttons to interact with the script.
            </summary>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_IConsoleWindow.AppendText(System.Char)">
            <summary>
            For writing text to output
            </summary>
            <param name="x_value">char to write</param>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_IConsoleWindow.AppendText(System.String)">
            <summary>
            For writing text to output
            </summary>
            <param name="x_value">string to write</param>
        </member>
        <member name="T:UFE_UnigeFrontEnd.Scripting.UFE_IScriptWindow">
            <summary>
            Window handling scripts.
            The log is displayed, and there are buttons to interact with the script.
            </summary>
        </member>
        <member name="P:UFE_UnigeFrontEnd.Scripting.UFE_IScriptWindow.ScriptFileName">
            <summary>
            The filename of the script to run
            </summary>
        </member>
        <member name="P:UFE_UnigeFrontEnd.Scripting.UFE_IScriptWindow.ScriptSync">
            <summary>
            The instance used for synchronization between the GUI thread and the script thread
            </summary>
        </member>
        <member name="P:UFE_UnigeFrontEnd.Scripting.UFE_IScriptWindow.BoardLinkScripting">
            <summary>
            Get Link
            </summary>
        </member>
        <member name="P:UFE_UnigeFrontEnd.Scripting.UFE_IScriptWindow.AppScriptingObject">
            <summary>
            Get application
            </summary>
        </member>
        <member name="P:UFE_UnigeFrontEnd.Scripting.UFE_IScriptWindow.GetExceptionFullMessage">
            <summary>
            Get the Exception full message to be displayed
            </summary>
        </member>
        <member name="T:UFE_UnigeFrontEnd.Scripting.UFE_IGenericSynchronization">
            <summary>
            Public interface exposing some synchronization methods to generci synchronization.
            </summary>
        </member>
        <member name="P:UFE_UnigeFrontEnd.Scripting.UFE_IGenericSynchronization.LogFileName">
            <summary>
            File name where to save the log (can be left null, and no log will be saved).
            The date and time is automatically append to the file name.
            Path is relative to the script file.
            </summary>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_IGenericSynchronization.Sleep(System.Int32,System.Boolean)">
            <summary>
            Sleeps for a given duration.
            Function intended to be called from a script.
            </summary>
            <param name="x_milliSeconds">Time to wait in milliseconds</param>
            <param name="x_verbose">Whether or not to print status messages</param>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_IGenericSynchronization.SleepUntil(System.Func{System.Boolean},System.Boolean)">
            <summary>
            Sleeps until the given predicate returns true.
            Function intended to be called from a script.
            </summary>
            <param name="l_predicate">Function that is executed every now and then to test for continuing to wait</param>
            <param name="x_verbose">Whether or not to print status messages</param>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_IGenericSynchronization.Pause(System.Boolean)">
            <summary>
            Pause the execution until the user allow it to resume.
            Function intended to be called from a script.
            </summary>
            <param name="x_verbose">Whether or not to print status messages</param>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_IGenericSynchronization.CheckPendingCancel">
            <summary>
            This function checks for a pending cancel (most likely requested by the user)
            Call it as often as possible in script functions.
            </summary>
            <returns></returns>
        </member>
        <member name="T:UFE_UnigeFrontEnd.Scripting.UFE_IScriptSynchronization">
            <summary>
            Public interface exposing some synchronization methods to scripts.
            </summary>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_IScriptSynchronization.GuiCall(System.Action)">
            <summary>
            Synchronously call the given function on the GUI thread
            </summary>
            <param name="x_functionToInvoke">Function to call</param>
            <remarks>Exceptions are caught depending of the value of CatchExceptions</remarks>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_IScriptSynchronization.GuiCall``1(System.Func{``0})">
            <summary>
            Synchronously all the given function on the GUI thread and returns its return value
            </summary>
            <typeparam name="TResult">Type of the return value</typeparam>
            <param name="x_functionToInvoke">Function to call</param>
            <returns>The return value from the given function</returns>
            <remarks>Exceptions are caught depending of the value of CatchExceptions</remarks>
        </member>
        <member name="T:UFE_UnigeFrontEnd.Scripting.UFE_IScriptDialogs">
            <summary>
            Public interface exposing methods to show a message box,
            or an input message box to scripts.
            </summary>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_IScriptDialogs.ShowDialog(System.String)">
            <summary>
            Show a modal dialog box with a message
            </summary>
            <param name="x_message">Message to be displayed</param>
            <remarks>It also let the user abort the script's execution</remarks>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_IScriptDialogs.ShowInputDialog``1(System.String)">
            <summary>
            Show a modal dialog box with a message and an input field.
            The value entered in the input field must match the given type.
            Supported types:
             - all variations of int, uint and byte
             - float, double
             - char, string
             - DateTime
            </summary>
            <typeparam name="T">Expected type for the field</typeparam>
            <param name="x_message">Message to display</param>
            <returns>The value typed by the user, casted to the given type</returns>
        </member>
        <member name="T:UFE_UnigeFrontEnd.Scripting.DelayedException">
            <summary>
            Exception class used when re-throwing an exception previously caught by the user input system
            </summary>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.DelayedException.#ctor(System.Exception)">
            <summary>
            Ctor
            </summary>
            <param name="x_ex">Exception to wrap in a user input exception</param>
        </member>
        <member name="T:UFE_UnigeFrontEnd.Scripting.UFE_ScriptSynchronization">
            <summary>
            Private implementation of UFE_IScriptSynchronization.
            </summary>
        </member>
        <member name="T:UFE_UnigeFrontEnd.Scripting.UFE_ScriptSynchronization.ScriptStatus">
            <summary>
            List of status for the script's thread
            </summary>
        </member>
        <member name="F:UFE_UnigeFrontEnd.Scripting.UFE_ScriptSynchronization.ScriptStatus.Idle">
            <summary>
            Idle status
            </summary>
        </member>
        <member name="F:UFE_UnigeFrontEnd.Scripting.UFE_ScriptSynchronization.ScriptStatus.Compiling">
            <summary>
            Compiling status
            </summary>
        </member>
        <member name="F:UFE_UnigeFrontEnd.Scripting.UFE_ScriptSynchronization.ScriptStatus.Running">
            <summary>
            Running status
            </summary>
        </member>
        <member name="F:UFE_UnigeFrontEnd.Scripting.UFE_ScriptSynchronization.ScriptStatus.Sleeping">
            <summary>
            Sleeping status
            </summary>
        </member>
        <member name="F:UFE_UnigeFrontEnd.Scripting.UFE_ScriptSynchronization.ScriptStatus.SleepUntil">
            <summary>
            Sleep until status
            </summary>
        </member>
        <member name="F:UFE_UnigeFrontEnd.Scripting.UFE_ScriptSynchronization.ScriptStatus.Paused">
            <summary>
            Paused status
            </summary>
        </member>
        <member name="F:UFE_UnigeFrontEnd.Scripting.UFE_ScriptSynchronization.ScriptStatus.Aborted">
            <summary>
            Aborted status
            </summary>
        </member>
        <member name="P:UFE_UnigeFrontEnd.Scripting.UFE_ScriptSynchronization.RequestUserInput">
            <summary>
            Function to show user input dialog
            </summary>
        </member>
        <member name="P:UFE_UnigeFrontEnd.Scripting.UFE_ScriptSynchronization.Status">
            <summary>
            Status of the script's execution
            </summary>
        </member>
        <member name="P:UFE_UnigeFrontEnd.Scripting.UFE_ScriptSynchronization.SuspendFlag">
            <summary>
            Whether or not the script is waiting on the user
            </summary>
        </member>
        <member name="P:UFE_UnigeFrontEnd.Scripting.UFE_ScriptSynchronization.SleepTimer">
            <summary>
            Time left to sleep, if any
            </summary>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_ScriptSynchronization.#ctor(System.ComponentModel.BackgroundWorker,System.Func{System.String,System.Type,System.Object})">
            <summary>
            Constructor, takes the associated background worker as an argument
            </summary>
            <param name="x_worker">The background worker running the script</param>
            <param name="x_requestUserInput">A method that ask the user for input</param>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_ScriptSynchronization.ResumeExecution">
            <summary>
            Resume execution of the script by setting SuspendFlag to false
            </summary>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_ScriptSynchronization.AbortExecution">
            <summary>
            Abort script execution
            </summary>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_ScriptSynchronization.ShowingDialog(System.Boolean)">
            <summary>
            Called by UFE_IScriptDialogs when a dialog is shown
            </summary>
            <param name="x_isShowing">Whether or not a dialog is being shown</param>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_ScriptSynchronization.RunScript(UFE_UnigeFrontEnd.Scripting.UFE_IScriptWindow,UFE_UnigeFrontEnd.Scripting.UFE_IScriptDialogs,System.ComponentModel.BackgroundWorker)">
            <summary>
            This method dynamically creates a sub-class of UFE_ScriptEnvironment,
            and place the script's code in a method named 'Run'.
            Then creates an instance of said class and call the 'Run' method on it.
            </summary>
            <param name="x_scriptWindow">The script window hosting the background worker</param>
            <param name="x_scriptDialogs">The scripting object through which to get user input</param>
            <param name="x_worker">The background worker to use to run the script</param>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_ScriptSynchronization.BuildHelp(System.Object)">
            <summary>
            Build help
            </summary>
            <param name="x_appScriptingObject">app scripting object</param>
            <returns>all functions listed</returns>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_ScriptSynchronization.Sleep(System.Int32,System.Boolean)">
            <summary>
            Sleeps for a given duration.
            Function intended to be called from a script.
            </summary>
            <param name="x_milliSeconds">Time to wait in milliseconds</param>
            <param name="x_verbose">Whether or not to print status messages</param>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_ScriptSynchronization.SleepUntil(System.Func{System.Boolean},System.Boolean)">
            <summary>
            Sleeps until the given predicate returns true.
            Function intended to be called from a script.
            </summary>
            <param name="l_predicate">Function that is executed every now and then to test for continuing to wait</param>
            <param name="x_verbose">Whether or not to print status messages</param>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_ScriptSynchronization.Pause(System.Boolean)">
            <summary>
            Pause the execution until the user allow it to resume.
            Function intended to be called from a script.
            </summary>
            <param name="x_verbose">Whether or not to print status messages</param>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_ScriptSynchronization.CheckPendingCancel">
            <summary>
            This function checks for a pending cancel (most likely requested by the user)
            Call it as often as possible in script functions.
            </summary>
            <returns>true if cancel</returns>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_ScriptSynchronization.GuiCall(System.Action)">
            <summary>
            Synchronously call the given function on the GUI thread
            </summary>
            <param name="x_functionToInvoke">Function to call</param>
            <remarks>Exceptions are caught depending of the value of CatchExceptions</remarks>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_ScriptSynchronization.GuiCall``1(System.Func{``0})">
            <summary>
            Synchronously all the given function on the GUI thread and returns its return value
            </summary>
            <typeparam name="TResult">Type of the return value</typeparam>
            <param name="x_functionToInvoke">Function to call</param>
            <returns>The return value from the given function</returns>
            <remarks>Exceptions are caught depending of the value of CatchExceptions</remarks>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_ScriptSynchronization.ThrowPreviouslyRaisedException">
            <summary>
            Throw an eventual exception that has been previously put aside
            </summary>
        </member>
        <member name="T:UFE_UnigeFrontEnd.Scripting.UFE_ConsoleWriter">
            <summary>
            TextWriter class that which only purpose is to redirect the debug output
            to a given ScriptWindow
            </summary>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_ConsoleWriter.#ctor(UFE_UnigeFrontEnd.Scripting.UFE_IConsoleWindow)">
            <summary>
            Constructor, takes a ScriptWindow to which it will redirect the text stream
            </summary>
            <param name="x_scriptWindow">ScriptWindow that is the recipient of the text stream</param>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_ConsoleWriter.Write(System.Char)">
            <summary>
            Override TextWriter method
            </summary>
            <param name="x_value"></param>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_ConsoleWriter.Write(System.String)">
            <summary>
            Override TextWriter method
            </summary>
            <param name="x_value"></param>
        </member>
        <member name="P:UFE_UnigeFrontEnd.Scripting.UFE_ConsoleWriter.Encoding">
            <summary>
            Override TextWriter method
            </summary>
        </member>
        <member name="T:UFE_UnigeFrontEnd.Scripting.UFE_SocketServer">
            <summary>
            Socket environment and listener
            </summary>
        </member>
        <member name="P:UFE_UnigeFrontEnd.Scripting.UFE_SocketServer.ClientConnected">
            <summary>
            Returns status of the client connection
            </summary>
        </member>
        <member name="F:UFE_UnigeFrontEnd.Scripting.UFE_SocketServer.m_semStop">
            <summary>
            Semaphore to close the current socket
            </summary>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_SocketServer.#ctor(System.ComponentModel.BackgroundWorker,System.Collections.Concurrent.ConcurrentQueue{System.String})">
            <summary>
            Ctor
            </summary>
            <param name="x_worker">asscoiated background worker</param>
            <param name="x_stringToGui">string to display to GUI</param>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_SocketServer.Init(UnigeFrontEnd.Scripting.BoardLinkScripting,System.Object)">
            <summary>
            Initializes objects
            </summary>
            <param name="x_boardLinkScriptingObj">board link scripting object</param>
            <param name="x_appSocketObj">app socket object</param> 
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_SocketServer.Stop">
            <summary>
            Stop the server
            </summary>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_SocketServer.Start(System.Net.IPEndPoint)">
            <summary>
            Start the server
            </summary>
            <param name="x_ipEP">IP End point</param>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_SocketServer.acceptCallback(System.IAsyncResult)">
            <summary>
            Call back launched when socket accepted
            </summary>
            <param name="x_ar"></param>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_SocketServer.readCallback(System.IAsyncResult)">
            <summary>
            Read callback
            </summary>
            <param name="x_ar"></param>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_SocketServer.sendCallback(System.IAsyncResult)">
            <summary>
            Send call back to send message to client
            </summary>
            <param name="x_ar"></param>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_SocketServer.IsSocketConnected(System.Net.Sockets.Socket)">
            <summary>
            Checks if the socket is connected
            </summary>
            <param name="x_socket"></param>
            <returns></returns>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_SocketServer.interpret(System.String)">
            <summary>
            interpret the received data
            </summary>
            <param name="x_data"></param>
            <returns>string to be displayed/sent back</returns>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_SocketServer.AppendText(System.Char)">
            <summary>
            Called by the console, appends a character to the log
            </summary>
            <param name="x_char">Character to add to the log</param>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_SocketServer.AppendText(System.String)">
            <summary>
            Called by the console, appends a string to the log
            </summary>
            <param name="x_str">String to add to the log</param>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_SocketServer.Sleep(System.Int32,System.Boolean)">
            <summary>
            Sleeps for a given duration.
            Function intended to be called from a script.
            </summary>
            <param name="x_milliSeconds">Time to wait in milliseconds</param>
            <param name="x_verbose">Whether or not to print status messages</param>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_SocketServer.SleepUntil(System.Func{System.Boolean},System.Boolean)">
            <summary>
            Sleeps until the given predicate returns true.
            Function intended to be called from a script.
            </summary>
            <param name="l_predicate">Function that is executed every now and then to test for continuing to wait</param>
            <param name="x_verbose">Whether or not to print status messages</param>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_SocketServer.Pause(System.Boolean)">
            <summary>
            Pause the execution until the user allow it to resume.
            Function intended to be called from a script.
            </summary>
            <param name="x_verbose">Whether or not to print status messages</param>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_SocketServer.CheckPendingCancel">
            <summary>
            This function checks for a pending cancel (most likely requested by the user)
            Call it as often as possible in script functions.
            </summary>
            <returns>true if cancel</returns>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_SocketServer.BuildHelp(System.Object)">
            <summary>
            Build help
            </summary>
            <param name="x_appScriptingObject">app scripting object</param>
            <returns>all functions listed</returns>
        </member>
        <member name="M:UFE_UnigeFrontEnd.Scripting.UFE_SocketServer.AbortExecution">
            <summary>
            Abort script execution
            </summary>
        </member>
    </members>
</doc>
