DiGi.Scripting.Python.Classes

DiGi.Scripting.Python

DiGi.Scripting.Python.Classes Namespace

Classes

Script Class

Provides an implementation of DiGi.Scripting.Classes.Script for executing Python scripts using the IronPython engine.

public class Script : DiGi.Scripting.Classes.Script

Inheritance DiGi.Core.Classes.SerializableObject → DiGi.Core.Interfaces.IObject → DiGi.Core.Interfaces.ISerializableObject → DiGi.Core.Interfaces.ICloneableObject → DiGi.Core.Interfaces.ICloneableObject → DiGi.Scripting.Classes.Script → Script

Constructors

Script(Code, IEnumerable<VariableType>, IEnumerable<VariableType>) Constructor

Initializes a new instance of the Script class with specified code and variable definitions.

public Script(DiGi.Scripting.Classes.Code? code, System.Collections.Generic.IEnumerable<DiGi.Scripting.Classes.VariableType> inputVariableTypes, System.Collections.Generic.IEnumerable<DiGi.Scripting.Classes.VariableType> outputVariableTypes);

Parameters

code DiGi.Scripting.Classes.Code

The source code to be executed.

inputVariableTypes System.Collections.Generic.IEnumerable<DiGi.Scripting.Classes.VariableType>

A collection of expected input variable types.

outputVariableTypes System.Collections.Generic.IEnumerable<DiGi.Scripting.Classes.VariableType>

A collection of expected output variable types.

Script(Script) Constructor

Initializes a new instance of the Script class by copying an existing script.

public Script(DiGi.Scripting.Python.Classes.Script? script);

Parameters

script Script

The source script to copy from.

Script(JsonObject) Constructor

Initializes a new instance of the Script class from a JSON object.

public Script(System.Text.Json.Nodes.JsonObject? jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON representation of the script.

Methods

Script.Execute(Data) Method

Executes the Python script using the provided input data.

public override DiGi.Scripting.Classes.Response Execute(DiGi.Scripting.Classes.Data? inputData=null);

Parameters

inputData DiGi.Scripting.Classes.Data

The data to be passed as inputs to the script. Can be null.

Returns

DiGi.Scripting.Classes.Response
A DiGi.Scripting.Classes.Response containing either the resulting output variables or an exception encountered during execution.