Back to index

salome-paravis  6.5.0
Public Member Functions | Public Attributes
paravisSM.DataInformation Class Reference

List of all members.

Public Member Functions

def __init__
def Update
def GetDataSetType
def GetDataSetTypeAsString
def __getattr__

Public Attributes

 DataInformation
 Proxy
 Idx

Detailed Description

DataInformation is a contained for meta-data associated with an
output data.

DataInformation is a python wrapper around a vtkPVDataInformation.
In addition to proving all methods of a vtkPVDataInformation, it provides
a few convenience methods.

Please note that some of the methods accessible through the DataInformation
class are not listed by help() because the DataInformation objects forward
unresolved attributes to the underlying object. To get the full list,
see also dir(proxy.DataInformation).
See also the doxygen based documentation of the vtkPVDataInformation C++
class.

Definition at line 1244 of file paravisSM.py.


Constructor & Destructor Documentation

def paravisSM.DataInformation.__init__ (   self,
  dataInformation,
  proxy,
  idx 
)
Default constructor. Requires a vtkPVDataInformation, a source proxy
and an output port id.

Definition at line 1259 of file paravisSM.py.

01259 
01260     def __init__(self, dataInformation, proxy, idx):
01261         """Default constructor. Requires a vtkPVDataInformation, a source proxy
01262         and an output port id."""
01263         self.DataInformation = dataInformation
01264         self.Proxy = proxy
01265         self.Idx = idx


Member Function Documentation

def paravisSM.DataInformation.__getattr__ (   self,
  name 
)
Forwards unknown attribute requests to the underlying
vtkPVInformation.

Definition at line 1290 of file paravisSM.py.

01290 
01291     def __getattr__(self, name):
01292         """Forwards unknown attribute requests to the underlying
01293         vtkPVInformation."""
01294         if not self.DataInformation:
01295             raise AttributeError("class has no attribute %s" % name)
01296             return None
01297         self.Update()
01298         return getattr(self.DataInformation, name)

Here is the call graph for this function:

Returns the dataset type as defined in vtkDataObjectTypes.

Definition at line 1276 of file paravisSM.py.

01276 
01277     def GetDataSetType(self):
01278         """Returns the dataset type as defined in vtkDataObjectTypes."""
01279         self.Update()
01280         if not self.DataInformation:
01281             raise RuntimeError, "No data information is available"
01282         if self.DataInformation.GetCompositeDataSetType() > -1:
01283             return self.DataInformation.GetCompositeDataSetType()
01284         return self.DataInformation.GetDataSetType()

Here is the call graph for this function:

Here is the caller graph for this function:

Returns the dataset type as a user-friendly string. This is
not the same as the enumaration used by VTK

Definition at line 1285 of file paravisSM.py.

01285 
01286     def GetDataSetTypeAsString(self):
01287         """Returns the dataset type as a user-friendly string. This is
01288         not the same as the enumaration used by VTK"""
01289         return vtk.vtkDataObjectTypes.GetClassNameFromTypeId(self.GetDataSetType())

Here is the call graph for this function:

****Deprecated**** There is no reason anymore to use this method
explicitly, it is called automatically when one gets any value from the
data information object.
Update the data information if necessary. Note that this
does not cause execution of the underlying object. In certain
cases, you may have to call UpdatePipeline() on the proxy.

Definition at line 1266 of file paravisSM.py.

01266 
01267     def Update(self):
01268         """****Deprecated**** There is no reason anymore to use this method
01269         explicitly, it is called automatically when one gets any value from the
01270         data information object.
01271         Update the data information if necessary. Note that this
01272         does not cause execution of the underlying object. In certain
01273         cases, you may have to call UpdatePipeline() on the proxy."""
01274         if self.Proxy:
01275             self.Proxy.GetDataInformation(self.Idx)

Here is the caller graph for this function:


Member Data Documentation

Definition at line 1262 of file paravisSM.py.

Definition at line 1264 of file paravisSM.py.

Definition at line 1263 of file paravisSM.py.


The documentation for this class was generated from the following file: