ConfigToolBase.ConfigToolBase Class Reference

Inheritance diagram for ConfigToolBase.ConfigToolBase:

Public Member Functions
def	__call__
def	__copy__
	copy(self) returns a copy of the tool More...
def	__init__
def	addParameter
	use addParameter method in the redefinition of tool constructor in order to add parameters to the tools each tool is defined by its label, default value, description, type and allowedValues (the last two attribute can be ignored if the user gives a valid default values and if there is not a list of allowed values) More...
def	apply
def	comment
def	description
def	dumpPython
def	errorMessage
def	getAllowedValues
def	getParameters
def	getvalue
def	isAllowed
	method isAllowed is called by setParameter to check input values for a specific parameter More...
def	reset
def	setComment
def	setParameter
def	setParameters
def	toolCode
def	typeError
	check about input value type More...

Public Attributes
	parAccepted

Private Attributes
	_comment
	_description
	_parameters
	_path

Static Private Attributes
string	_defaultValue = "No default value. Set parameter value."
string	_label = "ConfigToolBase"
string	_path = ""

Detailed Description

Base class for PAT tools

Definition at line 33 of file ConfigToolBase.py.

Constructor & Destructor Documentation

def ConfigToolBase.ConfigToolBase.__init__

(

self

)

Definition at line 40 of file ConfigToolBase.py.

Member Function Documentation

def ConfigToolBase.ConfigToolBase.__call__	(		self,
			process
	)

Call the instance 

Definition at line 54 of file ConfigToolBase.py.

def ConfigToolBase.ConfigToolBase.__copy__

(

self

)

copy(self) returns a copy of the tool

Definition at line 83 of file ConfigToolBase.py.

def ConfigToolBase.ConfigToolBase.addParameter	(		self,
			dict,
			parname,
			parvalue,
			description,
			Type = None,
			allowedValues = None,
			acceptNoneValue = False
	)

use addParameter method in the redefinition of tool constructor in order to add parameters to the tools each tool is defined by its label, default value, description, type and allowedValues (the last two attribute can be ignored if the user gives a valid default values and if there is not a list of allowed values)

Add a parameter with its label, value, description and type to self._parameters

Definition at line 102 of file ConfigToolBase.py.

Referenced by editorTools.UserCodeTool.__init__(), metTools.AddMETCollection.__init__(), and editorTools.ChangeSource.__init__().

def ConfigToolBase.ConfigToolBase.apply	(		self,
			process
	)

Definition at line 59 of file ConfigToolBase.py.

Referenced by editorTools.UserCodeTool.__call__(), metTools.AddMETCollection.__call__(), and editorTools.ChangeSource.__call__().

def ConfigToolBase.ConfigToolBase.comment

(

self

)

Return the comment set for this tool

Definition at line 157 of file ConfigToolBase.py.

def ConfigToolBase.ConfigToolBase.description

(

self

)

Return a string with a detailed description of the action.

Definition at line 94 of file ConfigToolBase.py.

def ConfigToolBase.ConfigToolBase.dumpPython

(

self

)

Return the python code to perform the action

Definition at line 134 of file ConfigToolBase.py.

def ConfigToolBase.ConfigToolBase.errorMessage	(		self,
			value,
			type
	)

Definition at line 161 of file ConfigToolBase.py.

def ConfigToolBase.ConfigToolBase.getAllowedValues	(		self,
			name
	)

Definition at line 192 of file ConfigToolBase.py.

def ConfigToolBase.ConfigToolBase.getParameters

(

self

)

Return a copy of the dict of the parameters.

Definition at line 115 of file ConfigToolBase.py.

def ConfigToolBase.ConfigToolBase.getvalue	(		self,
			name
	)

Return the value of parameter 'name'

Definition at line 90 of file ConfigToolBase.py.

def ConfigToolBase.ConfigToolBase.isAllowed	(		self,
			name,
			value
	)

method isAllowed is called by setParameter to check input values for a specific parameter

Definition at line 164 of file ConfigToolBase.py.

def ConfigToolBase.ConfigToolBase.reset

(

self

)

Definition at line 88 of file ConfigToolBase.py.

def ConfigToolBase.ConfigToolBase.setComment	(		self,
			comment
	)

Write a comment in the configuration file

Definition at line 153 of file ConfigToolBase.py.

def ConfigToolBase.ConfigToolBase.setParameter	(		self,
			name,
			value,
			typeNone = False
	)

Change parameter 'name' to a new value

Definition at line 119 of file ConfigToolBase.py.

Referenced by editorTools.UserCodeTool.__call__(), metTools.AddMETCollection.__call__(), and editorTools.ChangeSource.__call__().

def ConfigToolBase.ConfigToolBase.setParameters	(		self,
			parameters
	)

Definition at line 127 of file ConfigToolBase.py.

def ConfigToolBase.ConfigToolBase.toolCode	(		self,
			process
	)

Definition at line 78 of file ConfigToolBase.py.

def ConfigToolBase.ConfigToolBase.typeError	(		self,
			name
	)

check about input value type

Definition at line 185 of file ConfigToolBase.py.

Member Data Documentation

ConfigToolBase.ConfigToolBase._comment

private

Definition at line 43 of file ConfigToolBase.py.

Referenced by editorTools.UserCodeTool.dumpPython().

string ConfigToolBase.ConfigToolBase._defaultValue = "No default value. Set parameter value."

staticprivate

Definition at line 38 of file ConfigToolBase.py.

Referenced by metTools.AddMETCollection.__init__().

ConfigToolBase.ConfigToolBase._description

private

Definition at line 42 of file ConfigToolBase.py.

Referenced by Vispa.Main.Filetype.Filetype.description(), and Vispa.Main.Filetype.Filetype.fileDialogFilter().

string ConfigToolBase.ConfigToolBase._label = "ConfigToolBase"

staticprivate

Definition at line 37 of file ConfigToolBase.py.

ConfigToolBase.ConfigToolBase._parameters

private

Definition at line 41 of file ConfigToolBase.py.

Referenced by editorTools.UserCodeTool.dumpPython(), editorTools.UserCodeTool.toolCode(), metTools.AddMETCollection.toolCode(), and editorTools.ChangeSource.toolCode().

string ConfigToolBase.ConfigToolBase._path = ""

staticprivate

Definition at line 39 of file ConfigToolBase.py.

ConfigToolBase.ConfigToolBase._path

private

Definition at line 46 of file ConfigToolBase.py.

ConfigToolBase.ConfigToolBase.parAccepted

Definition at line 44 of file ConfigToolBase.py.