A Routine is an abstract representation of a method. More...

Public Member Functions
	Routine (Type result, string name, List< Type > parameters)
	Routine (Type result, string name, List< Type > parameterTypes, string description)
	Routine (string name)
	Routine (string name, string description)
	Routine (Type result, string name)
	Routine (Type result, string name, string description)
	Routine (Type result, string name, Type parameter)
	Routine (Type result, string name, Type parameter, string description)
	Routine (Type result, string name, Type parameter0, Type parameter1)
	Routine (Type result, string name, Type parameter0, Type parameter1, string description)
	Routine (Type result, string name, Type parameter0, Type parameter1, Type parameter2)
	Routine (Type result, string name, Type parameter0, Type parameter1, Type parameter2, string description)
void	Verify (List< object > parameters)
	Verify the parameter types of a Routine. If null or void was specified values arent verified.
void	Verify (object result)
	Verify the result of a Routine. If null or void was specified values arent verified.
override string	ToString ()
string	Description ()

Properties
string	Name `[get]`
List< Type >	ParameterTypes `[get]`
Type	Result `[get]`
Host	Handler `[get, set]`

Detailed Description

A Routine is an abstract representation of a method.

To successfully write a routine you have to use one of its several overloaded cunstuctors listed above and pass up to a maximum of 3 parameters.

Routine myRoutine;
 
myRoutine = new Routine( 
    typeof(int), // return value (optional)
    "myFunction", // name of the function (required)
    typeof(int), typeof(float), typeof(bool), // up to 3 parameters (optional)
    "Describe your custom method" // a description (optional)
);

To declare more then 3 parameters you can add them to a list and add the list as parameter

// create a generic list ..
List<Type> customParameter = new List<Type>();
 
// .. add all parameter types
customParameter.Add(typeof(int));
customParameter.Add(typeof(float));
customParameter.Add(typeof(bool));
customParameter.Add(typeof(int));
 
// .. and add them as a parameter
Routine myRoutine = new Routine( 
    typeof(int), 
    "myFunction", 
    typeof(customParameter), // the list as parameter
    "Describe your function" 
);

The Manager can invoke a Routine by using the Invoke method.

Routine myRoutine = manager.Routines["print"];
 
List<object> parameters = new List<object>();
parameters.Add("Hello world");
 
myRoutine.Handler.Invoke(myRoutine.Name, parameters);

See also: Manager, Host

Todo: The Constructor has serveral (way too much) Overloaders

Definition at line 69 of file Routine.cs.

Constructor & Destructor Documentation

◆ Routine() [1/12]

ScriptStack.Runtime.Routine.Routine	(	Type	result,
		string	name,
		List< Type >	parameters )

Definition at line 136 of file Routine.cs.

                                                                        {
 
            Validate(result);
 
            foreach (Type parameter in parameters)
                Validate(parameter);
 
            this.result = result;
            this.name = name;
            this.parameters = parameters;
 
            host = null;
 
        }

◆ Routine() [2/12]

ScriptStack.Runtime.Routine.Routine	(	Type	result,
		string	name,
		List< Type >	parameterTypes,
		string	description )

Definition at line 151 of file Routine.cs.

        {
 
            Validate(result);
 
            foreach (Type parameter in parameterTypes)
                Validate(parameter);
 
            this.result = result;
            this.name = name;
            this.parameters = parameterTypes;
            this.description = description;
            host = null;
 
        }

◆ Routine() [3/12]

ScriptStack.Runtime.Routine.Routine ( string name )

Definition at line 167 of file Routine.cs.

                                    : this(null, name, new List<Type>())
        {
        }

◆ Routine() [4/12]

ScriptStack.Runtime.Routine.Routine	(	string	name,
		string	description )

Definition at line 171 of file Routine.cs.

                                                        : this(null, name, new List<Type>(), description)
        {
        }

◆ Routine() [5/12]

ScriptStack.Runtime.Routine.Routine	(	Type	result,
		string	name )

Definition at line 175 of file Routine.cs.

                                                 : this(result, name, new List<Type>())
        {
        }

◆ Routine() [6/12]

ScriptStack.Runtime.Routine.Routine	(	Type	result,
		string	name,
		string	description )

Definition at line 179 of file Routine.cs.

                                                                     : this(result, name, new List<Type>(), description)
        {
        }

◆ Routine() [7/12]

ScriptStack.Runtime.Routine.Routine	(	Type	result,
		string	name,
		Type	parameter )

Definition at line 183 of file Routine.cs.

                                                                 : this(result, name, new List<Type>())
        {
            parameters.Add(parameter);
        }

◆ Routine() [8/12]

ScriptStack.Runtime.Routine.Routine	(	Type	result,
		string	name,
		Type	parameter,
		string	description )

Definition at line 188 of file Routine.cs.

                                                                                     : this(result, name, new List<Type>(), description)
        {
            parameters.Add(parameter);
        }

◆ Routine() [9/12]

