Main Page

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.

Member Function Documentation

def iparameters::IParameters::__init__	(	self,
		attributeParameter
	)

Initializes the instance

def iparameters::IParameters::append	(	self,
		listName,
		value
	)

Appends a value to the named list

def iparameters::IParameters::nbValues	(	self,
		listName
	)

Returns a number of values in the named list

def iparameters::IParameters::getValues	(	self,
		listName
	)

Returns a list of values in the named list

def iparameters::IParameters::getLists

(

self

)

Returns a list of named lists' names

def iparameters::IParameters::setParameter	(	self,
		entry,
		parameterName,
		value
	)

Sets a value of the named parameter for the entry

def iparameters::IParameters::getParameter	(	self,
		entry,
		parameterName
	)

Returns a value of the named parameter for the entry

def iparameters::IParameters::getAllParameterNames	(	self,
		entry
	)

Returns all parameter names of the given entry

def iparameters::IParameters::getAllParameterValues	(	self,
		entry
	)

Returns all parameter values of the given entry

def iparameters::IParameters::getNbParameters	(	self,
		entry
	)

Returns a number of parameters of the entry

def iparameters::IParameters::setProperty	(	self,
		name,
		value
	)

Sets a property value

def iparameters::IParameters::getProperty	(	self,
		name
	)

Returns a value of the named property

def iparameters::IParameters::parseValue	(	self,
		value,
		separator,
		fromEnd
	)

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

def iparameters::IParameters::setDumpPython	(	self,
		isDumping
	)

Enables/Disables the dumping to Python

def iparameters::IParameters::isDumpPython

(

self

)

Returns whether there is the dumping to Python

iparameters::IParameters Class Reference

Public Member Functions

Detailed Description

Member Function Documentation


Public Member Functions
def	__init__
def	append
def	nbValues
def	getValues
def	getLists
def	setParameter
def	getParameter
def	getAllParameterNames
def	getAllParameterValues
def	getNbParameters
def	getEntries
def	setProperty
def	getProperty
def	getProperties
def	parseValue
def	setDumpPython
def	isDumpPython