KERNEL_PY.iparameters.IParameters Class Reference

Public Member Functions
def	__init__ (self, attributeParameter, clr=False)
def	clear (self)
def	append (self, listName, value)
def	nbValues (self, listName)
def	getValues (self, listName)
def	getLists (self)
def	setParameter (self, entry, parameterName, value)
def	getParameter (self, entry, parameterName)
def	getAllParameterNames (self, entry)
def	getAllParameterValues (self, entry)
def	getNbParameters (self, entry)
def	getEntries (self)
def	setProperty (self, name, value)
def	getProperty (self, name)
def	getProperties (self)
def	parseValue (self, value, separator, fromEnd)
def	setDumpPython (self, isDumping)
def	isDumpPython (self)

Private Attributes
	_ap

Detailed Description

Interface IParameters was designed to provide a common way to set up
named parameters. The interface is initialized by AttributeParameter that
is used as a container of stored data.
The interface supports 3 types of named parameters:
1. Named list - a named list consists of string values.
   One can append value to list (method 'append'), get a number of values
   in the list (method 'nbValues'), get all values of the given list
   (method 'getValues') and get names of all created named lists.
2. Parameters - that is a set of named string values associated with some named
   entity. Parameter consists of tree elements: entity name, a parameter name
   and a parameter value. Thus for one named entity there are an arbitrary number
   of pair 'name parameter : value'.
   One can add a new parameter to entry (method 'setParameter'), get a value of
   a given named parameter of the given entry (method 'getParameter'), get a number
   of parameters of the given entry (method 'getNbParameters'), get all names of
   parameters for the given entry (method 'getAllParameterNames'), get all
   values of parameters for the entry (method 'getAllParameterValues') and get all
   stored entries (method 'getEntries')
3. Property - a property has a name and a string value.
   One can set property (method 'setProperty'), getProperty (method 'getProperty') and
   get a list of all stored properties (method 'getProperties').

Note:   
      Methods not mentioned above are private and is not supposed to be used
      by module's developers.

Constructor & Destructor Documentation

__init__()

def KERNEL_PY.iparameters.IParameters.__init__	(		self,
			attributeParameter,
			clr = False
	)

Initializes the instance. If clr parameter is True, all IAPP attribute values are cleared.

Member Function Documentation

append()

def KERNEL_PY.iparameters.IParameters.append	(		self,
			listName,
			value
	)

Appends a value to the named list

References KERNEL_PY.iparameters.IParameters._ap, SALOMEDSImpl_IParameters._ap, SALOMEDS_IParameters.append(), SALOMEDSImpl_IParameters.append(), SALOMEDSClient_IParameters.append(), SALOMEGlobalVarHelper.List.append(), SalomeSDSClt.List.append(), SALOMEWrappedStdType.List.append(), and KERNEL_PY.iparameters.IParameters.append().

Referenced by KERNEL_PY.iparameters.IParameters.append(), KERNEL_PY.iparameters.IParameters.setParameter(), and KERNEL_PY.iparameters.IParameters.setProperty().

clear()

def KERNEL_PY.iparameters.IParameters.clear

(

self

)

Clear parameters

References KERNEL_PY.iparameters.IParameters._ap, and SALOMEDSImpl_IParameters._ap.

Referenced by KERNEL_PY.kernel.threadhelper.Runner.setArguments(), and KERNEL_PY.kernel.threadhelper.Runner.setFunction().

getAllParameterNames()

def KERNEL_PY.iparameters.IParameters.getAllParameterNames	(		self,
			entry
	)

Returns all parameter names of the given entry

References KERNEL_PY.iparameters.IParameters._ap, and SALOMEDSImpl_IParameters._ap.

getAllParameterValues()

def KERNEL_PY.iparameters.IParameters.getAllParameterValues	(		self,
			entry
	)

Returns all parameter values of the given entry

References KERNEL_PY.iparameters.IParameters._ap, and SALOMEDSImpl_IParameters._ap.

getEntries()

def KERNEL_PY.iparameters.IParameters.getEntries

(

self

)

Returns all entries

References KERNEL_PY.iparameters.IParameters._ap, and SALOMEDSImpl_IParameters._ap.

getLists()

def KERNEL_PY.iparameters.IParameters.getLists

(

self

)

Returns a list of named lists' names

References KERNEL_PY.iparameters.IParameters._ap, and SALOMEDSImpl_IParameters._ap.

getNbParameters()

