Reads eXtensible Data Model and Format files.
More...
#include <vtkXdmf3Reader.h>
Detailed Description
Reads eXtensible Data Model and Format files.
$Date$ $Revision$
vtkXdmf3Reader reads XDMF data files so that they can be visualized using VTK. The output data produced by this reader depends on the number of grids in the data file. If the data file has a single domain with a single grid, then the output type is a vtkDataSet subclass of the appropriate type, otherwise it's a vtkMultiBlockDataSet.
- Warning:
- Uses the XDMF API (http://www.xdmf.org)
- Tests:
- vtkXdmf3Reader (Tests)
Definition at line 43 of file vtkXdmf3Reader.h.
Member Typedef Documentation
Reimplemented from vtkDataReader.
Definition at line 47 of file vtkXdmf3Reader.h.
Constructor & Destructor Documentation
| vtkXdmf3Reader::vtkXdmf3Reader | ( | ) | [protected] |
| vtkXdmf3Reader::~vtkXdmf3Reader | ( | ) | [protected] |
Member Function Documentation
| static vtkXdmf3Reader* vtkXdmf3Reader::New | ( | ) | [static] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkDataReader.
| static int vtkXdmf3Reader::IsTypeOf | ( | const char * | name | ) | [static] |
Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkDataReader.
| virtual int vtkXdmf3Reader::IsA | ( | const char * | name | ) | [virtual] |
Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkDataReader.
| static vtkXdmf3Reader* vtkXdmf3Reader::SafeDownCast | ( | vtkObjectBase * | o | ) | [static] |
Reimplemented from vtkDataReader.
| virtual vtkObjectBase* vtkXdmf3Reader::NewInstanceInternal | ( | ) | const [protected, virtual] |
Reimplemented from vtkDataReader.
| vtkXdmf3Reader* vtkXdmf3Reader::NewInstance | ( | ) | const |
Reimplemented from vtkDataReader.
| void vtkXdmf3Reader::PrintSelf | ( | ostream & | os, |
| vtkIndent | indent | ||
| ) | [virtual] |
Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Reimplemented from vtkDataReader.
| virtual void vtkXdmf3Reader::SetFileName | ( | const char * | filename | ) | [virtual] |
Set tells the reader the name of a single top level xml file to read.
Reimplemented from vtkDataReader.
| virtual void vtkXdmf3Reader::AddFileName | ( | const char * | filename | ) | [virtual] |
Add and remove give the reader a list of top level xml files to read. Whether the set is treated as a spatial or temporal collection depends on FileSeriestAsTime.
| virtual void vtkXdmf3Reader::RemoveAllFileNames | ( | ) | [virtual] |
Add and remove give the reader a list of top level xml files to read. Whether the set is treated as a spatial or temporal collection depends on FileSeriestAsTime.
| virtual void vtkXdmf3Reader::SetFileSeriesAsTime | ( | bool | ) | [virtual] |
When true (the default) the reader treats a series of files as a temporal collection. When false it treats it as a spatial partition and uses an optimized top level paritioning strategy.
| virtual bool vtkXdmf3Reader::GetFileSeriesAsTime | ( | ) | [virtual] |
When true (the default) the reader treats a series of files as a temporal collection. When false it treats it as a spatial partition and uses an optimized top level paritioning strategy.
| virtual int vtkXdmf3Reader::CanReadFile | ( | const char * | filename | ) | [virtual] |
Determine if the file can be read with this reader.
Get information about point-based arrays. As is typical with readers this in only valid after the filename is set and UpdateInformation() has been called.
| const char* vtkXdmf3Reader::GetPointArrayName | ( | int | index | ) |
Returns the name of point array at the give index. Returns NULL if index is invalid.
| int vtkXdmf3Reader::GetPointArrayStatus | ( | const char * | name | ) |
Get/Set the point array status.
| void vtkXdmf3Reader::SetPointArrayStatus | ( | const char * | name, |
| int | status | ||
| ) |
Get/Set the point array status.
Get information about cell-based arrays. As is typical with readers this in only valid after the filename is set and UpdateInformation() has been called.
| const char* vtkXdmf3Reader::GetCellArrayName | ( | int | index | ) |
Get information about cell-based arrays. As is typical with readers this in only valid after the filename is set and UpdateInformation() has been called.
| void vtkXdmf3Reader::SetCellArrayStatus | ( | const char * | name, |
| int | status | ||
| ) |
Get information about cell-based arrays. As is typical with readers this in only valid after the filename is set and UpdateInformation() has been called.
| int vtkXdmf3Reader::GetCellArrayStatus | ( | const char * | name | ) |
Get information about cell-based arrays. As is typical with readers this in only valid after the filename is set and UpdateInformation() has been called.
Get information about unaligned arrays. As is typical with readers this in only valid after the filename is set and UpdateInformation() has been called.
| const char* vtkXdmf3Reader::GetFieldArrayName | ( | int | index | ) |
Get information about unaligned arrays. As is typical with readers this in only valid after the filename is set and UpdateInformation() has been called.
| void vtkXdmf3Reader::SetFieldArrayStatus | ( | const char * | name, |
| int | status | ||
| ) |
Get information about unaligned arrays. As is typical with readers this in only valid after the filename is set and UpdateInformation() has been called.
| int vtkXdmf3Reader::GetFieldArrayStatus | ( | const char * | name | ) |
Get information about unaligned arrays. As is typical with readers this in only valid after the filename is set and UpdateInformation() has been called.
Get/Set information about grids. As is typical with readers this is valid only after the filename as been set and UpdateInformation() has been called.
| const char* vtkXdmf3Reader::GetGridName | ( | int | index | ) |
Get/Set information about grids. As is typical with readers this is valid only after the filename as been set and UpdateInformation() has been called.
| void vtkXdmf3Reader::SetGridStatus | ( | const char * | gridname, |
| int | status | ||
| ) |
Get/Set information about grids. As is typical with readers this is valid only after the filename as been set and UpdateInformation() has been called.
| int vtkXdmf3Reader::GetGridStatus | ( | const char * | gridname | ) |
Get/Set information about grids. As is typical with readers this is valid only after the filename as been set and UpdateInformation() has been called.
Get/Set information about sets. As is typical with readers this is valid only after the filename as been set and UpdateInformation() has been called. Note that sets with non-zero Ghost value are not treated as sets that the user can select using this API.
| const char* vtkXdmf3Reader::GetSetName | ( | int | index | ) |
Get/Set information about sets. As is typical with readers this is valid only after the filename as been set and UpdateInformation() has been called. Note that sets with non-zero Ghost value are not treated as sets that the user can select using this API.
| void vtkXdmf3Reader::SetSetStatus | ( | const char * | gridname, |
| int | status | ||
| ) |
Get/Set information about sets. As is typical with readers this is valid only after the filename as been set and UpdateInformation() has been called. Note that sets with non-zero Ghost value are not treated as sets that the user can select using this API.
| int vtkXdmf3Reader::GetSetStatus | ( | const char * | gridname | ) |
Get/Set information about sets. As is typical with readers this is valid only after the filename as been set and UpdateInformation() has been called. Note that sets with non-zero Ghost value are not treated as sets that the user can select using this API.
| int vtkXdmf3Reader::GetNumberOfSetArrays | ( | ) | [inline] |
These methods are provided to make it easier to use the Sets in ParaView.
Definition at line 131 of file vtkXdmf3Reader.h.
| const char* vtkXdmf3Reader::GetSetArrayName | ( | int | index | ) | [inline] |
These methods are provided to make it easier to use the Sets in ParaView.
Definition at line 132 of file vtkXdmf3Reader.h.
| int vtkXdmf3Reader::GetSetArrayStatus | ( | const char * | name | ) | [inline] |
These methods are provided to make it easier to use the Sets in ParaView.
Definition at line 134 of file vtkXdmf3Reader.h.
| virtual vtkGraph* vtkXdmf3Reader::GetSIL | ( | ) | [virtual] |
SIL describes organization of/relationships between classifications eg. blocks/materials/hierarchies.
Every time the SIL is updated a this will return a different value.
| virtual int vtkXdmf3Reader::FillOutputPortInformation | ( | int | port, |
| vtkInformation * | info | ||
| ) | [protected, virtual] |
Fill the output port information objects for this algorithm. This is invoked by the first call to GetOutputPortInformation for each port so subclasses can specify what they can handle.
Reimplemented from vtkAlgorithm.
| virtual int vtkXdmf3Reader::ProcessRequest | ( | vtkInformation * | request, |
| vtkInformationVector ** | inInfo, | ||
| vtkInformationVector * | outInfo | ||
| ) | [protected, virtual] |
Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality. Upstream requests correspond to information flow from the algorithm's outputs to its inputs. Downstream requests correspond to information flow from the algorithm's inputs to its outputs. A downstream request is defined by the contents of the request information object. The input to the request is stored in the input information vector passed to ProcessRequest. The results of an downstream request are stored in the output information vector passed to ProcessRequest. An upstream request is defined by the contents of the request information object. The input to the request is stored in the output information vector passed to ProcessRequest. The results of an upstream request are stored in the input information vector passed to ProcessRequest. It returns the boolean status of the pipeline (false means failure).
Reimplemented from vtkDataReader.
| virtual int vtkXdmf3Reader::RequestDataObject | ( | vtkInformationVector * | ) | [protected, virtual] |
| virtual int vtkXdmf3Reader::RequestInformation | ( | vtkInformation * | , |
| vtkInformationVector ** | , | ||
| vtkInformationVector * | |||
| ) | [protected, virtual] |
Reimplemented from vtkDataReader.
| virtual int vtkXdmf3Reader::RequestData | ( | vtkInformation * | , |
| vtkInformationVector ** | , | ||
| vtkInformationVector * | |||
| ) | [protected, virtual] |
Reimplemented from vtkDataReader.
| vtkXdmf3ArraySelection* vtkXdmf3Reader::GetFieldArraySelection | ( | ) | [protected] |
| vtkXdmf3ArraySelection* vtkXdmf3Reader::GetCellArraySelection | ( | ) | [protected] |
| vtkXdmf3ArraySelection* vtkXdmf3Reader::GetPointArraySelection | ( | ) | [protected] |
| vtkXdmf3ArraySelection* vtkXdmf3Reader::GetGridsSelection | ( | ) | [protected] |
| vtkXdmf3ArraySelection* vtkXdmf3Reader::GetSetsSelection | ( | ) | [protected] |
Member Data Documentation
vtkXdmf3ArraySelection* vtkXdmf3Reader::FieldArraysCache [protected] |
Definition at line 174 of file vtkXdmf3Reader.h.
vtkXdmf3ArraySelection* vtkXdmf3Reader::CellArraysCache [protected] |
Definition at line 175 of file vtkXdmf3Reader.h.
vtkXdmf3ArraySelection* vtkXdmf3Reader::PointArraysCache [protected] |
Definition at line 176 of file vtkXdmf3Reader.h.
vtkXdmf3ArraySelection* vtkXdmf3Reader::GridsCache [protected] |
Definition at line 177 of file vtkXdmf3Reader.h.
vtkXdmf3ArraySelection* vtkXdmf3Reader::SetsCache [protected] |
Definition at line 178 of file vtkXdmf3Reader.h.
The documentation for this class was generated from the following file:
- /Users/kitware/Dashboards/MyTests/VTK_BLD_Release_docs/Utilities/Doxygen/dox/IO/Xdmf3/vtkXdmf3Reader.h
