Home       Trees       Indices       Help   
Package bar :: Package rec :: Module pipeline :: Class barPipeElem
[hide private]
[frames] | no frames]

Class barPipeElem

VTK pipeline element class.

Nested Classes [hide private]

Inherited from base.barObject (private): _clsBoundingBox, _clsBregmaMetadataElement, _clsCommentLabel, _clsGenericStructure, _clsMetadataElement, _clsPath, _clsRegularLabel, _clsSpotLabel, _clsStructureLabel, _clsTransfMatrixMetadataElement

Instance Methods [hide private]
 
__init__(self, vtkclass, **kwargs)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
 
__call__(self)
Returns: VTK pipeline element
 
__getOutputDataType(self)
 
__setOutputDataType(self, newValue)
 
set(self, on, show=True)
Set the element activity and visibility.
 
__setCls(self, val)
unicode
__getCls(self)
Returns: name of the self.cls

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, sourceXMLElement)
Create the pipeline element based on sourceXMLElement.
Static Methods [hide private]

Inherited from barPipelineXML (private): _getSingle, _getSingleNested

Inherited from base.barObject (private): _getAttributesDict

Class Variables [hide private]
dict _defaults = {'desc': None, 'disable': False, 'displayable': Tr...
default values of object attributes
[str, ...] _attributes = ['on', 'displayable', 'disable']
a list of the related XML attributes
[str, ...] _singleelements = ['vtkclass', 'desc']
a list of the singular children XML elements' names
[str, ...] _listelements = ['params']
a list of the multiple children XML elements' names
str _elementName = 'pipelineelement'
name of the XML element related to the class object.
Instance Variables [hide private]
type cls
the VTK pipeline element class
Properties [hide private]
unicode vtkclass
  outputDataType

Inherited from object: __class__

Method Details [hide private]

__init__(self, vtkclass, **kwargs)
(Constructor)

 

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

Parameters:
  • vtkclass (str) - name of the VTK pipeline element class
  • kwargs - values of object attributes
Overrides: object.__init__

__call__(self)
(Call operator)

 
Returns:
VTK pipeline element

set(self, on, show=True)

 

Set the element activity and visibility.

Parameters:
  • on (bool) - indicates if the element is turned on
  • show (bool) - indicates if the element is visible

fromXML(cls, sourceXMLElement)
Class Method

 

Create the pipeline element based on sourceXMLElement.

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

__setCls(self, val)

 
Parameters:

__getCls(self)

 
Returns: unicode
name of the self.cls

Class Variable Details [hide private]

_defaults

default values of object attributes
Type:
dict
Value:
{'desc': None,
 'disable': False,
 'displayable': True,
 'on': False,
 'params': []}

Property Details [hide private]

vtkclass

Get Method:
__getCls(self) - Returns: name of the self.cls
Set Method:
__setCls(self, val)
Type:
unicode

outputDataType

Get Method:
__getOutputDataType(self)
Set Method:
__setOutputDataType(self, newValue)

   Home       Trees       Indices       Help   
Generated by Epydoc 3.0.1 on Wed Mar 20 14:31:40 2013 http://epydoc.sourceforge.net