frame.ModelFrame Class Reference

Inheritance diagram for frame.ModelFrame:

Collaboration diagram for frame.ModelFrame:

Public Member Functions
def	__init__
	Graphical modeler main window. More...
def	GetCanvas
	Get canvas. More...
def	GetModel
	Get model. More...
def	ModelChanged
	Update window title. More...
def	OnPageChanged
	Page in notebook changed. More...
def	OnVariables
	Switch to variables page. More...
def	OnRemoveItem
	Remove shape. More...
def	OnCanvasRefresh
	Refresh canvas. More...
def	OnCmdRun
	Run command. More...
def	OnCmdPrepare
	Prepare for running command. More...
def	OnCmdDone
	Command done (or aborted) More...
def	OnCloseWindow
	Close window. More...
def	OnSize
	Window resized, save to the model. More...
def	OnPreferences
	Open preferences dialog. More...
def	OnHelp
	Show help. More...
def	OnModelProperties
	Model properties dialog. More...
def	OnDeleteData
	Delete intermediate data. More...
def	OnModelNew
	Create new model. More...
def	OnModelOpen
	Load model from file. More...
def	OnModelSave
	Save model to file. More...
def	OnModelSaveAs
	Create model to file as. More...
def	OnModelClose
	Close model file. More...
def	OnRunModel
	Run entire model. More...
def	OnDone
	Computation finished. More...
def	OnValidateModel
	Validate entire model. More...
def	OnExportImage
	Export model to image (default image) More...
def	OnExportPython
	Export model to Python script. More...
def	OnDefineRelation
	Define relation between data and action items. More...
def	OnDefineLoop
	Define new loop in the model. More...
def	OnDefineCondition
	Define new condition in the model. More...
def	OnAddAction
	Add action to model. More...
def	OnAddData
	Add data item to model. More...
def	OnHelp
	Display manual page. More...
def	OnAbout
	Display About window. More...
def	GetOptData
	Process action data. More...
def	AddLine
	Add connection between model objects. More...
def	LoadModelFile
	Load model definition stored in GRASS Model XML file (gxm) More...
def	WriteModelFile
	Save model to model file, recover original file on error. More...
def	DefineLoop
	Define loop with given list of items. More...
def	DefineCondition
	Define if-else statement with given list of items. More...

Data Fields
	parent
	searchDialog
	baseTitle
	modelFile
	modelChanged
	randomness
	cursors
	menubar
	toolbar
	statusbar
	notebook
	canvas
	model
	variablePanel
	itemPanel
	pythonPanel
	goutput
	defineRelation

Detailed Description

Definition at line 59 of file gmodeler/frame.py.

Constructor & Destructor Documentation

def frame.ModelFrame.__init__	(		self,
			parent,
			id = wx.ID_ANY,
			title = _("GRASS GIS Graphical Modeler (experimental prototype)"),
			kwargs
	)

Graphical modeler main window.

Parameters

parent	parent window
id	window id
title	window title
kwargs	wx.Frames' arguments

Definition at line 61 of file gmodeler/frame.py.

Member Function Documentation

def frame.ModelFrame.AddLine	(		self,
			rel
	)

Add connection between model objects.

Parameters

rel

relation

Definition at line 781 of file gmodeler/frame.py.

References frame.ModelFrame._addEvent().

Referenced by frame.ModelFrame.DefineCondition(), frame.ModelFrame.DefineLoop(), frame.ModelFrame.GetOptData(), and frame.ModelFrame.LoadModelFile().

def frame.ModelFrame.DefineCondition	(		self,
			condition
	)

Define if-else statement with given list of items.

Definition at line 947 of file gmodeler/frame.py.

References frame.ModelFrame.AddLine().

Referenced by frame.ModelFrame.LoadModelFile().

def frame.ModelFrame.DefineLoop	(		self,
			loop
	)

Define loop with given list of items.

Definition at line 903 of file gmodeler/frame.py.

References frame.ModelFrame.AddLine().

Referenced by frame.ModelFrame.LoadModelFile().

def frame.ModelFrame.GetCanvas

(

self

)

Get canvas.

Definition at line 158 of file gmodeler/frame.py.

References frame.ModelFrame.canvas.

Referenced by frame.ModelFrame.OnCanvasRefresh(), and frame.ModelFrame.OnRemoveItem().

def frame.ModelFrame.GetModel

(

self

)

Get model.

