path: root/Software/Visual_Studio/FSE/Modules/Tango.FSE.Procedures/IProcedureContext.cs

using Google.Protobuf;
using System;
using System.Collections;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Drawing;
using System.Linq;
using System.Runtime.CompilerServices;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using Tango.BL.Entities;
using Tango.Core;
using Tango.FSE.Common.Connection;
using Tango.FSE.Common.DataStore;
using Tango.FSE.Common.Diagnostics;
using Tango.Integration.Operation;
using Tango.Scripting.Basic;
using Tango.Scripting.Editors.Intellisense;

namespace Tango.FSE.Procedures
{
    /// <summary>
    /// Represents the main procedures API.
    /// </summary>
    /// <seealso cref="Tango.Scripting.Basic.IContext" />
    public interface IProcedureContext : IContext
    {
        /// <summary>
        /// Occurs when the procedure is reporting about some progress.
        /// </summary>
        [HideIntellisense]
        event EventHandler<TangoProgressChangedEventArgs<double>> Progress;

        /// <summary>
        /// Occurs when a procedure object break point request occurs through the IDE break points.
        /// </summary>
        [HideIntellisense]
        event EventHandler<BreakPointRequestEventArgs> BreakPointRequest;

        /// <summary>
        /// Gets the list of current results.
        /// </summary>
        [HideIntellisense]
        ReadOnlyCollection<Result> Results { get; }

        /// <summary>
        /// Adds a new procedure result.
        /// The value object can be a primitive, a collection of primitives or a collection of complex types.
        /// </summary>
        /// <param name="type">Result type.</param>
        /// <param name="name">Result title.</param>
        /// <param name="value">Result value.</param>
        /// <returns>The result instance.</returns>
        /// <example>
        /// <para>
        /// <i>
        /// The following example demonstrates how to add various procedure results.
        /// </i>
        /// </para>
        /// <code lang="C#" source="../Tango.FSE.Procedures/Examples/AddResult/Program.cs" title="Add results" region="Example" />
        /// </example>
        Result AddResult(ResultType type, String name, object value);

        /// <summary>
        /// Adds a new procedure result that will be displayed as a graph with X/Y axis.
        /// The specified values will be plotted as Y axis values while the X axis will be auto generated by each value index.
        /// </summary>
        /// <param name="type">Result type.</param>
        /// <param name="name">Result title.</param>
        /// <param name="values">Graph Y axis values.</param>
        /// <returns>The result instance.</returns>
        /// <example>
        /// <para>
        /// <i>
        /// The following example demonstrates how to add various procedure results.
        /// </i>
        /// </para>
        /// <code lang="C#" source="../Tango.FSE.Procedures/Examples/AddResult/Program.cs" title="Add results" region="Example" />
        /// </example>
        Result AddGraphResult(ResultType type, String name, IEnumerable<double> values);

        /// <summary>
        /// Adds a new procedure result with custom appearance by providing a bitmap to draw as the result.
        /// Use the <see cref="CreateBitmap(int, int)"/> to create a new bitmap.
        /// Then, <see cref="GetDrawingContext(Bitmap)"/> to get the bitmap drawing context in order to start drawing.
        /// </summary>
        /// <param name="type">Result type.</param>
        /// <param name="name">Result title.</param>
        /// <param name="bitmap">Result bitmap.</param>
        /// <returns>The result instance.</returns>
        /// <example>
        /// <para>
        /// <i>
        /// The following example demonstrates how to add various procedure results.
        /// </i>
        /// </para>
        /// <code lang="C#" source="../Tango.FSE.Procedures/Examples/AddResult/Program.cs" title="Add results" region="Example" />
        /// </example>
        Result AddBitmapResult(ResultType type, String name, Bitmap bitmap);

        /// <summary>
        /// Creates a new bitmap to be provided as a bitmap result via <see cref="AddBitmapResult(ResultType, string, Bitmap)"/>.
        /// </summary>
        /// <param name="width">The bitmap width.</param>
        /// <param name="height">The bitmap height.</param>
        /// <returns>The bitmap instance.</returns>
        Bitmap CreateBitmap(int width, int height);

        /// <summary>
        /// Creates a new drawing context for the specified bitmap.
        /// </summary>
        /// <remarks>
        /// Please use <see cref="Graphics.Dispose"/> when finish drawing.
        /// </remarks>
        /// <param name="bitmap">The bitmap.</param>
        /// <returns>The drawing context.</returns>
        Graphics GetDrawingContext(Bitmap bitmap);

        /// <summary>
        /// Adds a new procedure result.
        /// </summary>
        /// <param name="result">The result.</param>
        /// <returns></returns>
        [HideIntellisense]
        Result AddResult(Result result);

        /// <summary>
        /// Removes the specified procedure result.
        /// </summary>
        /// <param name="result">The result.</param>
        void RemoveResult(Result result);

        /// <summary>
        /// Clears all current procedure results.
        /// </summary>
        void ClearResults();

        /// <summary>
        /// Sends a stub request by name, with optional timeout and comma separated arguments.
        /// </summary>
        /// <remarks>
        /// This method accepts only stub messages.
        /// </remarks>
        /// <param name="messageName">Full or shortened name of the message (e.g "CalculateRequest" or "calculate").</param>
        /// <param name="timeout">Request timeout.</param>
        /// <param name="args">Request arguments separated by commas.</param>
        /// <returns>The corresponding response message.</returns>
        /// <example>
        /// <para>
        /// <i>
        /// The following example demonstrates how to send a request to the machine and get a response using the various different Send method overrides.
        /// </i>
        /// </para>
        /// <code lang="C#" source="../Tango.FSE.Procedures/Examples/Send/Program.cs" title="Send a request" region="Example" />
        /// </example>
        IMessage Send(String messageName, TimeSpan? timeout = null, params Object[] args);

        /// <summary>
        /// Sends a request by name with optional comma separated arguments.
        /// </summary>
        /// <remarks>
        /// This method accepts only stub messages.
        /// </remarks>
        /// <param name="messageName">Full or shortened name of the message (e.g "CalculateRequest" or "calculate").</param>
        /// <param name="args">Request arguments separated by commas.</param>
        /// <returns>The corresponding response message.</returns>
        /// <example>
        /// <para>
        /// <i>
        /// The following example demonstrates how to send a request to the machine and get a response using the various different Send method overrides.
        /// </i>
        /// </para>
        /// <code lang="C#" source="../Tango.FSE.Procedures/Examples/Send/Program.cs" title="Send a request" region="Example" />
        /// </example>
        IMessage Send(String messageName, params Object[] args);

        /// <summary>
        /// Sends a request by name with optional timeout and comma separated arguments.
        /// </summary>
        /// <remarks>
        /// This method accepts only stub messages.
        /// </remarks>
        /// <typeparam name="T">Type of expected response message.</typeparam>
        /// <param name="messageName">Full or shortened name of the message (e.g "CalculateRequest" or "calculate").</param>
        /// <param name="timeout">The request timeout.</param>
        /// <param name="args">Request arguments separated by commas.</param>
        /// <returns>The corresponding response message of type T.</returns>
        /// <example>
        /// <para>
        /// <i>
        /// The following example demonstrates how to send a request to the machine and get a response using the various different Send method overrides.
        /// </i>
        /// </para>
        /// <code lang="C#" source="../Tango.FSE.Procedures/Examples/Send/Program.cs" title="Send a request" region="Example" />
        /// </example>
        T Send<T>(String messageName, TimeSpan? timeout = null, params Object[] args) where T : class, IMessage;

        /// <summary>
        /// Sends a request by name with optional comma separated arguments.
        /// </summary>
        /// <remarks>
        /// This method accepts only stub messages.
        /// </remarks>
        /// <typeparam name="T">Type of expected response message.</typeparam>
        /// <param name="messageName">Full or shortened name of the message (e.g "CalculateRequest" or "calculate").</param>
        /// <param name="args">Request arguments separated by commas.</param>
        /// <returns>The corresponding response message of type T.</returns>
        /// <example>
        /// <para>
        /// <i>
        /// The following example demonstrates how to send a request to the machine and get a response using the various different Send method overrides.
        /// </i>
        /// </para>
        /// <code lang="C#" source="../Tango.FSE.Procedures/Examples/Send/Program.cs" title="Send a request" region="Example" />
        /// </example>
        T Send<T>(String messageName, params Object[] args) where T : class, IMessage;

