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]

Detailed Description

Definition at line 395 of file Functions.cs.

Member Enumeration Documentation

ButtonState

enum BioGTK.Function.ButtonState

Definition at line 416 of file Functions.cs.

        {
            Pressed = 0,
            Released = 1,
        }

FunctionType

enum BioGTK.Function.FunctionType

Definition at line 399 of file Functions.cs.

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

Member Function Documentation

InitializeContextMenu()

static void BioGTK.Function.InitializeContextMenu ( )

static

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

Definition at line 625 of file Functions.cs.

        {
            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 ( )

static

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

Definition at line 608 of file Functions.cs.

        {
            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 )

static

It converts a string to a function.

Parameters

s	The string to parse

Returns

A function object.

Definition at line 564 of file Functions.cs.

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

PerformFunction()

object BioGTK.Function.PerformFunction

(

bool

imagej

)

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.

Definition at line 586 of file Functions.cs.

        {
            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)
            {
                Fiji.RunOnImage(ImageView.SelectedImage,script, false, BioConsole.onTab, BioConsole.useBioformats, BioConsole.resultInNewTab);
            }
            return null;
        }

Save()

void BioGTK.Function.Save

(

)

It saves the function to a file.

Definition at line 655 of file Functions.cs.

        {
            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 ( )

static

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

Definition at line 641 of file Functions.cs.

        {
            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

(

)

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

Returns

The object is being serialized into a JSON string.

Definition at line 574 of file Functions.cs.

        {
            return JsonConvert.SerializeObject(this);
        }

ToString()

override string BioGTK.Function.ToString

(

)

Definition at line 555 of file Functions.cs.

        {
            return name + ", " + MenuPath;
        }

Member Data Documentation

Functions

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

static

Definition at line 397 of file Functions.cs.

Property Documentation

ContextPath

string BioGTK.Function.ContextPath

getset

Definition at line 519 of file Functions.cs.

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

File

string BioGTK.Function.File

getset

Definition at line 478 of file Functions.cs.

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

FuncType

FunctionType BioGTK.Function.FuncType

getset

Definition at line 465 of file Functions.cs.

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

Key

Gdk.Key BioGTK.Function.Key

getset

Definition at line 437 of file Functions.cs.

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

MenuPath

string BioGTK.Function.MenuPath

getset

Definition at line 507 of file Functions.cs.

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

Microscope

string BioGTK.Function.Microscope

getset

Definition at line 544 of file Functions.cs.

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

Modifier

Gdk.ModifierType BioGTK.Function.Modifier

getset

Definition at line 451 of file Functions.cs.

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

Name

string BioGTK.Function.Name

getset

Definition at line 495 of file Functions.cs.

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

Script

string BioGTK.Function.Script

getset

Definition at line 485 of file Functions.cs.

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

State

ButtonState BioGTK.Function.State

getset

Definition at line 424 of file Functions.cs.

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

Value

double BioGTK.Function.Value

getset

Definition at line 532 of file Functions.cs.

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

---

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

• BioGTK/Source/Functions.cs