Trees       Indices       Help   
diffpy.srrietveld
Package diffpy :: Package srrietveld :: Module objectinfo :: Class ObjectInfo
[frames] | no frames]

Class ObjectInfo

source code

ObjectInfo uses the info in the engine definition to define what is allowed to be set in an object, namely the legal content of an object.

Instance Methods
 
__init__(self, cls=None)
Initialization.		 source code
 
get(self, paramname)
Get the full info of a parameter.		 source code
 
getDescription(self, paramname)
Get the description of a parameter.		 source code
 
listParams(self)
List all the parameters that can be refined by the engine.		 source code
Method Details

__init__(self, cls=None)
(Constructor)

source code 

Initialization.

Parameters:
  • cls (an engine class) - the class of the engine fit object
Returns:
no value

get(self, paramname)

source code 

Get the full info of a parameter.

Parameters:
  • paramname (string) - parameter name
Returns:
an Info object defined in the engine.

getDescription(self, paramname)

source code 

Get the description of a parameter.

Parameters:
  • paramname (string) - parameter name
Returns:
a string to describe the parameter

listParams(self)

source code 

List all the parameters that can be refined by the engine.

Returns:
a list of refinable parameter names

   Trees       Indices       Help   
diffpy.srrietveld
Generated by Epydoc 3.0.1 on Sun Aug 28 23:35:57 2011 http://epydoc.sourceforge.net