        /// <summary>
        /// Sends the specified request message.
        /// </summary>
        /// <param name="message">Request message instance.</param>
        /// <param name="timeout">Request timeout in seconds. (leave empty to get the default timeout)</param>
        /// <returns>The corresponding response message.</returns>
        /// <example>
        /// <para>
        /// <i>
        /// The following example demonstrates how to send a request to the machine and get a response using the various different Send method overrides.
        /// </i>
        /// </para>
        /// <code lang="C#" source="../Tango.FSE.Procedures/Examples/Send/Program.cs" title="Send a request" region="Example" />
        /// </example>
        IMessage Send(IMessage message, int? timeout = null);

        /// <summary>
        /// Sends the specified request message.
        /// </summary>
        /// <typeparam name="T">Type of expected response message.</typeparam>
        /// <param name="message">Request message instance.</param>
        /// <param name="timeout">Request timeout in seconds. (leave empty to get the default timeout)</param>
        /// <returns>The corresponding response message of type T.</returns>
        /// <example>
        /// <para>
        /// <i>
        /// The following example demonstrates how to send a request to the machine and get a response using the various different Send method overrides.
        /// </i>
        /// </para>
        /// <code lang="C#" source="../Tango.FSE.Procedures/Examples/Send/Program.cs" title="Send a request" region="Example" />
        /// </example>
        T Send<T>(IMessage message, int? timeout = null) where T : class, IMessage;

        /// <summary>
        /// Sends the specified continuous request message.
        /// </summary>
        /// <typeparam name="T">Type of expected continuous response message.</typeparam>
        /// <param name="message">Request message instance.</param>
        /// <param name="callback">Specify a callback method to handle the incoming response messages.</param>
        /// <param name="timeout">First and continuous request timeout in seconds. (leave empty to get the default timeout)</param>
        /// <example>
        /// <para>
        /// <i>
        /// The following example demonstrates how to send a continuous request to the machine and get a continuous response using the various different SendContinuous method overrides.
        /// </i>
        /// </para>
        /// <code lang="C#" source="../Tango.FSE.Procedures/Examples/SendContinuous/Program.cs" title="Send a continuous request" region="Example" />
        /// </example>
        void SendContinuous<T>(IMessage message, Action<T> callback, int? timeout) where T : class, IMessage;

        /// <summary>
        /// Sends a continuous request message with optional timeout and comma separated arguments.
        /// </summary>
        /// <remarks>
        /// This method accepts only stub messages.
        /// </remarks>
        /// <typeparam name="T">Type of expected continuous response message.</typeparam>
        /// <param name="messageName">Full or shortened name of the message (e.g "CalculateRequest" or "calculate").</param>
        /// <param name="callback">Specify a callback method to handle the incoming response messages.</param>
        /// <param name="timeout">First and continuous request timeout in seconds. (leave empty to get the default timeout)</param>
        /// <param name="args">Request arguments separated by commas.</param>
        /// <example>
        /// <para>
        /// <i>
        /// The following example demonstrates how to send a continuous request to the machine and get a continuous response using the various different SendContinuous method overrides.
        /// </i>
        /// </para>
        /// <code lang="C#" source="../Tango.FSE.Procedures/Examples/SendContinuous/Program.cs" title="Send a continuous request" region="Example" />
        /// </example>
        void SendContinuous<T>(String messageName, Action<T> callback, TimeSpan? timeout, params Object[] args) where T : class, IMessage;

        /// <summary>
        /// Sends a continuous request message with optional timeout and comma separated arguments.
        /// </summary>
        /// <remarks>
        /// This method accepts only stub messages.
        /// </remarks>
        /// <typeparam name="T">Type of expected continuous response message.</typeparam>
        /// <param name="messageName">Full or shortened name of the message (e.g "CalculateRequest" or "calculate").</param>
        /// <param name="callback">Specify a callback method to handle the incoming response messages.</param>
        /// <param name="args">Request arguments separated by commas.</param>
        /// <example>
        /// <para>
        /// <i>
        /// The following example demonstrates how to send a continuous request to the machine and get a continuous response using the various different SendContinuous method overrides.
        /// </i>
        /// </para>
        /// <code lang="C#" source="../Tango.FSE.Procedures/Examples/SendContinuous/Program.cs" title="Send a continuous request" region="Example" />
        /// </example>
        void SendContinuous<T>(String messageName, Action<T> callback, params Object[] args) where T : class, IMessage;

        /// <summary>
        /// Writes the specified object string representation to the output window.
        /// </summary>
        /// <param name="obj">The object.</param>
        void WriteLine(Object obj);

        /// <summary>
        /// Writes a carriage return to the output window.
        /// </summary>
        void WriteLine();

        /// <summary>
        /// Writes the specified object string representation to the output window.
        /// </summary>
        /// <param name="obj">The object.</param>
        void Write(Object obj);

        /// <summary>
        /// Writes the hexadecimal representation of the specified object to the output window.
        /// </summary>
        /// <param name="number">The number.</param>
        /// <param name="digits">The digits.</param>
        void WriteLineHex(Object number, int digits);

        /// <summary>
        /// Writes the hexadecimal representation of the specified object to the output window.
        /// </summary>
        /// <param name="number">The number.</param>
        /// <param name="digits">The digits.</param>
        void WriteHex(Object number, int digits);

        /// <summary>
        /// Writes the specified array to the output window using the specified parsing style.
        /// </summary>
        /// <param name="array">The array.</param>
        /// <param name="style">Array parsing style.</param>
        void WriteLineArray(IEnumerable array, ArrayParsingStyle style);

        /// <summary>
        /// Reads the specified file as string.
        /// </summary>
        /// <param name="path">The file path.</param>
        /// <returns>The file text content.</returns>
        String GetFileText(String path);

        /// <summary>
        /// Read the specified file bytes.
        /// </summary>
        /// <param name="path">The file path.</param>
        /// <returns>The file byte array.</returns>
        byte[] GetFileBytes(String path);

        /// <summary>
        /// Clears the output window.
        /// </summary>
        void Clear();

        /// <summary>
        /// Writes a string to the specified file.
        /// If the file already exists it will be overwritten.
        /// </summary>
        /// <param name="filePath">The file path.</param>
        /// <param name="content">The content.</param>
        void WriteToFile(String filePath, String content);

        /// <summary>
        /// Appends the string content to the specified file.
        /// </summary>
        /// <param name="filePath">The file path.</param>
        /// <param name="content">The content.</param>
        void AppendToFile(String filePath, String content);

        /// <summary>
        /// Get the value of a user input by key.
        /// </summary>
        /// <typeparam name="T">Type of expected value.</typeparam>
        /// <param name="key">The input key.</param>
        /// <returns>The input value.</returns>
        T GetInput<T>(String key);

        /// <summary>
        /// Gets the value of a user input as an array.
        /// User input must be a comma separated string.
        /// </summary>
        /// <typeparam name="T">Type of expected values.</typeparam>
        /// <param name="key">The input key.</param>
        /// <returns>List containing the input array.</returns>
        List<T> GetInputArray<T>(String key);

        /// <summary>
        /// Get the value of a user input by key.
        /// </summary>
        /// <param name="key">The input key.</param>
        /// <returns>The input value.</returns>
        Object GetInput(String key);

        /// <summary>
        /// Fails the procedure with the specified error message.
        /// </summary>
        /// <param name="message">The error message.</param>
        void Fail(String message);

        /// <summary>
        /// Displays an information message to the user.
        /// </summary>
        /// <param name="message">The message.</param>
        void ShowInfo(String message);

        /// <summary>
        /// Displays a warning message to the user.
        /// </summary>
        /// <param name="message">The message.</param>
        void ShowWarning(String message);

        /// <summary>
        /// Displays an error message to the user.
        /// </summary>
        /// <param name="message">The message.</param>
        void ShowError(String message);

        /// <summary>
        /// Present the user with a question an returns a value indicating the confirmation.
        /// </summary>
        /// <param name="message">The message.</param>
        /// <returns></returns>
        bool ShowQuestion(String message);

