Version: 15.0

    Show / Hide Table of Contents

    Class ScriptingSetup

    Inheritance
    System.Object
    APIBase
    PersistentSingleton
    PerMachineSettings
    ScriptingSetup
    Implements
    System.IEquatable<APIBase>
    Inherited Members
    PerMachineSettings.ResetToDefaults()
    PersistentSingleton.Save()
    PersistentSingleton.OutputDefaultReportTo(String)
    PersistentSingleton.GetDefaultReportWithEncodedImages()
    PersistentSingleton.OutputActiveReportTo(String)
    PersistentSingleton.OutputActiveReportAsTextTo(String)
    PersistentSingleton.GetActiveReportWithEncodedImages()
    PersistentSingleton.OutputNamedReportTo(String, String)
    PersistentSingleton.OutputNamedReportAsMastaReport(String, String)
    PersistentSingleton.OutputNamedReportAsTextTo(String, String)
    PersistentSingleton.GetNamedReportWithEncodedImages(String)
    PersistentSingleton.ReportNames
    APIBase.DisconnectFromMASTA()
    APIBase.GetProperty<T>(String)
    APIBase.SetProperty(String, Object)
    APIBase.clearCachedRpds()
    APIBase.getNamedObjectList<TElementType>(String)
    APIBase.getExpandableProperty<TReturnType>(String)
    APIBase.callPartialMethod(String, [])
    APIBase.callPartialMethod<T>(String, T)
    APIBase.callPartialMethod<T>(String, , T)
    APIBase.callPartialMethod<T>(String, , , T)
    APIBase.callPartialMethod<T>(String, , , , T)
    APIBase.callPartialMethod<T1, T2>(String, , T1, T2)
    APIBase.getPartialProperty(String)
    APIBase.setPartialProperty(String, Object)
    APIBase.IsValid(String)
    APIBase.IsReadOnly(String)
    APIBase.DocumentationUrl()
    APIBase.ToString()
    APIBase.RunPython<T>(String, String, Object)
    APIBase.RunPythonCode<T>(String, String, Object)
    APIBase.RunPythonCode<T>(String)
    APIBase.RunPython<T>(String, String)
    APIBase.RunPython(String, String, Object)
    APIBase.createWrappedRange(Double, Double)
    APIBase.createWrappedVector2D(Double, Double)
    APIBase.createWrappedPosition3D(Double, Double, Double)
    APIBase.ToListWithSelectedItem<T>(IEnumerable<T>)
    APIBase.ToListWithSelectedItem<T>(T, IEnumerable<T>)
    APIBase.Equals(APIBase)
    APIBase.GetHashCode()
    APIBase.Equals(Object)
    APIBase.InvalidProperties
    APIBase.ReadOnlyProperties
    APIBase.AllPropertiesAreReadOnly
    APIBase.AllPropertiesAreInvalid
    APIBase.cacheRpds
    APIBase.isInvalid
    Namespace: SMT.MastaAPI.Utility.Scripting
    Assembly: SMT.MastaAPI.15.0.dll
    Syntax
    public sealed class ScriptingSetup : PerMachineSettings, IEquatable<APIBase>

    Properties

    DisplayPythonPropertyHints

    Declaration
    public bool DisplayPythonPropertyHints { get; set; }
    Property Value
    Type Description
    System.Boolean

    ImageHeight

    Declaration
    public int ImageHeight { get; set; }
    Property Value
    Type Description
    System.Int32

    ImageWidth

    Declaration
    public int ImageWidth { get; set; }
    Property Value
    Type Description
    System.Int32

    LoadScriptedPropertiesWhenOpeningMASTA

    If loaded when opening MASTA clicking "Recompile" in the scripting tab is not required. However compiling the properties can take a long time.

    Declaration
    public bool LoadScriptedPropertiesWhenOpeningMASTA { get; set; }
    Property Value
    Type Description
    System.Boolean

    MastapyVersion

    Declaration
    public string MastapyVersion { get; }
    Property Value
    Type Description
    System.String

    PythonExePath

    Declaration
    public string PythonExePath { get; }
    Property Value
    Type Description
    System.String

    PythonHomeDirectory

    Declaration
    public string PythonHomeDirectory { get; }
    Property Value
    Type Description
    System.String

    PythonInstallDirectory

    Declaration
    public string PythonInstallDirectory { get; set; }
    Property Value
    Type Description
    System.String

    PythonRemoteHost

    Declaration
    public string PythonRemoteHost { get; set; }
    Property Value
    Type Description
    System.String

    PythonRemotePort

    Declaration
    public int PythonRemotePort { get; set; }
    Property Value
    Type Description
    System.Int32

    PythonRemoteTimeoutS

    Declaration
    public int PythonRemoteTimeoutS { get; set; }
    Property Value
    Type Description
    System.Int32

    RunScriptsInSeparateThreads

    Running scripts in separate threads allows pausing / resuming the MASTA User Interface. If scripts create their own User Interfaces then errors can occur accessing controls on different threads.

    Declaration
    public bool RunScriptsInSeparateThreads { get; set; }
    Property Value
    Type Description
    System.Boolean

    UseDefaultNETSolutionDirectory

    Declaration
    public bool UseDefaultNETSolutionDirectory { get; set; }
    Property Value
    Type Description
    System.Boolean

    UseDefaultPluginDirectory

    Declaration
    public bool UseDefaultPluginDirectory { get; set; }
    Property Value
    Type Description
    System.Boolean

    UseDefaultPythonScriptsDirectory

    Declaration
    public bool UseDefaultPythonScriptsDirectory { get; set; }
    Property Value
    Type Description
    System.Boolean

    UseDefaultVirtualEnvironmentPath

    Declaration
    public bool UseDefaultVirtualEnvironmentPath { get; set; }
    Property Value
    Type Description
    System.Boolean

    UseDefaultVisualStudioCodeDirectory

    Declaration
    public bool UseDefaultVisualStudioCodeDirectory { get; set; }
    Property Value
    Type Description
    System.Boolean

    VirtualEnvironmentName

    Declaration
    public string VirtualEnvironmentName { get; set; }
    Property Value
    Type Description
    System.String

    VisualStudioCodeDirectory

    Visual Studio Code is required for Python remote debugging. By default we try and find Visual Studio Code on the PATH environment variable. Enter an absolute path to the Visual Studio Code directory here if it cannot be found.

    Declaration
    public string VisualStudioCodeDirectory { get; set; }
    Property Value
    Type Description
    System.String

    Methods

    AddExistingNETSolution()

    Declaration
    public void AddExistingNETSolution()

    PythonVirtualEnvironmentInitialisation()

    Creates a new virtual environment in the path specified, including the version of Mastapy already installed locally with MASTA. This can be done once per MASTA Startup.

    Declaration
    public void PythonVirtualEnvironmentInitialisation()

    RestoreAPIPackages()

    Extracts the API packages (including legacy versions) from the SMT NuGet server to the executable directory. Any existing API DLLs will be ignored.

    Declaration
    public void RestoreAPIPackages()

    SelectDefaultPythonInstallDirectory()

    Declaration
    public void SelectDefaultPythonInstallDirectory()

    SelectNETSolutionDirectory()

    Declaration
    public void SelectNETSolutionDirectory()

    SelectPluginDirectory()

    Declaration
    public void SelectPluginDirectory()

    SelectPythonInstallDirectory()

    Declaration
    public void SelectPythonInstallDirectory()

    SelectPythonScriptsDirectory()

    Declaration
    public void SelectPythonScriptsDirectory()

    SelectPythonVirtualEnvironmentPath()

    Declaration
    public void SelectPythonVirtualEnvironmentPath()

    SelectVisualStudioCodeDirectory()

    Declaration
    public void SelectVisualStudioCodeDirectory()

    Implements

    System.IEquatable<T>

    Extension Methods

    UtilityMethods.IsReadOnly<T>(T, Expression<Func<T, Object>>)
    UtilityMethods.IsValid<T>(T, Expression<Func<T, Object>>)
    UtilityMethods.IsMethodValid<T>(T, Expression<Func<T, Action>>)
    UtilityMethods.IsMethodReadOnly<T>(T, Expression<Func<T, Action>>)
    Back to top