This class holds the structures needed for filling by the parser. More...

Public Member Functions
def	__init__
def	define_first
	Define first parameter.
def	get_error_msg
	Get error message ('' for no error)
def	get_name
	Get task name.
def	get_description
	Get module's description.
def	get_keywords
	Get module's keywords.
def	get_list_params
	Get list of parameters.
def	get_list_flags
	Get list of flags.
def	get_param
	Find and return a param by name.
def	get_flag
	Find and return a flag by name.
def	getCmdError
	Get error string produced by getCmd(ignoreErrors = False)
def	getCmd
	Produce an array of command name and arguments for feeding into some execve-like command processor.
def	get_options
	Get options.
def	has_required
	Check if command has at least one required paramater.
def	set_param
	Set param value/values.
def	set_flag
	Enable / disable flag.
def	set_options
	Set flags and parameters.

Data Fields
	path
	name
	params
	description
	label
	flags
	keywords
	errorMsg
	firstParam
	blackList

Detailed Description

This class holds the structures needed for filling by the parser.

Parameter blackList is a dictionary with fixed structure, eg.

blackList = {'items' : {'d.legend' : { 'flags' : ['m'],
                                       'params' : [] }},
             'enabled': True}

Parameters:

path	full path
blackList	hide some options in the GUI (dictionary)

Definition at line 35 of file task.py.

Constructor & Destructor Documentation

def python.task.grassTask.__init__	(	self,
		path = `None`,
		blackList = `None`
	)

Definition at line 50 of file task.py.

Member Function Documentation

def python.task.grassTask.define_first ( self )

Define first parameter.

Definition at line 74 of file task.py.

References python.task.grassTask.firstParam, python.task.grassTask.params, gui_modules.histogram.HistFrame.params, and gui_modules.gmodeler.ModelParamDialog.params.

def python.task.grassTask.get_description	(	self,
		full = `True`
	)

Get module's description.

Parameters:

full	True for label + desc

Definition at line 90 of file task.py.

References python.task.grassTask.description, icons.icon.MetaIcon.description, gui_modules.menuform.mainFrame.description, python.task.grassTask.label, gui_modules.gdialogs.ElementDialog.label, and icons.icon.MetaIcon.label.

def python.task.grassTask.get_error_msg ( self )

Get error message ('' for no error)

Definition at line 80 of file task.py.

References python.task.grassTask.errorMsg.

def python.task.grassTask.get_flag	(	self,
		aFlag
	)

Find and return a flag by name.

Raises ValueError when the flag is not found.

Parameters:

aFlag name of the flag

Definition at line 160 of file task.py.

References python.task.grassTask.flags.

Referenced by python.task.grassTask.set_flag().

def python.task.grassTask.get_keywords ( self )

Get module's keywords.

Definition at line 103 of file task.py.

References python.task.grassTask.keywords.

def python.task.grassTask.get_list_flags	(	self,
		element = `'name'`
	)

Get list of flags.

Parameters:

element element name

Definition at line 119 of file task.py.

References python.task.grassTask.flags.

def python.task.grassTask.get_list_params	(	self,
		element = `'name'`
	)

Get list of parameters.

Parameters:

element element name

Definition at line 108 of file task.py.

References python.task.grassTask.params, gui_modules.histogram.HistFrame.params, and gui_modules.gmodeler.ModelParamDialog.params.

def python.task.grassTask.get_name ( self )

Get task name.

Definition at line 85 of file task.py.

References @1.name, locale.name, _item_.name, ellps_list.name, _pad_.name, COLUMN.name, datum_list.name, table.name, paper.name, python.task.grassTask.name, fileinfo.name, gui_modules.render.Layer.name, gui_modules.gdialogs.DecorationDialog.name, gui_modules.gmodeler.PropertiesDialog.name, and gui_modules.gmodeler.VariablePanel.name.

def python.task.grassTask.get_options ( self )

Get options.

Definition at line 230 of file task.py.

References python.task.grassTask.flags, python.task.grassTask.params, gui_modules.histogram.HistFrame.params, and gui_modules.gmodeler.ModelParamDialog.params.

def python.task.grassTask.get_param	(	self,
		value,
		element = `'name'`,
		raiseError = `True`
	)

Find and return a param by name.

Parameters:

value	param's value
element	element name
raiseError	True for raise on error

Definition at line 130 of file task.py.

References python.task.grassTask.params, gui_modules.histogram.HistFrame.params, gui_modules.gmodeler.ModelParamDialog.params, and gui_modules.psmap_dialogs.type.

Referenced by python.task.grassTask.set_param().

def python.task.grassTask.getCmd	(	self,
		ignoreErrors = `False`,
		ignoreRequired = `False`
	)

Produce an array of command name and arguments for feeding into some execve-like command processor.

Parameters:

ignoreErrors	True to return whatever has been built so far, even though it would not be a correct command for GRASS
ignoreRequired	True to ignore required flags, otherwise '<required>' is shown

Definition at line 194 of file task.py.

References python.task.grassTask.flags, python.task.grassTask.getCmdError(), @1.name, locale.name, _item_.name, ellps_list.name, _pad_.name, COLUMN.name, datum_list.name, table.name, paper.name, python.task.grassTask.name, fileinfo.name, gui_modules.render.Layer.name, gui_modules.gdialogs.DecorationDialog.name, gui_modules.gmodeler.PropertiesDialog.name, gui_modules.gmodeler.VariablePanel.name, python.task.grassTask.params, gui_modules.histogram.HistFrame.params, and gui_modules.gmodeler.ModelParamDialog.params.