Definition at line 162 of file gmodeler/frame.py.

References frame.ModelFrame.model.

Referenced by frame.ModelFrame.OnCmdDone(), and frame.ModelFrame.OnCmdRun().

def frame.ModelFrame.GetOptData	(		self,
			dcmd,
			layer,
			params,
			propwin
	)

Process action data.

Definition at line 722 of file gmodeler/frame.py.

References frame.ModelFrame._addEvent(), frame.ModelFrame._randomShift(), and frame.ModelFrame.AddLine().

Referenced by frame.ModelFrame.OnAddAction(), histogram.HistogramFrame.OnOptions(), dialogs.DecorationDialog.OnOptions(), and layertree.LayerTree.PropertiesDialog().

def frame.ModelFrame.LoadModelFile	(		self,
			filename
	)

Load model definition stored in GRASS Model XML file (gxm)

Definition at line 808 of file gmodeler/frame.py.

References frame.ModelFrame._addEvent(), frame.ModelFrame.AddLine(), frame.ModelFrame.baseTitle, frame.ModelFrame.DefineCondition(), frame.ModelFrame.DefineLoop(), and frame.ModelFrame.modelFile.

Referenced by frame.ModelFrame.OnModelOpen().

def frame.ModelFrame.ModelChanged	(		self,
			changed = True
	)

Update window title.

Definition at line 166 of file gmodeler/frame.py.

References frame.ModelFrame.baseTitle, frame.ModelFrame.modelChanged, and frame.ModelFrame.modelFile.

Referenced by frame.ModelFrame.OnAddAction(), frame.ModelFrame.OnAddData(), frame.ModelFrame.OnDefineCondition(), frame.ModelFrame.OnDefineLoop(), frame.ModelFrame.OnModelProperties(), frame.ModelFrame.OnSize(), and frame.ModelFrame.WriteModelFile().

def frame.ModelFrame.OnAbout	(		self,
			event
	)

Display About window.

Definition at line 708 of file gmodeler/frame.py.

def frame.ModelFrame.OnAddAction	(		self,
			event
	)

Add action to model.

Definition at line 623 of file gmodeler/frame.py.

References frame.ModelFrame._addEvent(), frame.ModelFrame._randomShift(), frame.ModelFrame.GetOptData(), frame.ModelFrame.model, frame.ModelFrame.ModelChanged(), and frame.ModelFrame.searchDialog.

def frame.ModelFrame.OnAddData	(		self,
			event
	)

Add data item to model.

Definition at line 675 of file gmodeler/frame.py.

References frame.ModelFrame._addEvent(), frame.ModelFrame._randomShift(), and frame.ModelFrame.ModelChanged().

def frame.ModelFrame.OnCanvasRefresh	(		self,
			event
	)

Refresh canvas.

Definition at line 201 of file gmodeler/frame.py.

References frame.ModelFrame.GetCanvas().

def frame.ModelFrame.OnCloseWindow	(		self,
			event
	)

Close window.

Definition at line 233 of file gmodeler/frame.py.

References frame.ModelFrame.modelChanged, frame.ModelFrame.modelFile, frame.GMFrame.OnWorkspaceSaveAs(), and frame.ModelFrame.WriteModelFile().

Referenced by ghelp.AboutWindow.__init__().

def frame.ModelFrame.OnCmdDone	(		self,
			event
	)

Command done (or aborted)

Definition at line 224 of file gmodeler/frame.py.

References frame.ModelFrame.GetModel().

def frame.ModelFrame.OnCmdPrepare	(		self,
			event
	)

Prepare for running command.

Definition at line 216 of file gmodeler/frame.py.

def frame.ModelFrame.OnCmdRun	(		self,
			event
	)

Run command.

Definition at line 207 of file gmodeler/frame.py.

References frame.ModelFrame.GetModel().

def frame.ModelFrame.OnDefineCondition	(		self,
			event
	)

Define new condition in the model.

Definition at line 608 of file gmodeler/frame.py.

References frame.ModelFrame._addEvent(), and frame.ModelFrame.ModelChanged().

def frame.ModelFrame.OnDefineLoop	(		self,
			event
	)

Define new loop in the model.

Definition at line 593 of file gmodeler/frame.py.

References frame.ModelFrame._addEvent(), and frame.ModelFrame.ModelChanged().

def frame.ModelFrame.OnDefineRelation	(		self,
			event
	)