        /// <summary>
        /// Presents the user with a warning and returns a value indicating the confirmation.
        /// </summary>
        /// <param name="message">The message.</param>
        /// <returns></returns>
        bool ShowWarningQuestion(String message);

        /// <summary>
        /// Displays an information message to the remote user.
        /// </summary>
        /// <param name="message">The message.</param>
        /// <param name="timeout">Timeout in seconds.</param>
        void ShowInfoRemote(String message, int timeout);

        /// <summary>
        /// Displays a warning message to the remote user.
        /// </summary>
        /// <param name="message">The message.</param>
        /// <param name="timeout">Timeout in seconds.</param>
        void ShowWarningRemote(String message, int timeout);

        /// <summary>
        /// Displays an error message to the remote user.
        /// </summary>
        /// <param name="message">The message.</param>
        /// <param name="timeout">Timeout in seconds.</param>
        void ShowErrorRemote(String message, int timeout);

        /// <summary>
        /// Present the remote user with a question an returns a value indicating the confirmation.
        /// </summary>
        /// <param name="message">The message.</param>
        /// <param name="timeout">Timeout in seconds.</param>
        /// <returns></returns>
        bool ShowQuestionRemote(String message, int timeout);

        /// <summary>
        /// Request user input for the specified primitive or complex type (model).
        /// </summary>
        /// <typeparam name="T">Type of input (primitive or complex)</typeparam>
        /// <param name="title">The request title.</param>
        /// <param name="message">The request message.</param>
        /// <returns>Request result of type T.</returns>
        /// <example>
        /// <para>
        /// <i>
        /// The following example demonstrates how to create a model and request the user to fill or modify that model.
        /// The model can contain primitives, arrays (comma separated), enums and booleans.
        /// </i>
        /// </para>
        /// <code lang="C#" source="../Tango.FSE.Procedures/Examples/RequestUserInputFor/Program.cs" title="Request user input" region="Example" />
        /// </example>
        T RequestUserInputFor<T>(String title, String message);

        /// <summary>
        /// Request a user input for the specified primitive or complex type (model).
        /// </summary>
        /// <typeparam name="T">Type of input (primitive or complex)</typeparam>
        /// <param name="model">Existing model (default values).</param>
        /// <param name="title">The request title.</param>
        /// <param name="message">The request message.</param>
        /// <returns>Request result of type T.</returns>
        /// <example>
        /// <para>
        /// <i>
        /// The following example demonstrates how to create a model and request the user to fill or modify that model.
        /// The model can contain primitives, arrays (comma separated), enums and booleans.
        /// </i>
        /// </para>
        /// <code lang="C#" source="../Tango.FSE.Procedures/Examples/RequestUserInputFor/Program.cs" title="Request user input" region="Example" />
        /// </example>
        T RequestUserInputFor<T>(T model, String title, String message);

        /// <summary>
        /// Requests a file selection from the user.
        /// </summary>
        /// <param name="message">The message.</param>
        /// <param name="extension">Extension filter (default "*.*").</param>
        /// <returns>The full path to the selected file or null if user canceled.</returns>
        String RequestFileOpen(String message, String extension = "*.*");

        /// <summary>
        /// Requests a file save location from the user.
        /// </summary>
        /// <param name="message">The message.</param>
        /// <param name="extension">Extension filter (default "*.*").</param>
        /// <param name="defaultFileName">Optional default file name.</param>
        /// <returns>The full path to the selected file or null if user canceled.</returns>
        String RequestFileSave(String message, String extension = "*.*", String defaultFileName = null);

        /// <summary>
        /// Requests a folder path from the user.
        /// </summary>
        /// <param name="message">The message.</param>
        /// <returns></returns>
        String RequestFolderSelect(String message);

        /// <summary>
        /// Updates the procedure user progress.
        /// </summary>
        /// <param name="message">The progress message.</param>
        /// <param name="isIndeterminate">Is the progress indeterminate (no need to set value and max).</param>
        /// <param name="value">The progress value.</param>
        /// <param name="maximum">The maximum progress.</param>
        void UpdateProgress(String message, bool isIndeterminate = true, double value = 0, double maximum = 100);

