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

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

Detailed Description

Class representing the model.

Definition at line 83 of file gmodeler.py.


Constructor & Destructor Documentation

def gui_modules.gmodeler.Model.__init__ (   self,
  canvas = None 
)

Definition at line 85 of file gmodeler.py.


Member Function Documentation

def gui_modules.gmodeler.Model.AddItem (   self,
  newItem 
)

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.

Parameters:
valuevalue
promptprompt
Returns:
ModelData instance
None if not found

Definition at line 236 of file gmodeler.py.

References gui_modules.gmodeler.Model.GetData().

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().

Get next id (data ignored)

Returns:
next id to be used (default: 1)

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.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().

Return True if model is parameterized.

Definition at line 569 of file gmodeler.py.

References gui_modules.gmodeler.Model.Parameterize().

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.RemoveItem (   self,
  item 
)

Remove item from model.

Returns:
list of related items to remove/update

Definition at line 172 of file gmodeler.py.

References gui_modules.gmodeler.Model.GetItems().

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 
)
def gui_modules.gmodeler.Model.RunAction (   self,
  item,
  params,
  log,
  onDone,
  statusbar = None 
)

Run given action.

Parameters:
itemaction item
paramsparameters dict
loglogging window
onDoneon-done method
statusbarwx.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.

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().


Field Documentation


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