Define relation between data and action items.

Definition at line 587 of file gmodeler/frame.py.

References frame.ModelFrame.cursors.

def frame.ModelFrame.OnDeleteData	(		self,
			event
	)

Delete intermediate data.

Definition at line 301 of file gmodeler/frame.py.

def frame.ModelFrame.OnDone	(		self,
			cmd,
			returncode
	)

Computation finished.

Definition at line 483 of file gmodeler/frame.py.

References frame.ModelFrame.model.

Referenced by vclean.VectorCleaningFrame.OnCleaningRun(), extensions.InstallExtensionWindow.OnInstall(), mcalc_builder.MapCalcFrame.OnMCalcRun(), forms.TaskFrame.OnRun(), frame.PythonPanel.OnRun(), and frame.ModelFrame.OnRunModel().

def frame.ModelFrame.OnExportImage	(		self,
			event
	)

Export model to image (default image)

Definition at line 519 of file gmodeler/frame.py.

References dialogs.GetImageHandlers().

def frame.ModelFrame.OnExportPython	(		self,
			event = None,
			text = None
	)

Export model to Python script.

Definition at line 582 of file gmodeler/frame.py.

def frame.ModelFrame.OnHelp	(		self,
			event
	)

Show help.

Definition at line 275 of file gmodeler/frame.py.

References sqlbuilder.SQLFrame.parent, dialogs.ModelDataDialog.parent, dialogs.DisplayAttributesDialog.parent, manager.Log.parent, frame.ModelFrame.parent, manager.VirtualAttributeList.parent, manager.GCPWizard.parent, dialogs.ModelSearchDialog.parent, dialogs.ModelRelationDialog.parent, manager.LocationPage.parent, dialogs.ModelItemDialog.parent, manager.GroupPage.parent, manager.AttributeManager.parent, dialogs.ModelListCtrl.parent, manager.DispMapPage.parent, manager.GCP.parent, dialogs.ItemCheckListCtrl.parent, manager.TableListCtrl.parent, manager.LayerListCtrl.parent, manager.GrSettingsDialog.parent, manager.LayerBook.parent, and gcmd.RunCommand().

Referenced by frame.ModelFrame.OnHelp(), and forms.TaskFrame.OnKeyUp().

def frame.ModelFrame.OnHelp	(		self,
			event
	)

Display manual page.

Definition at line 703 of file gmodeler/frame.py.

References frame.ModelFrame.OnHelp().

Referenced by forms.TaskFrame.OnKeyUp().

def frame.ModelFrame.OnModelClose	(		self,
			event = None
	)

Close model file.

Definition at line 448 of file gmodeler/frame.py.

References frame.ModelFrame.baseTitle, frame.ModelFrame.modelChanged, frame.ModelFrame.modelFile, frame.ModelFrame.OnModelSave(), and frame.ModelFrame.OnModelSaveAs().

Referenced by frame.ModelFrame.OnModelOpen().

def frame.ModelFrame.OnModelNew	(		self,
			event
	)

Create new model.

Definition at line 332 of file gmodeler/frame.py.

References frame.ModelFrame.baseTitle, frame.ModelFrame.modelChanged, frame.ModelFrame.modelFile, frame.ModelFrame.OnModelSave(), and frame.ModelFrame.OnModelSaveAs().

def frame.ModelFrame.OnModelOpen	(		self,
			event
	)

Load model from file.

Definition at line 368 of file gmodeler/frame.py.

References frame.ModelFrame.baseTitle, frame.ModelFrame.LoadModelFile(), frame.ModelFrame.modelFile, and frame.ModelFrame.OnModelClose().

def frame.ModelFrame.OnModelProperties	(		self,
			event
	)

Model properties dialog.

Definition at line 286 of file gmodeler/frame.py.

References frame.ModelFrame.ModelChanged().

def frame.ModelFrame.OnModelSave	(		self,
			event = None
	)

Save model to file.

Definition at line 393 of file gmodeler/frame.py.

References frame.ModelFrame.baseTitle, frame.ModelFrame.modelChanged, frame.ModelFrame.modelFile, frame.ModelFrame.OnModelSaveAs(), and frame.ModelFrame.WriteModelFile().

Referenced by frame.ModelFrame.OnModelClose(), and frame.ModelFrame.OnModelNew().

def frame.ModelFrame.OnModelSaveAs	(		self,
			event
	)

Create model to file as.