        /// <summary>
        /// Gets the current diagnostics package.
        /// </summary>
        /// <param name="waitForNext">Blocks the execution until a fresh diagnostics frame is available.
        /// This will guarantee that you will get a distinct package each time.
        /// </param>
        /// <returns>The diagnostics package.</returns>
        /// <example>
        /// <para>
        /// <i>
        /// The following example demonstrates how to collect 100 middle dancer samples and plot them as a graph result.
        /// </i>
        /// </para>
        /// <code lang="C#" source="../Tango.FSE.Procedures/Examples/Diagnostics/Program.cs" title="Collect dancer samples" region="Example" />
        /// </example>
        /// <seealso cref="AddGraphResult(ResultType, string, IEnumerable{double})"/>
        DiagnosticsPackage GetDiagnosticsPackage(bool waitForNext = false);

        /// <summary>
        /// Pauses the procedure execution for the specified time in milliseconds.
        /// </summary>
        /// <param name="milliseconds">Milliseconds.</param>
        void Sleep(int milliseconds);

        /// <summary>
        /// Runs the specified action asynchronously.
        /// </summary>
        /// <param name="action">The action.</param>
        /// <returns>The thread instance that has been created for the task.</returns>
        Thread RunAsync(Action action);

        /// <summary>
        /// Loads the specified procedure dialog on the main UI thread as a standard FSE dialog.
        /// </summary>
        /// <param name="name">The name of the dialog file.</param>
        /// <returns>The dialog controller.</returns>
        IDialogController LoadDialog(String name);

        /// <summary>
        /// Loads the specified procedure dialog as a window on the current thread.
        /// </summary>
        /// <param name="name">The name of the dialog.</param>
        /// <param name="windowTitle">The window title.</param>
        /// <returns>The dialog controller.</returns>
        IDialogWindowController LoadDialogAsWindow(String name, String windowTitle);

        /// <summary>
        /// Gets the type of the current machine connection.
        /// It is recommended to use <see cref="IsConnected"/> before, to ensure active machine connection.
        /// </summary>
        /// <example>
        /// <para>
        /// <i>
        /// The following example demonstrates how to check for valid machine connection, check the connection type and get the connected machine's serial number.
        /// </i>
        /// </para>
        /// <code lang="C#" source="../Tango.FSE.Procedures/Examples/Connection/Program.cs" title="Validate connection" region="Example" />
        /// </example>
        MachineConnectionTypes ConnectionType { get; }

        /// <summary>
        /// Gets or sets a value indicating whether a machine is currently connected.
        /// </summary>
        /// <example>
        /// <para>
        /// <i>
        /// The following example demonstrates how to check for valid machine connection, check the connection type and get the connected machine's serial number.
        /// </i>
        /// </para>
        /// <code lang="C#" source="../Tango.FSE.Procedures/Examples/Connection/Program.cs" title="Validate connection" region="Example" />
        /// </example>
        bool IsConnected { get; }

        /// <summary>
        /// Gets the currently connected machine entity.
        /// </summary>
        /// <example>
        /// <para>
        /// <i>
        /// The following example demonstrates how to check for valid machine connection, check the connection type and get the connected machine's serial number.
        /// </i>
        /// </para>
        /// <code lang="C#" source="../Tango.FSE.Procedures/Examples/Connection/Program.cs" title="Validate connection" region="Example" />
        /// </example>
        Machine ConnectedMachine { get; }

        /// <summary>
        /// Gets the specified service of type T from the global Tango FSE IOC container..
        /// </summary>
        /// <typeparam name="T">Type of service</typeparam>
        /// <returns>The service instance.</returns>
        T GetService<T>();

        /// <summary>
        /// Gets the specified resource as byte array.
        /// </summary>
        /// <param name="resourceName">Name of the resource.</param>
        /// <returns>Resource bytes.</returns>
        byte[] GetResourceBytes(String resourceName);

        /// <summary>
        /// Gets the specified resource as UTF-8 string.
        /// </summary>
        /// <param name="resourceName">Name of the resource.</param>
        /// <returns>Resource text.</returns>
        String GetResourceString(String resourceName);