ScriptStack.Runtime.Routine.Routine	(	Type	result,
		string	name,
		Type	parameter0,
		Type	parameter1 )

Definition at line 193 of file Routine.cs.

                                                                                   : this(result, name, new List<Type>())
        {
            parameters.Add(parameter0);
            parameters.Add(parameter1);
        }

◆ Routine() [10/12]

ScriptStack.Runtime.Routine.Routine	(	Type	result,
		string	name,
		Type	parameter0,
		Type	parameter1,
		string	description )

Definition at line 199 of file Routine.cs.

                                                                                                       : this(result, name, new List<Type>(), description)
        {
            parameters.Add(parameter0);
            parameters.Add(parameter1);
        }

◆ Routine() [11/12]

ScriptStack.Runtime.Routine.Routine	(	Type	result,
		string	name,
		Type	parameter0,
		Type	parameter1,
		Type	parameter2 )

Definition at line 205 of file Routine.cs.

                                                                                                    : this(result, name, new List<Type>())
        {
            parameters.Add(parameter0);
            parameters.Add(parameter1);
            parameters.Add(parameter2);
        }

◆ Routine() [12/12]

ScriptStack.Runtime.Routine.Routine	(	Type	result,
		string	name,
		Type	parameter0,
		Type	parameter1,
		Type	parameter2,
		string	description )

Definition at line 212 of file Routine.cs.

                                                                                                                        : this(result, name, new List<Type>(), description)
        {
            parameters.Add(parameter0);
            parameters.Add(parameter1);
            parameters.Add(parameter2);
        }

Member Function Documentation

◆ Description()

string ScriptStack.Runtime.Routine.Description ( )

Definition at line 297 of file Routine.cs.

        {
            return description;
        }

◆ ToString()

override string ScriptStack.Runtime.Routine.ToString ( )

Definition at line 267 of file Routine.cs.

        {
 
            StringBuilder sb = new StringBuilder();
 
            //if(result != (Type)null)
                sb.Append(ToString(result) + " ");
 
            sb.Append(name);
 
            sb.Append("(");
 
            int i = 0;
 
            for (i = 0; i < parameters.Count; i++)
            {
 
                if (i > 0)
                    sb.Append(", ");
 
                sb.Append(ToString(parameters[i]));
 
            }
 
            sb.Append(")");
 
            return sb.ToString();
 
        }

References ToString().

Referenced by ToString().

◆ Verify() [1/2]

void ScriptStack.Runtime.Routine.Verify ( List< object > parameters )

Verify the parameter types of a Routine. If null or void was specified values arent verified.

Parameters

parameters

Definition at line 223 of file Routine.cs.

        {
 
            if (parameters.Count != this.parameters.Count)
                throw new ExecutionException("Die Routine '" + name + "' wurde mit " + parameters.Count  + " statt erwarteten " + this.parameters.Count  + " Parametern aufgerufen.");
 
            for (int i = 0; i < parameters.Count; i++)
            {
 
                if (null == this.parameters[i] || null == parameters[i])
                    continue;
 
                if (typeof(void) == this.parameters[i] || typeof(void) == parameters[i])
                    continue;
 
                Type expected = this.parameters[i];
 
                Type specified = parameters[i].GetType();
 
                if (expected != specified)
                    throw new ExecutionException("Typ '" + specified.Name + "' statt erwartetem Typ '" + expected.Name + "' als " + (i + 1) + " Parameter von '" + name +"' angegeben.");
 
            }
 
        }

◆ Verify() [2/2]

void ScriptStack.Runtime.Routine.Verify ( object result )

Verify the result of a Routine. If null or void was specified values arent verified.

Parameters

result

Definition at line 253 of file Routine.cs.

        {
 
            if (null == this.result || null == result)
                return;
 
            if (typeof(void) == this.result || typeof(void) == result)
                return;
 
            if (result.GetType() != this.result)
                throw new ExecutionException("Typ '" + result.GetType().Name + "' statt erwartetem Typ '"  + this.result.Name + "' als Ergebnis von '" + name + "' erhalten.");
 
        }

Property Documentation

◆ Handler

Host ScriptStack.Runtime.Routine.Handler

getset

Definition at line 321 of file Routine.cs.

        {
            get { return host; }
            internal set { host = value; }
        }

◆ Name

string ScriptStack.Runtime.Routine.Name

get

Definition at line 306 of file Routine.cs.

        {
            get { return name; }
        }

Referenced by ScriptStack.Manager.Register(), and ScriptStack.Manager.UnRegister().

◆ ParameterTypes

List<Type> ScriptStack.Runtime.Routine.ParameterTypes

get

Definition at line 311 of file Routine.cs.

        {
            get { return parameters; }
        }

◆ Result

Type ScriptStack.Runtime.Routine.Result

get

Definition at line 316 of file Routine.cs.

        {
            get { return result; }
        }

The documentation for this class was generated from the following file:

Runtime/Routine.cs

Public Member Functions

Properties