BioCore.Function Class Reference

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

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

Static Public Member Functions
static Function	Parse (string s)
static void	Initialize ()

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

Properties
ButtonState	State [get, set]
VirtualKeyCode	Key [get, set]
VirtualKeyCode	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 309 of file FunctionForm.cs.

Member Enumeration Documentation

ButtonState

enum BioCore.Function.ButtonState

Enumerator
Pressed
Released

Definition at line 329 of file FunctionForm.cs.

        {
            Pressed,
            Released
        }

FunctionType

enum BioCore.Function.FunctionType

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

Definition at line 313 of file FunctionForm.cs.

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

Member Function Documentation

Initialize()

static void BioCore.Function.Initialize ( )

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 532 of file FunctionForm.cs.

        {
            string st = Application.StartupPath + "/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, f);
                App.AddContextMenu(f.ContextPath, f);
            }
        }

Parse()

static Function BioCore.Function.Parse ( string s )

static

It takes a string, and if it's empty, it returns a new Function object. Otherwise, it returns a new Function object that is the deserialized version of the string

Parameters

s	The string to parse

Returns

A function object.

Definition at line 477 of file FunctionForm.cs.

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

PerformFunction()

object BioCore.Function.PerformFunction

(

bool

imagej

)

It runs a script or a keystroke

Parameters

imagej

boolean, whether to run the script as an ImageJ script or a C# script

Returns

The return value is the result of the function.

Definition at line 498 of file FunctionForm.cs.

        {
            if (FuncType == FunctionType.Key && Script != "")
                if (imagej)
                {
                    FuncType = FunctionType.ImageJ;
                }
                else
                    FuncType = FunctionType.Script;
            if (FuncType == Function.FunctionType.Script)
            {
                Scripting.RunString(script);
            }
            if (FuncType == Function.FunctionType.ImageJ)
            {
                Fiji.RunOnImage(ImageView.SelectedImage,script, false, BioConsole.onTab, BioConsole.useBioformats, BioConsole.newTab);
            }
 
            if (FuncType == Function.FunctionType.Key)
            {
                if (Modifier != VirtualKeyCode.NONAME)
                {
                    input.Keyboard.ModifiedKeyStroke(Modifier, Key);
                }
                else
                {
                    input.Keyboard.KeyPress(Key);
                }
                return null;
            }
            return null;
        }

Save()

void BioCore.Function.Save

(

)

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

Definition at line 549 of file FunctionForm.cs.

        {
            string st = Application.StartupPath;
 
            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 BioCore.Function.Serialize

(

)

"Serialize" is a function that takes an object and returns a string

Returns

The object is being serialized into a JSON string.

Definition at line 487 of file FunctionForm.cs.

        {
            return JsonConvert.SerializeObject(this);
        }

ToString()

override string BioCore.Function.ToString

(

)

Definition at line 467 of file FunctionForm.cs.

        {
            return name + ", " + MenuPath;
        }

Member Data Documentation

Functions

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

static

Definition at line 311 of file FunctionForm.cs.

input

InputSimulator BioCore.Function.input = new InputSimulator()

static

Definition at line 492 of file FunctionForm.cs.

Property Documentation

ContextPath

string BioCore.Function.ContextPath

getset

Definition at line 431 of file FunctionForm.cs.

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

File

string BioCore.Function.File

getset

Definition at line 390 of file FunctionForm.cs.

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

FuncType

FunctionType BioCore.Function.FuncType

getset

Definition at line 377 of file FunctionForm.cs.

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

Key

VirtualKeyCode BioCore.Function.Key

getset

Definition at line 349 of file FunctionForm.cs.

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

MenuPath

string BioCore.Function.MenuPath

getset

Definition at line 419 of file FunctionForm.cs.

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

Microscope

string BioCore.Function.Microscope

getset

Definition at line 456 of file FunctionForm.cs.

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

Modifier

VirtualKeyCode BioCore.Function.Modifier

getset

Definition at line 363 of file FunctionForm.cs.

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

Name

string BioCore.Function.Name

getset

Definition at line 407 of file FunctionForm.cs.

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

Script

string BioCore.Function.Script

getset

Definition at line 397 of file FunctionForm.cs.

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

State

ButtonState BioCore.Function.State

getset

Definition at line 336 of file FunctionForm.cs.

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

Value

double BioCore.Function.Value

getset

Definition at line 444 of file FunctionForm.cs.

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

---

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

• BioCore/BioCore/Source/FunctionForm.cs