Package bar :: Package rec :: Module pipeline :: Class barParam
[hide private]
[frames] | no frames]

Class barParam


VTK pipeline element parameter class.

Nested Classes [hide private]
Instance Methods [hide private]
 
__init__(self, name, args, **kwargs)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
 
__setArgs(self, val)
 
__getArgs(self)

Inherited from barPipelineXML: getXMLelement

Inherited from base.barObject: __str__, getElementById, writeXMLtoFile

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __subclasshook__

Class Methods [hide private]
cls
fromXML(cls, xmlElement)
Create the pipeline element parameter object based on sourceXMLElement.
Static Methods [hide private]
 
_getValue(valueNode)
Returns: the value of the valueNode parsed according to valueNode type attribute

Inherited from barPipelineXML (private): _getSingle, _getSingleNested

Inherited from base.barObject (private): _getAttributesDict

Class Variables [hide private]
[str, ...] _attributes = ['hidden', 'display']
a list of the related XML attributes
[str, ...] _singleelements = ['name', 'desc']
a list of the singular children XML elements' names
[str, ...] _listelements = ['args', 'span']
a list of the multiple children XML elements' names
str _elementName = 'param'
name of the XML element related to the class object.
dict _defaults = {'desc': None, 'display': False, 'hidden': False, ...
default values of object attributes
Instance Variables [hide private]
list args
the parameter value
list defaults
the backup of args
str name
the parameter name
type type
type of args items
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, name, args, **kwargs)
(Constructor)

 

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Parameters:
  • name (str) - name of the parameter
  • args ([Element, ...]) - DOM XML-encoded value of the parameter
  • kwargs - values of object attributes
Overrides: object.__init__

fromXML(cls, xmlElement)
Class Method

 

Create the pipeline element parameter object based on sourceXMLElement.

Parameters:
  • xmlElement (xml.dom.minidom.Element) - XML DOM element
Returns: cls
the pipeline element parameter object

_getValue(valueNode)
Static Method

 
Parameters:
  • valueNode (xml.dom.minidom.Element) - DOM XML element describing parameter value component
Returns:
the value of the valueNode parsed according to valueNode type attribute

Class Variable Details [hide private]

_defaults

default values of object attributes
Type:
dict
Value:
{'desc': None, 'display': False, 'hidden': False, 'span': None}

Instance Variable Details [hide private]

args

the parameter value
Get Method:
__getArgs(self)
Set Method:
__setArgs(self, val)