Definition at line 411 of file gmodeler/frame.py.

References frame.ModelFrame.baseTitle, frame.ModelFrame.modelFile, and frame.ModelFrame.WriteModelFile().

Referenced by frame.ModelFrame.OnModelClose(), frame.ModelFrame.OnModelNew(), and frame.ModelFrame.OnModelSave().

def frame.ModelFrame.OnPageChanged	(		self,
			event
	)

Page in notebook changed.

Definition at line 178 of file gmodeler/frame.py.

def frame.ModelFrame.OnPreferences	(		self,
			event
	)

Open preferences dialog.

Definition at line 267 of file gmodeler/frame.py.

def frame.ModelFrame.OnRemoveItem	(		self,
			event
	)

Remove shape.

Definition at line 196 of file gmodeler/frame.py.

References frame.ModelFrame.GetCanvas().

def frame.ModelFrame.OnRunModel	(		self,
			event
	)

Run entire model.

Definition at line 479 of file gmodeler/frame.py.

References frame.ModelFrame.goutput, and frame.ModelFrame.OnDone().

def frame.ModelFrame.OnSize	(		self,
			event
	)

Window resized, save to the model.

Definition at line 262 of file gmodeler/frame.py.

References frame.ModelFrame.ModelChanged().

def frame.ModelFrame.OnValidateModel	(		self,
			event,
			showMsg = True
	)

Validate entire model.

Definition at line 500 of file gmodeler/frame.py.

def frame.ModelFrame.OnVariables	(		self,
			event
	)

Switch to variables page.

Definition at line 192 of file gmodeler/frame.py.

def frame.ModelFrame.WriteModelFile	(		self,
			filename
	)

Save model to model file, recover original file on error.

Returns

True on success

False on failure

Definition at line 872 of file gmodeler/frame.py.

References frame.ModelFrame.model, and frame.ModelFrame.ModelChanged().

Referenced by frame.ModelFrame.OnCloseWindow(), frame.ModelFrame.OnModelSave(), and frame.ModelFrame.OnModelSaveAs().

Field Documentation

frame.ModelFrame.baseTitle

Definition at line 72 of file gmodeler/frame.py.

Referenced by frame.ModelFrame.LoadModelFile(), frame.ModelFrame.ModelChanged(), frame.ModelFrame.OnModelClose(), frame.ModelFrame.OnModelNew(), frame.ModelFrame.OnModelOpen(), frame.ModelFrame.OnModelSave(), frame.ModelFrame.OnModelSaveAs(), frame.GMFrame.OnWorkspaceClose(), frame.GMFrame.OnWorkspaceNew(), frame.GMFrame.OnWorkspaceOpen(), frame.GMFrame.OnWorkspaceSave(), frame.GMFrame.OnWorkspaceSaveAs(), and frame.GMFrame.WorkspaceChanged().

frame.ModelFrame.canvas

Definition at line 99 of file gmodeler/frame.py.

Referenced by gprint.MapPrint.__init__(), model.Model.GetCanvas(), frame.ModelFrame.GetCanvas(), and model.Model.LoadModel().

frame.ModelFrame.cursors

Definition at line 77 of file gmodeler/frame.py.

Referenced by frame.MapFrame.AddNviz(), frame.ModelFrame.OnDefineRelation(), frame.MapFrame.OnFlyThrough(), mapwindow.GLWindow.OnLeftDown(), mapwindow.GLWindow.OnLeftUp(), frame.PsMapBufferedWindow.OnMouseMoving(), mapdisp.MapFrameBase.OnPan(), mapdisplay.MapFrame.OnPan(), frame.PsMapFrame.OnPan(), mapdisplay.MapFrame.OnPointer(), frame.PsMapFrame.OnPointer(), frame.MapFrame.OnPointer(), frame.MapFrame.OnQuery(), frame.MapFrame.OnRotate(), mapdisplay.MapFrame.OnZoomIn(), frame.PsMapFrame.OnZoomIn(), mapdisp.MapFrameBase.OnZoomOut(), mapdisplay.MapFrame.OnZoomOut(), and frame.PsMapFrame.OnZoomOut().

frame.ModelFrame.defineRelation

Definition at line 590 of file gmodeler/frame.py.

frame.ModelFrame.goutput

Definition at line 111 of file gmodeler/frame.py.

