GRASS Programmer's Manual  6.4.2(2012)
gui_modules.gmodeler.ModelFrame Class Reference

Public Member Functions

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

Data Fields

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

Detailed Description

Definition at line 646 of file gmodeler.py.


Constructor & Destructor Documentation

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

Graphical modeler main window.

Parameters:
parentparent window
idwindow id
titlewindow title
kwargswx.Frames' arguments

Definition at line 647 of file gmodeler.py.


Member Function Documentation

def gui_modules.gmodeler.ModelFrame.DefineCondition (   self,
  condition 
)

Define if-else statement with given list of items.

Definition at line 1540 of file gmodeler.py.

References gui_modules.gmodeler.ModelFrame.AddLine().

Referenced by gui_modules.gmodeler.ModelFrame.LoadModelFile().

def gui_modules.gmodeler.ModelFrame.DefineLoop (   self,
  loop 
)

Define loop with given list of items.

Definition at line 1496 of file gmodeler.py.

References gui_modules.gmodeler.ModelFrame.AddLine().

Referenced by gui_modules.gmodeler.ModelFrame.LoadModelFile().

def gui_modules.gmodeler.ModelFrame.OnAbout (   self,
  event 
)

Display About window.

Definition at line 1290 of file gmodeler.py.

def gui_modules.gmodeler.ModelFrame.OnAddData (   self,
  event 
)

Add data item to model.

Definition at line 1258 of file gmodeler.py.

References gui_modules.gmodeler.ModelFrame._addEvent(), and gui_modules.gmodeler.ModelFrame.ModelChanged().

Refresh canvas.

Definition at line 765 of file gmodeler.py.

References gui_modules.gmodeler.Model.GetCanvas(), and gui_modules.gmodeler.ModelFrame.GetCanvas().

def gui_modules.gmodeler.ModelFrame.OnCmdDone (   self,
  event 
)

Command done (or aborted)

Definition at line 780 of file gmodeler.py.

References gui_modules.gmodeler.ModelFrame.GetModel().

def gui_modules.gmodeler.ModelFrame.OnCmdRun (   self,
  event 
)

Run command.

Definition at line 771 of file gmodeler.py.

References gui_modules.gmodeler.ModelFrame.GetModel().

Define new condition in the model.

Definition at line 1187 of file gmodeler.py.

References gui_modules.gmodeler.ModelFrame._addEvent(), and gui_modules.gmodeler.ModelFrame.ModelChanged().

def gui_modules.gmodeler.ModelFrame.OnDefineLoop (   self,
  event 
)

Define new loop in the model.

Definition at line 1172 of file gmodeler.py.

References gui_modules.gmodeler.ModelFrame._addEvent(), and gui_modules.gmodeler.ModelFrame.ModelChanged().

Define relation between data and action items.

Definition at line 1166 of file gmodeler.py.

References gui_modules.gcpmapdisp.MapFrame.cursors, gui_modules.gmodeler.ModelFrame.cursors, and gui_modules.gmodeler.ModelFrame.defineRelation.

def gui_modules.gmodeler.ModelFrame.OnDeleteData (   self,
  event 
)

Delete intermediate data.

Definition at line 857 of file gmodeler.py.

def gui_modules.gmodeler.ModelFrame.OnExportImage (   self,
  event 
)

Export model to image (default image)

Definition at line 1062 of file gmodeler.py.

References gui_modules::gdialogs.GetImageHandlers().

Export model to Python script.

Definition at line 1125 of file gmodeler.py.

References gui_modules.gmodeler.ModelFrame.model.

def gui_modules.gmodeler.ModelFrame.OnHelp (   self,
  event 
)

Show help.

Definition at line 831 of file gmodeler.py.

References gui_modules.colorrules.ColorTable.parent, gui_modules.dbm_dialogs.DisplayAttributesDialog.parent, gui_modules.dbm.Log.parent, gui_modules.dbm.VirtualAttributeList.parent, gui_modules.gcpmapdisp.MapFrame.parent, gui_modules.gcpmanager.GCPWizard.parent, gui_modules.ghelp.MenuTreeWindow.parent, gui_modules.gcpmanager.LocationPage.parent, gui_modules.gcpmanager.GroupPage.parent, gui_modules.ghelp.MenuTree.parent, gui_modules.gdialogs.DecorationDialog.parent, gui_modules.dbm.AttributeManager.parent, gui_modules.gcpmanager.DispMapPage.parent, gui_modules.gmodeler.ModelFrame.parent, gui_modules.gdialogs.TextLayerDialog.parent, gui_modules.colorrules.BufferedWindow.parent, gui_modules.gcpmanager.GCP.parent, gui_modules.ghelp.InstallExtensionWindow.parent, gui_modules.gdialogs.AddMapLayersDialog.parent, gui_modules.ghelp.ExtensionTree.parent, gui_modules.gdialogs.ImportDialog.parent, gui_modules.ghelp.UninstallExtensionWindow.parent, gui_modules.ghelp.CheckListExtension.parent, gui_modules.ghelp.HelpWindow.parent, gui_modules.gdialogs.LayersList.parent, gui_modules.gdialogs.SetOpacityDialog.parent, gui_modules.gdialogs.StaticWrapText.parent, gui_modules.gdialogs.ImageSizeDialog.parent, gui_modules.dbm.TableListCtrl.parent, gui_modules.dbm.LayerListCtrl.parent, gui_modules.dbm.LayerBook.parent, gui_modules.gcpmanager.GrSettingsDialog.parent, and gui_modules::gcmd.RunCommand().

