BioGTK.Function Class Reference

Public Types
enum	FunctionType {   Key , Microscope , Objective , StoreCoordinate ,   NextCoordinate , PreviousCoordinate , NextSnapCoordinate , PreviousSnapCoordinate ,   Recording , Property , ImageJ , Script ,   None }
enum	ButtonState { Pressed = 0 , Released = 1 }

Public Member Functions
override string	ToString ()
string	Serialize ()
object	PerformFunction (bool imagej)
void	Save ()
	It saves the function to a file.

Static Public Member Functions
static Function	Parse (string s)
static void	InitializeMainMenu ()
static void	InitializeContextMenu ()
static void	SaveAll ()
	It saves all the functions in the Functions dictionary to a file.

Static Public Attributes
static Dictionary< string, Function >	Functions = new Dictionary<string, Function>()

Properties
ButtonState	State [get, set]
Gdk.Key	Key [get, set]
Gdk.ModifierType	Modifier [get, set]
FunctionType	FuncType [get, set]
string	File [get, set]
string	Script [get, set]
string	Name [get, set]
string	MenuPath [get, set]
string	ContextPath [get, set]
double	Value [get, set]
string	Microscope [get, set]

Member Enumeration Documentation

ButtonState

enum BioGTK.Function.ButtonState

Enumerator
Pressed
Released

        {
            Pressed = 0,
            Released = 1,
        }

FunctionType

enum BioGTK.Function.FunctionType

Enumerator
Key
Microscope
Objective
StoreCoordinate
NextCoordinate
PreviousCoordinate
NextSnapCoordinate
PreviousSnapCoordinate
Recording
Property
ImageJ
Script
None

        {
            Key,
            Microscope,
            Objective,
            StoreCoordinate,
            NextCoordinate,
            PreviousCoordinate,
            NextSnapCoordinate,
            PreviousSnapCoordinate,
            Recording,
            Property,
            ImageJ,
            Script,
            None
        }

Member Function Documentation

InitializeContextMenu()

static void BioGTK.Function.InitializeContextMenu ( )

inlinestatic

It reads all the files in the Functions folder, parses them into Function objects, and adds them to the Functions dictionary

        {
            string st = System.IO.Path.GetDirectoryName(Environment.ProcessPath) + "/Functions";
            if (!Directory.Exists(st))
                Directory.CreateDirectory(st);
            string[] sts = Directory.GetFiles(st);
            for (int i = 0; i < sts.Length; i++)
            {
                string fs = System.IO.File.ReadAllText(sts[i]);
                Function f = Function.Parse(fs);
                if (!Functions.ContainsKey(f.Name))
                    Functions.Add(f.Name, f);
                App.AddContextMenu(f.ContextPath);
            }
        }

InitializeMainMenu()

static void BioGTK.Function.InitializeMainMenu ( )

inlinestatic

It reads all the files in the Functions folder, parses them into Function objects, and adds them to the Functions dictionary

        {
            string st = System.IO.Path.GetDirectoryName(Environment.ProcessPath) + "/Functions";
            if (!Directory.Exists(st))
                Directory.CreateDirectory(st);
            string[] sts = Directory.GetFiles(st);
            for (int i = 0; i < sts.Length; i++)
            {
                string fs = System.IO.File.ReadAllText(sts[i]);
                Function f = Function.Parse(fs);
                if (!Functions.ContainsKey(f.Name))
                    Functions.Add(f.Name, f);
                App.AddMenu(f.MenuPath);
            }
        }

Parse()

static Function BioGTK.Function.Parse ( string  s )

inlinestatic

It converts a string to a function.

Parameters

s	The string to parse

Returns

A function object.

        {
            if (s == "")
                return new Function();
            return JsonConvert.DeserializeObject<Function>(s);
        }

PerformFunction()

object BioGTK.Function.PerformFunction ( bool  imagej )

inline

If the function type is a key, and the script is not empty, then if the imagej flag is true, set the function type to imagej, otherwise set the function type to script. If the function type is a script, run the script. If the function type is imagej, run the script on the image

