PlugInsInterfaces.IGREETController Interface Reference

An interface that defines what methods and events can be used in order to interact with the GREET software More...

Public Member Functions
string	GetDefaultFolder ()
	Get the default folder used by GREET to store data, by default the MyDocument/Greet folder More...
void	RunSimalationAsync ()
	Asks GREET to run the simulation and computes the model More...
void	RunSimalation (bool textMinMaxMonitors)
	Asks GREET to run the simulation and computes the model More...
int	getModelYear ()
	Returns the current modeling year chosen by the user More...
void	Decompress (Stream inp, Stream outp)
	Uses an input stream and decompresses it More...
void	Compress (Stream inp, Stream outp)
	Uses an input stream and compresses it using deflate More...
string	DownloadDatabaseFromServer (int revNumber=0)
	Orders the software to download a specific version of the database from the webservice More...
IProject	LoadProjectFile (string filename)
	Orders the main GUI to load a specific file as the current project More...
string	SaveProject (IProject project, string fileName)
	Saves the given project to a file More...

Properties
IProject	CurrentProject [get]
	Returns the project currently in use More...
Dictionary< string, IUnit >	UnitsAvailable [get]
	Returns a dictionary with units available in GREET More...
Dictionary< string, IUnitGroup >	UnitGroupsAvailable [get]
	Returns a dictionary with unit groups available in GREET More...

Events
EventHandler	CalculationFinished
	When the calculations are done, this event fires up to warn any plugin that we are going to have some results available now. More...

Detailed Description

An interface that defines what methods and events can be used in order to interact with the GREET software

Definition at line 17 of file IGREETController.cs.

Member Function Documentation

void PlugInsInterfaces.IGREETController.Compress	(	Stream	inp,
		Stream	outp
	)

Uses an input stream and compresses it using deflate

Parameters

inp	Not compressed stream
outp	Compressed stream

void PlugInsInterfaces.IGREETController.Decompress	(	Stream	inp,
		Stream	outp
	)

Uses an input stream and decompresses it

Parameters

inp	Compressed input stream to be compressed
outp	Decompressed stream using deflate

string PlugInsInterfaces.IGREETController.DownloadDatabaseFromServer

(

int

revNumber = 0

)

Orders the software to download a specific version of the database from the webservice

Parameters

revNumber

Returns

string PlugInsInterfaces.IGREETController.GetDefaultFolder

(

)

Get the default folder used by GREET to store data, by default the MyDocument/Greet folder

Returns

int PlugInsInterfaces.IGREETController.getModelYear

(

)

Returns the current modeling year chosen by the user

Returns

IProject PlugInsInterfaces.IGREETController.LoadProjectFile

(

string

filename

)

Orders the main GUI to load a specific file as the current project

Parameters

filename

Returns

void PlugInsInterfaces.IGREETController.RunSimalation

(

bool

textMinMaxMonitors

)

Asks GREET to run the simulation and computes the model

void PlugInsInterfaces.IGREETController.RunSimalationAsync

(

)

Asks GREET to run the simulation and computes the model

string PlugInsInterfaces.IGREETController.SaveProject	(	IProject	project,
		string	fileName
	)

Saves the given project to a file

Parameters

project	The project to save, can be the current project
fileName	Filename to be used to create the data file

Returns

Property Documentation

IProject PlugInsInterfaces.IGREETController.CurrentProject

get

Returns the project currently in use

Definition at line 97 of file IGREETController.cs.

Dictionary<string, IUnitGroup> PlugInsInterfaces.IGREETController.UnitGroupsAvailable

get

Returns a dictionary with unit groups available in GREET

Definition at line 109 of file IGREETController.cs.

Dictionary<string, IUnit> PlugInsInterfaces.IGREETController.UnitsAvailable

get

Returns a dictionary with units available in GREET

Definition at line 103 of file IGREETController.cs.

Event Documentation

EventHandler PlugInsInterfaces.IGREETController.CalculationFinished

When the calculations are done, this event fires up to warn any plugin that we are going to have some results available now.

Definition at line 43 of file IGREETController.cs.

---

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

• C:/Users/ddieffenthaler/Desktop/SVN/source/greet-dev/main/PlugInsInterfaces/IGREETController.cs