Referenced by gui_modules.gmodeler.ModelFrame.OnHelp(), and gui_modules.menuform.mainFrame.OnKeyUp().

def gui_modules.gmodeler.ModelFrame.OnHelp (   self,
  event 
)

Display manual page.

Definition at line 1285 of file gmodeler.py.

References gui_modules.gmodeler.ModelFrame.OnHelp().

Referenced by gui_modules.menuform.mainFrame.OnKeyUp().

Model properties dialog.

Definition at line 842 of file gmodeler.py.

References gui_modules.gmodeler.ModelFrame.ModelChanged().

def gui_modules.gmodeler.ModelFrame.OnPreferences (   self,
  event 
)

Open preferences dialog.

Definition at line 823 of file gmodeler.py.

def gui_modules.gmodeler.ModelFrame.OnRemoveItem (   self,
  event 
)

Remove shape.

Definition at line 760 of file gmodeler.py.

References gui_modules.gmodeler.Model.GetCanvas(), and gui_modules.gmodeler.ModelFrame.GetCanvas().

def gui_modules.gmodeler.ModelFrame.OnSize (   self,
  event 
)
Window resized, save to the model

Definition at line 818 of file gmodeler.py.

References gui_modules.gmodeler.ModelFrame.ModelChanged().

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

Validate entire model.

Definition at line 1043 of file gmodeler.py.

def gui_modules.gmodeler.ModelFrame.OnVariables (   self,
  event 
)

Switch to variables page.

Definition at line 756 of file gmodeler.py.

def gui_modules.gmodeler.ModelFrame.WriteModelFile (   self,
  filename 
)

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

Returns:
True on success
False on failure

Definition at line 1465 of file gmodeler.py.

References gui_modules.gmodeler.ModelFrame.model, and gui_modules.gmodeler.ModelFrame.ModelChanged().

Referenced by gui_modules.gmodeler.ModelFrame.OnCloseWindow(), gui_modules.gmodeler.ModelFrame.OnModelSave(), and gui_modules.gmodeler.ModelFrame.OnModelSaveAs().


Field Documentation

Definition at line 654 of file gmodeler.py.

