GRASS Programmer's Manual  6.5.svn(2014)-r66266
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
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
parentparent window
idwindow id
titlewindow title
kwargswx.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
relrelation

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 
)
def frame.ModelFrame.LoadModelFile (   self,
  filename 
)
def frame.ModelFrame.OnAbout (   self,
  event 
)

Display About window.

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

def frame.ModelFrame.OnAddAction (   self,
  event 
)
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 
)
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.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 
)

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 
)
def frame.ModelFrame.OnModelNew (   self,
  event 
)
def frame.ModelFrame.OnModelOpen (   self,
  event 
)
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 
)
def frame.ModelFrame.OnModelSaveAs (   self,
  event 
)
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.canvas
frame.ModelFrame.defineRelation

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

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.notebook
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.variablePanel

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


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