GRASS Programmer's Manual  6.4.4(2014)-r
model.ModelAction Class Reference

Action class (GRASS module) More...

Inheritance diagram for model.ModelAction:
Collaboration diagram for model.ModelAction:

Public Member Functions

def __init__
 
def SetId (self, id)
 Set id. More...
 
def SetProperties (self, params, propwin)
 Record properties dialog. More...
 
def GetPropDialog (self)
 Get properties dialog. More...
 
def GetLog
 Get logging info. More...
 
def GetName (self)
 Get name. More...
 
def GetParams
 Get dictionary of parameters. More...
 
def GetTask (self)
 Get grassTask instance. More...
 
def SetParams (self, params)
 Set dictionary of parameters. More...
 
def MergeParams (self, params)
 Merge dictionary of parameters. More...
 
def SetValid (self, options)
 Set validity for action. More...
 
def IsValid (self)
 Check validity (all required parameters set) More...
 
def IsParameterized (self)
 Check if action is parameterized. More...
 
def FindData (self, name)
 Find data item by name. More...
 
def Update
 Update action. More...
 
def OnDraw (self, dc)
 Draw action in canvas. More...
 
- Public Member Functions inherited from model.ModelObject
def __init__
 
def __del__ (self)
 
def GetId (self)
 Get id. More...
 
def AddRelation (self, rel)
 Record new relation. More...
 
def GetRelations
 Get list of relations. More...
 
def IsEnabled (self)
 Get True if action is enabled, otherwise False. More...
 
def Enable
 Enable/disable action. More...
 
def Update (self)
 
def SetBlock (self, item)
 Add object to the block (loop/condition) More...
 
def UnSetBlock (self, item)
 Remove object from the block (loop/consition) More...
 
def GetBlock (self)
 Get list of related ModelObject(s) which defines block (loop/condition) More...
 
def GetBlockId (self)
 Get list of related ids which defines block. More...
 

Data Fields

 parent
 
 task
 
 propWin
 
 data
 
 isValid
 
 isParameterized
 
 id
 
 IsParameterized
 
- Data Fields inherited from model.ModelObject
 id
 
 rels
 
 isEnabled
 
 inBlock
 

Detailed Description

Action class (GRASS module)

Definition at line 844 of file model.py.

Constructor & Destructor Documentation

def model.ModelAction.__init__ (   self,
  parent,
  x,
  y,
  id = -1,
  cmd = None,
  task = None,
  width = None,
  height = None 
)

Definition at line 846 of file model.py.

Member Function Documentation

def model.ModelAction.FindData (   self,
  name 
)

Find data item by name.

Definition at line 1056 of file model.py.

References model.ModelObject.GetRelations().

def model.ModelAction.GetLog (   self,
  string = True,
  substitute = None 
)

Get logging info.

Parameters
stringTrue to get cmd as a string otherwise a list
substitutedictionary of parameter to substitute or None

Definition at line 939 of file model.py.

References tools.range.

def model.ModelAction.GetName (   self)
def model.ModelAction.GetParams (   self,
  dcopy = False 
)

Get dictionary of parameters.

Definition at line 996 of file model.py.

def model.ModelAction.GetPropDialog (   self)

Get properties dialog.

Definition at line 935 of file model.py.

References model.ModelAction.propWin.

def model.ModelAction.GetTask (   self)

Get grassTask instance.

Definition at line 1003 of file model.py.

References model.ModelAction.task.

def model.ModelAction.IsParameterized (   self)

Check if action is parameterized.

Definition at line 1052 of file model.py.

References model.ModelAction.isParameterized, and model.ModelAction.IsParameterized.

def model.ModelAction.IsValid (   self)

Check validity (all required parameters set)

Definition at line 1048 of file model.py.

References model.ModelAction.isValid.

def model.ModelAction.MergeParams (   self,
  params 
)

Merge dictionary of parameters.

Definition at line 1012 of file model.py.

def model.ModelAction.OnDraw (   self,
  dc 
)

Draw action in canvas.

Definition at line 1073 of file model.py.

References model.ModelAction._setBrush(), and model.ModelAction._setPen().

def model.ModelAction.SetId (   self,
  id 
)

Set id.

Definition at line 919 of file model.py.

def model.ModelAction.SetParams (   self,
  params 
)

Set dictionary of parameters.

Definition at line 1007 of file model.py.

def model.ModelAction.SetProperties (   self,
  params,
  propwin 
)

Record properties dialog.

Definition at line 929 of file model.py.

References model.ModelAction.propWin.

def model.ModelAction.SetValid (   self,
  options 
)

Set validity for action.

Parameters
optionsdictionary with flags and params (gtask)

Definition at line 1023 of file model.py.

References model.ModelAction.isParameterized, and model.ModelAction.isValid.

Field Documentation

model.ModelAction.isParameterized

Definition at line 873 of file model.py.

Referenced by model.ModelAction.IsParameterized(), and model.ModelAction.SetValid().

model.ModelAction.IsParameterized

Definition at line 1033 of file model.py.

Referenced by model.ModelAction.IsParameterized().

model.ModelAction.isValid

Definition at line 872 of file model.py.

Referenced by model.ModelAction.IsValid(), and model.ModelAction.SetValid().

model.ModelAction.task

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