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.Text;
using System.Threading;
using System.Threading.Tasks;
using Tango.BL.Entities;
using Tango.Core;
using Tango.FSE.Common.Connection;
using Tango.FSE.Common.Diagnostics;
using Tango.Integration.Operation;
using Tango.Scripting.Basic;

namespace Tango.FSE.Procedures
{
    public interface IProcedureContext : IContext
    {
        /// <summary>
        /// Occurs when the procedure is reporting about some progress.
        /// </summary>
        event EventHandler<TangoProgressChangedEventArgs<double>> Progress;

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

        /// <summary>
        /// Adds a new procedure result.
        /// </summary>
        /// <param name="type">The result type.</param>
        /// <param name="name">The result name.</param>
        /// <param name="value">The result value.</param>
        /// <returns></returns>
        Result AddResult(ResultType type, String name, object value);

        /// <summary>
        /// Adds a new procedure graph result.
        /// </summary>
        /// <param name="type">The type.</param>
        /// <param name="name">The name.</param>
        /// <param name="values">The values.</param>
        /// <returns></returns>
        Result AddGraphResult(ResultType type, String name, IEnumerable<double> values);

        /// <summary>
        /// Adds a new procedure bitmap result.
        /// </summary>
        /// <param name="type">The type.</param>
        /// <param name="name">The name.</param>
        /// <param name="bitmap">The bitmap.</param>
        /// <returns></returns>
        Result AddBitmapResult(ResultType type, String name, Bitmap bitmap);

        /// <summary>
        /// Creates a new bitmap.
        /// </summary>
        /// <param name="width">The bitmap width.</param>
        /// <param name="height">The bitmap height.</param>
        /// <returns></returns>
        Bitmap CreateBitmap(int width, int height);

        /// <summary>
        /// Creates a new drawing context for the specified bitmap.
        /// </summary>
        /// <param name="bitmap">The bitmap.</param>
        /// <returns></returns>
        Graphics GetDrawingContext(Bitmap bitmap);

        /// <summary>
        /// Adds a new procedure result.
        /// </summary>
        /// <param name="result">The result.</param>
        /// <returns></returns>
        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 request by name with optional comma separated arguments.
        /// </summary>
        /// <param name="messageName">Name of the message.</param>
        /// <param name="timeout">The timeout in seconds.</param>
        /// <param name="args">The arguments separated by commas.</param>
        /// <returns></returns>
        IMessage Send(String messageName, TimeSpan? timeout = null, params Object[] args);

        /// <summary>
        /// Sends a request by name with optional comma separated arguments.
        /// </summary>
        /// <param name="messageName">Name of the message.</param>
        /// <param name="args">The arguments separated by commas.</param>
        /// <returns></returns>
        IMessage Send(String messageName, params Object[] args);

        /// <summary>
        /// Sends a request by name with optional comma separated arguments.
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="messageName">Name of the message.</param>
        /// <param name="timeout">The timeout in seconds.</param>
        /// <param name="args">The arguments separated by commas.</param>
        /// <returns></returns>
        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>
        /// <typeparam name="T"></typeparam>
        /// <param name="messageName">Name of the message.</param>
        /// <param name="args">The arguments separated by commas.</param>
        /// <returns></returns>
        T Send<T>(String messageName, params Object[] args) where T : class, IMessage;

        /// <summary>
        /// Sends the specified message.
        /// </summary>
        /// <param name="message">The message.</param>
        /// <param name="timeout">The timeout in seconds.</param>
        /// <returns></returns>
        IMessage Send(IMessage message, int? timeout = null);

        /// <summary>
        /// Sends the specified message.
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="message">The message.</param>
        /// <param name="timeout">The timeout in seconds.</param>
        /// <returns></returns>
        T Send<T>(IMessage message, int? timeout = null) where T : class, IMessage;

        /// <summary>
        /// Sends the specified continuous message.
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="message">The message.</param>
        /// <param name="callback">Callback for continuous responses.</param>
        /// <param name="timeout">The timeout in seconds.</param>
        void SendContinuous<T>(IMessage message, Action<T> callback, int? timeout) where T : class, IMessage;

        /// <summary>
        /// Sends a continuous message with optional comma separated arguments.
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="messageName">Name of the message.</param>
        /// <param name="callback">Callback for continuous responses.</param>
        /// <param name="timeout">The timeout in seconds.</param>
        /// <param name="args">The arguments.</param>
        void SendContinuous<T>(String messageName, Action<T> callback, int? timeout, params Object[] args) where T : class, IMessage;

        /// <summary>
        /// Sends a continuous message with optional comma separated arguments.
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="messageName">Name of the message.</param>
        /// <param name="callback">Callback for continuous responses.</param>
        /// <param name="args">The arguments.</param>
        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 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">The style.</param>
        void WriteLineArray(IEnumerable array, ArrayParsingStyle style);

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

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

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

        /// <summary>
        /// Writes a string content 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"></typeparam>
        /// <param name="key">The input key.</param>
        /// <returns></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"></typeparam>
        /// <param name="key">The input key.</param>
        /// <returns></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></returns>
        Object GetInput(String key);

        /// <summary>
        /// Fails the current 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>
        /// Request a user input for the specified primitive or complex type.
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="title">The request title.</param>
        /// <param name="message">The request message.</param>
        /// <returns></returns>
        T RequestUserInputFor<T>(String title, String message);

        /// <summary>
        /// Request a user input for the specified primitive or complex type (model).
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="model">The existing model.</param>
        /// <param name="title">The request title.</param>
        /// <param name="message">The request message.</param>
        /// <returns></returns>
        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></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></returns>
        String RequestFileSave(String message, String extension = "*.*", String defaultFileName = null);

        /// <summary>
        /// Updates the procedure progress.
        /// </summary>
        /// <param name="message">The message.</param>
        /// <param name="isIndeterminate">Is the progress indeterminate (not 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 latest diagnostics package.
        /// </summary>
        /// <param name="waitForNext">Waits for a fresh package.</param>
        /// <returns></returns>
        DiagnosticsPackage GetDiagnosticsPackage(bool waitForNext = false);

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

        /// <summary>
        /// Runs the specified action asynchronously.
        /// </summary>
        /// <param name="action">The action.</param>
        /// <returns></returns>
        Thread RunAsync(Action action);

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

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

        /// <summary>
        /// Gets the type of the current machine connection.
        /// </summary>
        MachineConnectionTypes ConnectionType { get; }

        /// <summary>
        /// Gets or sets a value indicating whether a machine is currently connected.
        /// </summary>
        bool IsConnected { get; }

        /// <summary>
        /// Gets the currently connected machine entity.
        /// </summary>
        Machine ConnectedMachine { get; }

        /// <summary>
        /// Gets a registered injected service from the Tango FSE application.
        /// </summary>
        /// <typeparam name="T">Type of service</typeparam>
        /// <returns></returns>
        T GetService<T>();

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

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

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

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

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

        /// <summary>
        /// Gets the specified procedure variable value as an array.
        /// User value must be a comma separated string.
        /// </summary>
        /// <param name="name">The name of the variable.</param>
        /// <returns></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"></typeparam>
        /// <param name="file">The file path.</param>
        /// <returns></returns>
        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"></typeparam>
        /// <param name="data">The data.</param>
        /// <returns></returns>
        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"></typeparam>
        /// <param name="file">The file path.</param>
        /// <param name="items">The items to write.</param>
        void WriteCsv<T>(String file, List<T> items);
    }
}