BioCore.Function Class Reference

Public Types
enum	FunctionType
enum	ButtonState

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. More...

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

Member Enumeration Documentation

ButtonState

enum BioCore.Function.ButtonState

Definition at line 327 of file FunctionForm.cs.

FunctionType

enum BioCore.Function.FunctionType

Definition at line 311 of file FunctionForm.cs.

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

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

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

Save()

void BioCore.Function.Save

(

)

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

Definition at line 547 of file FunctionForm.cs.

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

ToString()

override string BioCore.Function.ToString

(

)

Definition at line 465 of file FunctionForm.cs.

Member Data Documentation

Functions

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

static

Definition at line 309 of file FunctionForm.cs.

input

InputSimulator BioCore.Function.input = new InputSimulator()

static

Definition at line 490 of file FunctionForm.cs.

Property Documentation

ContextPath

string BioCore.Function.ContextPath

getset

Definition at line 429 of file FunctionForm.cs.

File

string BioCore.Function.File

getset

Definition at line 388 of file FunctionForm.cs.

FuncType

FunctionType BioCore.Function.FuncType

getset

Definition at line 375 of file FunctionForm.cs.

Key

VirtualKeyCode BioCore.Function.Key

getset

Definition at line 347 of file FunctionForm.cs.

MenuPath

string BioCore.Function.MenuPath

getset

Definition at line 417 of file FunctionForm.cs.

Microscope

string BioCore.Function.Microscope

getset

Definition at line 454 of file FunctionForm.cs.

Modifier

VirtualKeyCode BioCore.Function.Modifier

getset

Definition at line 361 of file FunctionForm.cs.

Name

string BioCore.Function.Name

getset

Definition at line 405 of file FunctionForm.cs.

Script

string BioCore.Function.Script

getset

Definition at line 395 of file FunctionForm.cs.

State

ButtonState BioCore.Function.State

getset

Definition at line 334 of file FunctionForm.cs.

Value

double BioCore.Function.Value

getset

Definition at line 442 of file FunctionForm.cs.

---

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

• BioCore/BioCore/Source/FunctionForm.cs