        /// <summary>
        /// Copies the specified resource to a temporary path and opens it using the default windows application.
        /// </summary>
        /// <param name="resourceName">Name of the resource.</param>
        void OpenResource(String resourceName);

        /// <summary>
        /// Gets the specified procedure variable value.
        /// </summary>
        /// <param name="name">The name of the variable.</param>
        /// <returns>The variable value.</returns>
        Object GetVariable(String name);

        /// <summary>
        /// Gets the specified procedure variable value.
        /// </summary>
        /// <typeparam name="T">Type of expected variable value.</typeparam>
        /// <param name="name">The name of the variable.</param>
        /// <returns>The variable value of type T.</returns>
        T GetVariable<T>(String name);

        /// <summary>
        /// Gets the specified procedure variable value as an array.
        /// Value must be a comma separated string.
        /// </summary>
        /// <param name="name">The name of the variable.</param>
        /// <returns>List containing the variable values.</returns>
        List<T> GetVariableArray<T>(String name);

        /// <summary>
        /// Reads the specified csv file to a list of type T.
        /// The given type T model must contain properties not fields.
        /// </summary>
        /// <typeparam name="T">CSV model type.</typeparam>
        /// <param name="file">The file path.</param>
        /// <returns>A list containing all the CSV rows as models of type T.</returns>
        /// <example>
        /// <para>
        /// <i>
        /// The following example demonstrates CSV file writing and reading.
        /// The csv reading method also accepts a byte array so you can also read a CSV file from a procedure resource.
        /// </i>
        /// </para>
        /// <code lang="C#" source="../Tango.FSE.Procedures/Examples/Csv/Program.cs" title="Read/Write CSV" region="Example" />
        /// </example>
        List<T> ReadCsv<T>(String file) where T : class, new();

        /// <summary>
        /// Reads the specified csv byte array to a list of type T.
        /// The given type T model must contain properties not fields.
        /// </summary>
        /// <typeparam name="T">CSV model type.</typeparam>
        /// <param name="data">The byte array.</param>
        /// <returns>A list containing all the CSV rows as models of type T.</returns>
        /// <example>
        /// <para>
        /// <i>
        /// The following example demonstrates CSV file writing and reading.
        /// The csv reading method also accepts a byte array so you can also read a CSV file from a procedure resource.
        /// </i>
        /// </para>
        /// <code lang="C#" source="../Tango.FSE.Procedures/Examples/Csv/Program.cs" title="Read/Write CSV" region="Example" />
        /// </example>
        List<T> ReadCsv<T>(byte[] data) where T : class, new();

        /// <summary>
        /// Writes a CSV file to the specified file.
        /// The given type T model must contain properties not fields.
        /// </summary>
        /// <typeparam name="T">CSV model type.</typeparam>
        /// <param name="file">The output file path.</param>
        /// <param name="items">The items to write.</param>
        /// <example>
        /// <para>
        /// <i>
        /// The following example demonstrates CSV file writing and reading.
        /// The csv reading method also accepts a byte array so you can also read a CSV file from a procedure resource.
        /// </i>
        /// </para>
        /// <code lang="C#" source="../Tango.FSE.Procedures/Examples/Csv/Program.cs" title="Read/Write CSV" region="Example" />
        /// </example>
        void WriteCsv<T>(String file, List<T> items);

        /// <summary>
        /// Gets the remote data store manager.
        /// </summary>
        /// <returns></returns>
        IRemoteDataStoreManager GetRemoteDataStoreManager();

        /// <summary>
        /// Request a breakpoint operation from the host IDE (internal use only).
        /// </summary>
        /// <param name="file">The file.</param>
        /// <param name="lineNumber">The line number.</param>
        /// <param name="symbolsMap">The symbols map.</param>
        [HideIntellisense]
        void BreakPoint(String file, int lineNumber, params Object[] symbolsMap);

        /// <summary>
        /// Gets or sets the optional exit action for this script.
        /// </summary>
        [HideIntellisense]
        Action<IProcedureContext> OnExitAction { get; set; }
    }
}