Parameters

imagej

boolean, whether to run the function as an ImageJ macro or not

Returns

The return value is the result of the function.

        {
            if (FuncType == FunctionType.Key && Script != "")
                if (imagej)
                {
                    FuncType = FunctionType.ImageJ;
                }
                else
                    FuncType = FunctionType.Script;
            if (FuncType == Function.FunctionType.Script)
            {
                return Scripting.RunString(script);
            }
            if (FuncType == Function.FunctionType.ImageJ)
            {
                ImageJ.RunOnImage(script, false, BioConsole.onTab, BioConsole.useBioformats, BioConsole.resultInNewTab);
            }
            return null;
        }

Save()

void BioGTK.Function.Save ( )

inline

It saves the function to a file.

        {
            string st = System.IO.Path.GetDirectoryName(Environment.ProcessPath);
            if (!Directory.Exists(st + "/Functions"))
            {
                Directory.CreateDirectory(st + "/Functions");
            }
            System.IO.File.WriteAllText(st + "/Functions/" + Name + ".func", Serialize());
        }

SaveAll()

static void BioGTK.Function.SaveAll ( )

inlinestatic

It saves all the functions in the Functions dictionary to a file.

        {
            string st = System.IO.Path.GetDirectoryName(Environment.ProcessPath);
 
            if (!Directory.Exists(st + "/Functions"))
            {
                Directory.CreateDirectory(st + "/Functions");
            }
            foreach (Function f in Functions.Values)
            {
                System.IO.File.WriteAllText(st + "/Functions/" + f.Name + ".func", f.Serialize());
            }
        }

Serialize()

string BioGTK.Function.Serialize ( )

inline

It takes the current object and converts it to a JSON string.

Returns

The object is being serialized into a JSON string.

        {
            return JsonConvert.SerializeObject(this);
        }

ToString()

override string BioGTK.Function.ToString ( )

inline

        {
            return name + ", " + MenuPath;
        }

Member Data Documentation

Functions

Dictionary<string, Function> BioGTK.Function.Functions = new Dictionary<string, Function>()

static

Property Documentation

ContextPath

string BioGTK.Function.ContextPath

getset

        {
            get
            {
                return contextPath;
            }
            set
            {
                contextPath = value;
            }
        }

File

string BioGTK.Function.File

getset

        {
            get { return file; }
            set { file = value; }
        }

FuncType

FunctionType BioGTK.Function.FuncType

getset

        {
            get
            {
                return functionType;
            }
            set
            {
                functionType = value;
            }
        }

Key

Gdk.Key BioGTK.Function.Key

getset

        {
            get
            {
                return key;
            }
            set
            {
                key = value;
                FuncType = FunctionType.Key;
            }
        }

MenuPath

string BioGTK.Function.MenuPath

getset

        {
            get
            {
                return menuPath;
            }
            set
            {
                menuPath = value;
            }
        }

Microscope

string BioGTK.Function.Microscope

getset

        {
            get
            {
                return microscope;
            }
            set
            {
                microscope = value;
            }
        }

Modifier

Gdk.ModifierType BioGTK.Function.Modifier

getset

        {
            get
            {
                return modifier;
            }
            set
            {
                FuncType = FunctionType.Key;
                modifier = value;
            }
        }

Name

string BioGTK.Function.Name

getset

        {
            get
            {
                return name;
            }
            set
            {
                name = value;
            }
        }

Script

string BioGTK.Function.Script

getset

        {
            get { return script; }
            set
            {
                script = value;
            }
        }

State

ButtonState BioGTK.Function.State

getset

        {
            get
            {
                return buttonState;
            }
            set
            {
                buttonState = value;
            }
        }

Value

double BioGTK.Function.Value

getset

        {
            get
            {
                return val;
            }
            set
            {
                val = value;
            }
        }

---

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

• D:/Kari/repos/BioGTK/Source/Functions.cs