Referenced by frame.GMFrame.GetLogWindow(), forms.TaskFrame.OnAbort(), frame.GMFrame.OnDone(), frame.GMFrame.OnNewVector(), frame.ModelFrame.OnRunModel(), and frame.GMFrame.OnShowAttributeTable().

frame.ModelFrame.itemPanel

Definition at line 107 of file gmodeler/frame.py.

frame.ModelFrame.menubar

Definition at line 86 of file gmodeler/frame.py.

frame.ModelFrame.model

Definition at line 103 of file gmodeler/frame.py.

Referenced by frame.ModelFrame.GetModel(), frame.ModelFrame.OnAddAction(), frame.GMFrame.OnDone(), frame.ModelFrame.OnDone(), and frame.ModelFrame.WriteModelFile().

frame.ModelFrame.modelChanged

Definition at line 74 of file gmodeler/frame.py.

Referenced by frame.ModelFrame.ModelChanged(), frame.ModelFrame.OnCloseWindow(), frame.ModelFrame.OnModelClose(), frame.ModelFrame.OnModelNew(), and frame.ModelFrame.OnModelSave().

frame.ModelFrame.modelFile

Definition at line 73 of file gmodeler/frame.py.

Referenced by frame.ModelFrame.LoadModelFile(), frame.ModelFrame.ModelChanged(), frame.ModelFrame.OnCloseWindow(), frame.ModelFrame.OnModelClose(), frame.ModelFrame.OnModelNew(), frame.ModelFrame.OnModelOpen(), frame.ModelFrame.OnModelSave(), and frame.ModelFrame.OnModelSaveAs().

frame.ModelFrame.notebook

Definition at line 95 of file gmodeler/frame.py.

Referenced by preferences.PreferencesDialog.__init__(), and frame.GMFrame.IsPaneShown().

frame.ModelFrame.parent

Definition at line 70 of file gmodeler/frame.py.

Referenced by model.ModelLoop.__init__(), wxdigit.VDigitError.Database(), wxdigit.VDigitError.DbExecute(), wxdigit.VDigitError.DbLink(), wxdigit.VDigitError.DeadLine(), wxdigit.VDigitError.Driver(), wxdigit.VDigitError.FeatureType(), colorrules.RulesPanel.LoadRules(), wxdigit.VDigitError.NoMap(), forms.TaskFrame.OnCancel(), forms.TaskFrame.OnDone(), frame.ModelFrame.OnHelp(), mapwindow.GLWindow.OnLeftUp(), mapwindow.BufferedWindow.OnLeftUp(), frame.PsMapBufferedWindow.OnLeftUp(), dialogs.DecorationDialog.OnOptions(), goutput.GMConsole.OnOutputSave(), forms.TaskFrame.OnRun(), toolbars.VDigitToolbar.OnSelectMap(), gselect.GdalSelect.OnSetDsn(), toolbars.LMNvizToolbar.OnSettings(), toolbars.VDigitToolbar.OnSettings(), toolbars.BaseToolbar.OnTool(), forms.CmdPanel.OnUpdateSelection(), toolbars.VDigitToolbar.OnZBulk(), wxdigit.VDigitError.ReadLine(), goutput.CmdThread.run(), forms.UpdateQThread.run(), goutput.GMConsole.RunCmd(), toolbars.VDigitToolbar.StopEditing(), colorrules.VectorColorTable.UpdateColorColumn(), mapwindow.BufferedWindow.UpdateMap(), and wxdigit.VDigitError.WriteLine().

frame.ModelFrame.pythonPanel

Definition at line 109 of file gmodeler/frame.py.

frame.ModelFrame.randomness

Definition at line 75 of file gmodeler/frame.py.

frame.ModelFrame.searchDialog

Definition at line 71 of file gmodeler/frame.py.

Referenced by frame.ModelFrame.OnAddAction().

frame.ModelFrame.statusbar

Definition at line 93 of file gmodeler/frame.py.

Referenced by goutput.PyStc.OnKeyPressed().

frame.ModelFrame.toolbar

Definition at line 90 of file gmodeler/frame.py.

Referenced by mapwindow.BufferedWindow.OnDragging(), mapwindow.VDigitWindow.OnKeyDown(), mapwindow.VDigitWindow.OnLeftDownUndo(), and mapwindow.VDigitWindow.SetToolbar().

frame.ModelFrame.variablePanel

Definition at line 105 of file gmodeler/frame.py.

---

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

• gmodeler/frame.py