Referenced by gui_modules.toolbars.GCPManToolbar::__init__(), gui_modules.prompt.GPromptPopUp::__init__(), gui_modules.toolbars.ProfileToolbar::__init__(), gui_modules.toolbars.ModelToolbar::__init__(), gui_modules.toolbars.HistogramToolbar::__init__(), gui_modules.toolbars.LMWorkspaceToolbar::__init__(), gui_modules.toolbars.LMDataToolbar::__init__(), gui_modules.toolbars.LMToolsToolbar::__init__(), gui_modules.toolbars.LMMiscToolbar::__init__(), gui_modules.toolbars.LMVectorToolbar::__init__(), gui_modules.gmodeler.ModelLoop::__init__(), gui_modules.goutput.GMStc::AddTextWrapped(), gui_modules.wxvdigit.VDigitError::Database(), gui_modules.wxvdigit.VDigitError::DbExecute(), gui_modules.wxvdigit.VDigitError::DbLink(), gui_modules.wxvdigit.VDigitError::DeadLine(), gui_modules.mapdisp_window.BufferedWindow::Distance(), gui_modules.wxvdigit.VDigitError::Driver(), gui_modules.toolbars.MapToolbar::ExitToolbars(), gui_modules.wxvdigit.VDigitError::FeatureType(), gui_modules.preferences.CheckListMapset::LoadData(), gui_modules.wxvdigit.VDigitError::NoMap(), gui_modules.toolbars.VDigitToolbar::OnAddArea(), gui_modules.toolbars.VDigitToolbar::OnAddBoundary(), gui_modules.toolbars.VDigitToolbar::OnAddCentroid(), gui_modules.toolbars.VDigitToolbar::OnAddLine(), gui_modules.toolbars.VDigitToolbar::OnAddPoint(), gui_modules.toolbars.VDigitToolbar::OnAddVertex(), gui_modules.profile.OptDialog::OnApply(), gui_modules.toolbars.VDigitToolbar::OnBreak(), gui_modules.mapdisp_window.BufferedWindow::OnButtonDClick(), gui_modules.menuform.mainFrame::OnCancel(), gui_modules.vdigit.VDigitSettingsDialog::OnCancel(), gui_modules.vdigit.VDigitCategoryDialog::OnCancel(), gui_modules.psmap_dialogs.MapDialog::OnCancel(), gui_modules.preferences.CheckListMapset::OnCheckItem(), gui_modules.goutput.GMConsole::OnCmdDone(), gui_modules.toolbars.VDigitToolbar::OnConnect(), gui_modules.toolbars.VDigitToolbar::OnCopy(), gui_modules.toolbars.VDigitToolbar::OnCopyAttrb(), gui_modules.toolbars.VDigitToolbar::OnCopyCats(), gui_modules.profile.ProfileFrame::OnCreateProfile(), gui_modules.toolbars.VDigitToolbar::OnDeleteLine(), gui_modules.toolbars.VDigitToolbar::OnDisplayAttr(), gui_modules.toolbars.VDigitToolbar::OnDisplayCats(), gui_modules.menuform.mainFrame::OnDone(), gui_modules.location_wizard.DatumPage::OnDText(), gui_modules.toolbars.VDigitToolbar::OnEditLine(), gui_modules.location_wizard.CoordinateSystemPage::OnEnterPage(), gui_modules.location_wizard.DatumPage::OnEnterPage(), gui_modules.location_wizard.EPSGPage::OnEnterPage(), gui_modules.location_wizard.SummaryPage::OnEnterPage(), gui_modules.toolbars.VDigitToolbar::OnExit(), gui_modules.toolbars.NvizToolbar::OnExit(), gui_modules.toolbars.VDigitToolbar::OnFlip(), gui_modules.gmodeler.ModelFrame::OnHelp(), gui_modules.mapdisp_vdigit.VDigitWindow::OnLeftDownAddLine(), gui_modules.mapdisp_vdigit.VDigitWindow::OnLeftDownDisplayCA(), gui_modules.mapdisp_window.BufferedWindow::OnLeftUp(), gui_modules.toolbars.VDigitToolbar::OnMerge(), gui_modules.mapdisp_window.MapWindow::OnMotion(), gui_modules.psmap.PsMapBufferedWindow::OnMouse(), gui_modules.mapdisp_window.BufferedWindow::OnMouseEnter(), gui_modules.toolbars.VDigitToolbar::OnMoveLine(), gui_modules.toolbars.VDigitToolbar::OnMoveVertex(), gui_modules.location_wizard.DatumPage::OnPageChanging(), gui_modules.location_wizard.EllipsePage::OnPageChanging(), gui_modules.location_wizard.EPSGPage::OnPageChanging(), gui_modules.location_wizard.CustomPage::OnPageChanging(), wxgui.GMFrame::OnPsMap(), gui_modules.toolbars.VDigitToolbar::OnQuery(), gui_modules.toolbars.VDigitToolbar::OnRemoveVertex(), gui_modules.menuform.mainFrame::OnRun(), gui_modules.prompt.GPrompt::OnRunCmd(), gui_modules.vdigit.VDigitSettingsDialog::OnSave(), gui_modules.profile.OptDialog::OnSave(), gui_modules.location_wizard.EllipsePage::OnSearch(), gui_modules.toolbars.VDigitToolbar::OnSelectMap(), gui_modules.toolbars.MapToolbar::OnSelectTool(), gui_modules.gselect.GdalSelect::OnSetDsn(), gui_modules.toolbars.VDigitToolbar::OnSettings(), gui_modules.toolbars.NvizToolbar::OnSettings(), gui_modules.toolbars.VDigitToolbar::OnSnap(), gui_modules.toolbars.VDigitToolbar::OnSplitLine(), gui_modules.location_wizard.ProjectionsPage::OnText(), gui_modules.location_wizard.EllipsePage::OnText(), gui_modules.toolbars.AbstractToolbar::OnTool(), gui_modules.toolbars.VDigitToolbar::OnTool(), gui_modules.toolbars.VDigitToolbar::OnTypeConversion(), gui_modules.menuform.cmdPanel::OnUpdateSelection(), gui_modules.toolbars.VDigitToolbar::OnZBulk(), gui_modules.psmap_dialogs.Instruction::Read(), gui_modules.wxvdigit.VDigitError::ReadLine(), gui_modules.mapdisp_command.Command::run(), gui_modules.goutput.CmdThread::run(), gui_modules.menuform.UpdateQThread::run(), gui_modules.goutput.GMConsole::RunCmd(), gui_modules.location_wizard.CoordinateSystemPage::SetVal(), gui_modules.location_wizard.ProjParamsPage::SetVal(), gui_modules.toolbars.VDigitToolbar::StartEditing(), gui_modules.toolbars.VDigitToolbar::StopEditing(), gui_modules.psmap_dialogs.VectorPanel::update(), gui_modules.psmap_dialogs.MapinfoDialog::update(), gui_modules.psmap_dialogs.ScalebarDialog::update(), gui_modules.psmap_dialogs.TextDialog::update(), gui_modules.psmap_dialogs.MapDialog::updateDialog(), gui_modules.histogram.BufferedWindow::UpdateHist(), gui_modules.mapdisp_window.BufferedWindow::UpdateMap(), gui_modules.vdigit.VDigitSettingsDialog::UpdateSettings(), gui_modules.goutput.GMStdout::write(), gui_modules.wxvdigit.VDigitError::WriteLine(), gui_modules.mapdisp_window.BufferedWindow::Zoom(), gui_modules.mapdisp_window.BufferedWindow::ZoomBack(), and gui_modules.mapdisp_window.BufferedWindow::ZoomHistory().


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines