GRASS Programmer's Manual
6.4.2(2012)
|
Class representing the model. More...
Public Member Functions | |
def | __init__ |
def | GetCanvas |
Get canvas or None. | |
def | GetItems |
Get list of model items. | |
def | GetItem |
Get item of given id. | |
def | GetNumItems |
Get number of items. | |
def | GetNextId |
Get next id (data ignored) | |
def | GetProperties |
Get model properties. | |
def | GetVariables |
Get model variables. | |
def | SetVariables |
Set model variables. | |
def | Reset |
Reset model. | |
def | RemoveItem |
Remove item from model. | |
def | FindAction |
Find action by id. | |
def | GetData |
Get list of data items. | |
def | FindData |
Find data item in the model. | |
def | LoadModel |
Load model definition stored in GRASS Model XML file (gxm) | |
def | AddItem |
Add item to the list. | |
def | IsValid |
def | Validate |
Validate model, return None if model is valid otherwise error string. | |
def | RunAction |
Run given action. | |
def | Run |
Run model. | |
def | DeleteIntermediateData |
Detele intermediate data. | |
def | GetIntermediateData |
Get info about intermediate data. | |
def | Update |
Update model. | |
def | IsParameterized |
Return True if model is parameterized. | |
def | Parameterize |
Return parameterized options. |
Data Fields | |
items | |
properties | |
variables | |
variablesParams | |
canvas |
Class representing the model.
Definition at line 83 of file gmodeler.py.
def gui_modules.gmodeler.Model.__init__ | ( | self, | |
canvas = None |
|||
) |
Definition at line 85 of file gmodeler.py.
def gui_modules.gmodeler.Model.AddItem | ( | self, | |
newItem | |||
) |
Add item to the list.
Definition at line 387 of file gmodeler.py.
References gui_modules.gmodeler.Model.items.
Referenced by gui_modules.gselect.TreeCtrlComboPopup.GetAdjustedSize(), and gui_modules.gmodeler.Model.LoadModel().
def gui_modules.gmodeler.Model.DeleteIntermediateData | ( | self, | |
log | |||
) |
Detele intermediate data.
Definition at line 523 of file gmodeler.py.
References gui_modules.gmodeler.Model.GetIntermediateData().
def gui_modules.gmodeler.Model.FindAction | ( | self, | |
aId | |||
) |
Find action by id.
Definition at line 208 of file gmodeler.py.
References gui_modules.gmodeler.Model.GetItems().
Referenced by gui_modules.gmodeler.Model.LoadModel().
def gui_modules.gmodeler.Model.FindData | ( | self, | |
value, | |||
prompt | |||
) |
Find data item in the model.
value | value |
prompt | prompt |
Definition at line 236 of file gmodeler.py.
References gui_modules.gmodeler.Model.GetData().
def gui_modules.gmodeler.Model.GetCanvas | ( | self | ) |
Get canvas or None.
Definition at line 98 of file gmodeler.py.
References gui_modules.disp_print.MapPrint.canvas, and gui_modules.gmodeler.Model.canvas.
Referenced by gui_modules.gmodeler.ModelFrame.OnCanvasRefresh(), and gui_modules.gmodeler.ModelFrame.OnRemoveItem().
def gui_modules.gmodeler.Model.GetData | ( | self | ) |
Get list of data items.
Definition at line 217 of file gmodeler.py.
References gui_modules.gmodeler.Model.GetItems().
Referenced by gui_modules.gmodeler.Model.FindData(), and gui_modules.gmodeler.Model.GetIntermediateData().
def gui_modules.gmodeler.Model.GetIntermediateData | ( | self | ) |
Get info about intermediate data.
Definition at line 534 of file gmodeler.py.
References gui_modules.gmodeler.Model.GetData().
Referenced by gui_modules.gmodeler.Model.DeleteIntermediateData().
def gui_modules.gmodeler.Model.GetItem | ( | self, | |
aId | |||
) |
Get item of given id.
aId | item id |
Definition at line 117 of file gmodeler.py.
References gui_modules.gmodeler.Model.GetItems().
Referenced by gui_modules.gmodeler.ItemCheckListCtrl.CheckItemById(), gui_modules.dbm.VirtualAttributeList.GetColumnText(), gui_modules.gmodeler.ItemCheckListCtrl.GetItems(), gui_modules.gdialogs.LayersList.GetLayers(), gui_modules.gmodeler.Model.LoadModel(), gui_modules.gmodeler.VariableListCtrl.OnEndEdit(), gui_modules.gmodeler.ItemListCtrl.OnEndEdit(), gui_modules.gcpmanager.GCPList.OnItemActivated(), and gui_modules.gmodeler.ItemListCtrl.OnRemove().
def gui_modules.gmodeler.Model.GetItems | ( | self, | |
objType = None |
|||
) |
Get list of model items.
objType | Object type to filter model objects |
Definition at line 102 of file gmodeler.py.
References gui_modules.gmodeler.Model.items.
Referenced by gui_modules.gmodeler.Model.FindAction(), gui_modules.gmodeler.Model.GetData(), gui_modules.gmodeler.Model.GetItem(), gui_modules.gmodeler.Model.GetNumItems(), gui_modules.prompt.TextCtrlAutoComplete.OnCommandSelect(), gui_modules.prompt.TextCtrlAutoComplete.OnKeyDown(), gui_modules.gmodeler.Model.Parameterize(), gui_modules.gmodeler.Model.RemoveItem(), gui_modules.gselect.LayerSelect.Reset(), gui_modules.gmodeler.Model.Run(), and gui_modules.gmodeler.Model.Validate().
def gui_modules.gmodeler.Model.GetNextId | ( | self | ) |
Get next id (data ignored)
Definition at line 139 of file gmodeler.py.
References gui_modules.gmodeler.Model.items.
def gui_modules.gmodeler.Model.GetNumItems | ( | self, | |
actionOnly = False |
|||
) |
Get number of items.
Definition at line 132 of file gmodeler.py.
References gui_modules.gmodeler.Model.GetItems().
Referenced by gui_modules.gmodeler.Model.Run().
def gui_modules.gmodeler.Model.GetProperties | ( | self | ) |
Get model properties.
Definition at line 153 of file gmodeler.py.
References gui_modules.colorrules.ColorTable.properties, and gui_modules.gmodeler.Model.properties.
def gui_modules.gmodeler.Model.GetVariables | ( | self, | |
params = False |
|||
) |
Get model variables.
Definition at line 157 of file gmodeler.py.
References gui_modules.gmodeler.Model.variables, and gui_modules.gmodeler.Model.variablesParams.
Referenced by gui_modules.gmodeler.Model.Run().
def gui_modules.gmodeler.Model.IsParameterized | ( | self | ) |
Return True if model is parameterized.
Definition at line 569 of file gmodeler.py.
References gui_modules.gmodeler.Model.Parameterize().
def gui_modules.gmodeler.Model.IsValid | ( | self | ) |
Return True if model is valid
Definition at line 400 of file gmodeler.py.
References gui_modules.gmodeler.Model.Validate().
def gui_modules.gmodeler.Model.LoadModel | ( | self, | |
filename | |||
) |
Load model definition stored in GRASS Model XML file (gxm)
Raise exception on error.
Definition at line 252 of file gmodeler.py.
References gui_modules.gmodeler.Model.AddItem(), gui_modules.disp_print.MapPrint.canvas, gui_modules.gmodeler.Model.canvas, gui_modules.gmodeler.Model.FindAction(), gui_modules.gmodeler.Model.GetItem(), gui_modules.colorrules.ColorTable.properties, gui_modules.gmodeler.Model.properties, and gui_modules.gmodeler.Model.variables.
def gui_modules.gmodeler.Model.Parameterize | ( | self | ) |
Return parameterized options.
Definition at line 576 of file gmodeler.py.
References gui_modules.gmodeler.Model.GetItems(), gui_modules.gmodeler.Model.variables, and gui_modules.gmodeler.Model.variablesParams.
Referenced by gui_modules.gmodeler.Model.IsParameterized(), and gui_modules.gmodeler.Model.Run().
def gui_modules.gmodeler.Model.RemoveItem | ( | self, | |
item | |||
) |
Remove item from model.
Definition at line 172 of file gmodeler.py.
References gui_modules.gmodeler.Model.GetItems().
def gui_modules.gmodeler.Model.Reset | ( | self | ) |
Reset model.
Definition at line 168 of file gmodeler.py.
References gui_modules.gmodeler.Model.items.
Referenced by gui_modules.nviz_mapdisp.GLWindow.OnClose().
def gui_modules.gmodeler.Model.Run | ( | self, | |
log, | |||
onDone, | |||
parent = None |
|||
) |
Run model.
log | logging window (see goutput.GMConsole) |
onDone | on-done method |
parent | window for messages or None |
Definition at line 439 of file gmodeler.py.
References gui_modules.gmodeler.Model.GetItems(), gui_modules.gmodeler.Model.GetNumItems(), gui_modules.gmodeler.Model.GetVariables(), gui_modules.gmodeler.Model.Parameterize(), gui_modules.gmodeler.Model.RunAction(), and gui_modules.gmodeler.Model.Validate().
def gui_modules.gmodeler.Model.RunAction | ( | self, | |
item, | |||
params, | |||
log, | |||
onDone, | |||
statusbar = None |
|||
) |
Run given action.
item | action item |
params | parameters dict |
log | logging window |
onDone | on-done method |
statusbar | wx.StatusBar instance or None |
Definition at line 417 of file gmodeler.py.
Referenced by gui_modules.gmodeler.Model.Run().
def gui_modules.gmodeler.Model.SetVariables | ( | self, | |
data | |||
) |
Set model variables.
Definition at line 164 of file gmodeler.py.
References gui_modules.gmodeler.Model.variables.
def gui_modules.gmodeler.Model.Update | ( | self | ) |
Update model.
Definition at line 564 of file gmodeler.py.
References gui_modules.gmodeler.Model.items.
Referenced by gui_modules.gmodeler.ModelObject.Enable(), gui_modules.gcpmanager.GroupPage.GetOptData(), gui_modules.location_wizard.DatumPage.OnDText(), gui_modules.colorrules.ColorTable.OnSelectionInput(), gui_modules.nviz_tools.NvizToolWindow.OnViewChangedSpin(), gui_modules.mapdisp_window.BufferedWindow.TextBounds(), gui_modules.nviz_tools.NvizToolWindow.UpdatePage(), and gui_modules.nviz_tools.NvizToolWindow.UpdateSettings().
def gui_modules.gmodeler.Model.Validate | ( | self | ) |
Validate model, return None if model is valid otherwise error string.
Definition at line 407 of file gmodeler.py.
References gui_modules.gmodeler.Model.GetItems().
Referenced by gui_modules.gmodeler.Model.IsValid(), gui_modules.menuform.FloatValidator.OnText(), and gui_modules.gmodeler.Model.Run().
gui_modules.gmodeler.Model.canvas |
Definition at line 96 of file gmodeler.py.
Referenced by gui_modules.gmodeler.Model.GetCanvas(), gui_modules.gmodeler.ModelFrame.GetCanvas(), and gui_modules.gmodeler.Model.LoadModel().
gui_modules.gmodeler.Model.items |
Definition at line 86 of file gmodeler.py.
Referenced by gui_modules.gmodeler.Model.AddItem(), gui_modules.gmodeler.ModelLoop.Enable(), gui_modules.gmodeler.Model.GetItems(), gui_modules.gmodeler.ModelItem.GetItems(), gui_modules.gmodeler.Model.GetNextId(), gui_modules.gmodeler.Model.Reset(), gui_modules.gmodeler.ModelCondition.SetItems(), and gui_modules.gmodeler.Model.Update().
gui_modules.gmodeler.Model.properties |
Definition at line 89 of file gmodeler.py.
Referenced by gui_modules.profile.ProfileFrame.DrawPlot(), gui_modules.gmodeler.Model.GetProperties(), gui_modules.gmodeler.Model.LoadModel(), gui_modules.profile.ProfileFrame.OnPText(), gui_modules.profile.ProfileFrame.SetGraphStyle(), gui_modules.profile.TextDialog.UpdateSettings(), and gui_modules.profile.OptDialog.UpdateSettings().
gui_modules.gmodeler.Model.variables |
Definition at line 93 of file gmodeler.py.
Referenced by gui_modules.gmodeler.Model.GetVariables(), gui_modules.gmodeler.Model.LoadModel(), gui_modules.gmodeler.Model.Parameterize(), and gui_modules.gmodeler.Model.SetVariables().
gui_modules.gmodeler.Model.variablesParams |
Definition at line 94 of file gmodeler.py.
Referenced by gui_modules.gmodeler.Model.GetVariables(), and gui_modules.gmodeler.Model.Parameterize().