def KERNEL_PY.iparameters.IParameters.getNbParameters	(		self,
			entry
	)

Returns a number of parameters of the entry

References KERNEL_PY.iparameters.IParameters._ap, and SALOMEDSImpl_IParameters._ap.

getParameter()

def KERNEL_PY.iparameters.IParameters.getParameter	(		self,
			entry,
			parameterName
	)

Returns a value of the named parameter for the entry

References KERNEL_PY.iparameters.IParameters._ap, and SALOMEDSImpl_IParameters._ap.

getProperties()

def KERNEL_PY.iparameters.IParameters.getProperties

(

self

)

Returns all propetries

References KERNEL_PY.iparameters.IParameters._ap, and SALOMEDSImpl_IParameters._ap.

getProperty()

def KERNEL_PY.iparameters.IParameters.getProperty	(		self,
			name
	)

Returns a value of the named property

References KERNEL_PY.iparameters.IParameters._ap, and SALOMEDSImpl_IParameters._ap.

getValues()

def KERNEL_PY.iparameters.IParameters.getValues	(		self,
			listName
	)

Returns a list of values in the named list

References KERNEL_PY.iparameters.IParameters._ap, and SALOMEDSImpl_IParameters._ap.

isDumpPython()

def KERNEL_PY.iparameters.IParameters.isDumpPython

(

self

)

Returns whether there is the dumping to Python

References KERNEL_PY.iparameters.IParameters._ap, and SALOMEDSImpl_IParameters._ap.

nbValues()

def KERNEL_PY.iparameters.IParameters.nbValues	(		self,
			listName
	)

Returns a number of values in the named list

References KERNEL_PY.iparameters.IParameters._ap, and SALOMEDSImpl_IParameters._ap.

parseValue()

def KERNEL_PY.iparameters.IParameters.parseValue	(		self,
			value,
			separator,
			fromEnd
	)

Breaks a value string in two parts which is divided by separator.

setDumpPython()

def KERNEL_PY.iparameters.IParameters.setDumpPython	(		self,
			isDumping
	)

Enables/Disables the dumping to Python

References KERNEL_PY.iparameters.IParameters._ap, and SALOMEDSImpl_IParameters._ap.

setParameter()

def KERNEL_PY.iparameters.IParameters.setParameter	(		self,
			entry,
			parameterName,
			value
	)

Sets a value of the named parameter for the entry

References KERNEL_PY.iparameters.IParameters._ap, SALOMEDSImpl_IParameters._ap, SALOMEDS_IParameters.append(), SALOMEDSImpl_IParameters.append(), SALOMEDSClient_IParameters.append(), SALOMEGlobalVarHelper.List.append(), SalomeSDSClt.List.append(), SALOMEWrappedStdType.List.append(), and KERNEL_PY.iparameters.IParameters.append().

setProperty()

def KERNEL_PY.iparameters.IParameters.setProperty	(		self,
			name,
			value
	)

Sets a property value

References KERNEL_PY.iparameters.IParameters._ap, SALOMEDSImpl_IParameters._ap, SALOMEDS_IParameters.append(), SALOMEDSImpl_IParameters.append(), SALOMEDSClient_IParameters.append(), SALOMEGlobalVarHelper.List.append(), SalomeSDSClt.List.append(), SALOMEWrappedStdType.List.append(), and KERNEL_PY.iparameters.IParameters.append().

Field Documentation

_ap

KERNEL_PY.iparameters.IParameters._ap

private

Referenced by KERNEL_PY.iparameters.IParameters.append(), KERNEL_PY.iparameters.IParameters.clear(), KERNEL_PY.iparameters.IParameters.getAllParameterNames(), KERNEL_PY.iparameters.IParameters.getAllParameterValues(), KERNEL_PY.iparameters.IParameters.getEntries(), KERNEL_PY.iparameters.IParameters.getLists(), KERNEL_PY.iparameters.IParameters.getNbParameters(), KERNEL_PY.iparameters.IParameters.getParameter(), KERNEL_PY.iparameters.IParameters.getProperties(), KERNEL_PY.iparameters.IParameters.getProperty(), KERNEL_PY.iparameters.IParameters.getValues(), KERNEL_PY.iparameters.IParameters.isDumpPython(), KERNEL_PY.iparameters.IParameters.nbValues(), KERNEL_PY.iparameters.IParameters.setDumpPython(), KERNEL_PY.iparameters.IParameters.setParameter(), and KERNEL_PY.iparameters.IParameters.setProperty().