vtkXMLStructuredDataWriter Class Reference
#include <vtkXMLStructuredDataWriter.h>
Detailed Description
Superclass for VTK XML structured data writers.vtkXMLStructuredDataWriter provides VTK XML writing functionality that is common among all the structured data formats.
Definition at line 32 of file vtkXMLStructuredDataWriter.h.
Public Types | |
| typedef vtkXMLWriter | Superclass |
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| virtual void | SetNumberOfPieces (int) |
| virtual int | GetNumberOfPieces () |
| virtual void | SetWriteExtent (int, int, int, int, int, int) |
| virtual void | SetWriteExtent (int[6]) |
| virtual int * | GetWriteExtent () |
| virtual void | GetWriteExtent (int &, int &, int &, int &, int &, int &) |
| virtual void | GetWriteExtent (int[6]) |
| virtual void | SetExtentTranslator (vtkExtentTranslator *) |
| virtual vtkExtentTranslator * | GetExtentTranslator () |
Static Public Member Functions | |
| static int | IsTypeOf (const char *type) |
| static vtkXMLStructuredDataWriter * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
| vtkXMLStructuredDataWriter () | |
| ~vtkXMLStructuredDataWriter () | |
| virtual void | WritePrimaryElementAttributes (ostream &os, vtkIndent indent) |
| virtual void | WriteAppendedPiece (int index, vtkIndent indent) |
| virtual void | WriteAppendedPieceData (int index) |
| virtual void | WriteInlinePiece (vtkIndent indent) |
| virtual void | GetInputExtent (int *extent)=0 |
| virtual int | WriteHeader () |
| virtual int | WriteAPiece () |
| virtual int | WriteFooter () |
| virtual void | AllocatePositionArrays () |
| virtual void | DeletePositionArrays () |
| void | SetupExtentTranslator () |
| vtkAbstractArray * | CreateExactExtent (vtkAbstractArray *array, int *inExtent, int *outExtent, int isPoint) |
| virtual int | WriteInlineMode (vtkIndent indent) |
| vtkIdType | GetStartTuple (int *extent, vtkIdType *increments, int i, int j, int k) |
| void | CalculatePieceFractions (float *fractions) |
| virtual vtkAbstractArray * | CreateArrayForPoints (vtkAbstractArray *inArray) |
| virtual vtkAbstractArray * | CreateArrayForCells (vtkAbstractArray *inArray) |
| void | SetInputUpdateExtent (int piece) |
| int | ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) |
| virtual void | SetInternalWriteExtent (int, int, int, int, int, int) |
| virtual void | SetInternalWriteExtent (int[6]) |
Protected Attributes | |
| int | WriteExtent [6] |
| int | InternalWriteExtent [6] |
| int | NumberOfPieces |
| vtkExtentTranslator * | ExtentTranslator |
| float * | ProgressFractions |
| int | CurrentPiece |
| OffsetsManagerArray * | PointDataOM |
| OffsetsManagerArray * | CellDataOM |
Member Typedef Documentation
Reimplemented from vtkXMLWriter.
Reimplemented in vtkXMLImageDataWriter, vtkXMLRectilinearGridWriter, and vtkXMLStructuredGridWriter.
Definition at line 35 of file vtkXMLStructuredDataWriter.h.
Constructor & Destructor Documentation
| vtkXMLStructuredDataWriter::vtkXMLStructuredDataWriter | ( | ) | [protected] |
| vtkXMLStructuredDataWriter::~vtkXMLStructuredDataWriter | ( | ) | [protected] |
Member Function Documentation
| virtual const char* vtkXMLStructuredDataWriter::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkXMLWriter.
Reimplemented in vtkXMLImageDataWriter, vtkXMLRectilinearGridWriter, and vtkXMLStructuredGridWriter.
| static int vtkXMLStructuredDataWriter::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 vtkXMLWriter.
Reimplemented in vtkXMLImageDataWriter, vtkXMLRectilinearGridWriter, and vtkXMLStructuredGridWriter.
| virtual int vtkXMLStructuredDataWriter::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 vtkXMLWriter.
Reimplemented in vtkXMLImageDataWriter, vtkXMLRectilinearGridWriter, and vtkXMLStructuredGridWriter.
| static vtkXMLStructuredDataWriter* vtkXMLStructuredDataWriter::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkXMLWriter.
Reimplemented in vtkXMLImageDataWriter, vtkXMLRectilinearGridWriter, and vtkXMLStructuredGridWriter.
| void vtkXMLStructuredDataWriter::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 vtkXMLWriter.
Reimplemented in vtkXMLImageDataWriter, vtkXMLRectilinearGridWriter, and vtkXMLStructuredGridWriter.
| virtual void vtkXMLStructuredDataWriter::SetNumberOfPieces | ( | int | ) | [virtual] |
Get/Set the number of pieces used to stream the image through the pipeline while writing to the file.
| virtual int vtkXMLStructuredDataWriter::GetNumberOfPieces | ( | ) | [virtual] |
Get/Set the number of pieces used to stream the image through the pipeline while writing to the file.
| virtual void vtkXMLStructuredDataWriter::SetWriteExtent | ( | int | , | |
| int | , | |||
| int | , | |||
| int | , | |||
| int | , | |||
| int | ||||
| ) | [virtual] |
Get/Set the extent of the input that should be treated as the WholeExtent in the output file. The default is the WholeExtent of the input.
| virtual void vtkXMLStructuredDataWriter::SetWriteExtent | ( | int | [6] | ) | [virtual] |
Get/Set the extent of the input that should be treated as the WholeExtent in the output file. The default is the WholeExtent of the input.
| virtual int* vtkXMLStructuredDataWriter::GetWriteExtent | ( | ) | [virtual] |
Get/Set the extent of the input that should be treated as the WholeExtent in the output file. The default is the WholeExtent of the input.
| virtual void vtkXMLStructuredDataWriter::GetWriteExtent | ( | int & | , | |
| int & | , | |||
| int & | , | |||
| int & | , | |||
| int & | , | |||
| int & | ||||
| ) | [virtual] |
Get/Set the extent of the input that should be treated as the WholeExtent in the output file. The default is the WholeExtent of the input.
| virtual void vtkXMLStructuredDataWriter::GetWriteExtent | ( | int | [6] | ) | [virtual] |
Get/Set the extent of the input that should be treated as the WholeExtent in the output file. The default is the WholeExtent of the input.
| virtual void vtkXMLStructuredDataWriter::SetExtentTranslator | ( | vtkExtentTranslator * | ) | [virtual] |
Get/Set the extent translator used for streaming.
| virtual vtkExtentTranslator* vtkXMLStructuredDataWriter::GetExtentTranslator | ( | ) | [virtual] |
Get/Set the extent translator used for streaming.
| virtual void vtkXMLStructuredDataWriter::WritePrimaryElementAttributes | ( | ostream & | os, | |
| vtkIndent | indent | |||
| ) | [protected, virtual] |
| virtual void vtkXMLStructuredDataWriter::WriteAppendedPiece | ( | int | index, | |
| vtkIndent | indent | |||
| ) | [protected, virtual] |
Reimplemented in vtkXMLRectilinearGridWriter, and vtkXMLStructuredGridWriter.
| virtual void vtkXMLStructuredDataWriter::WriteAppendedPieceData | ( | int | index | ) | [protected, virtual] |
Reimplemented in vtkXMLRectilinearGridWriter, and vtkXMLStructuredGridWriter.
| virtual void vtkXMLStructuredDataWriter::WriteInlinePiece | ( | vtkIndent | indent | ) | [protected, virtual] |
Reimplemented in vtkXMLRectilinearGridWriter, and vtkXMLStructuredGridWriter.
| virtual void vtkXMLStructuredDataWriter::GetInputExtent | ( | int * | extent | ) | [protected, pure virtual] |
Implemented in vtkXMLImageDataWriter, vtkXMLRectilinearGridWriter, and vtkXMLStructuredGridWriter.
| virtual int vtkXMLStructuredDataWriter::WriteHeader | ( | ) | [protected, virtual] |
| virtual int vtkXMLStructuredDataWriter::WriteAPiece | ( | ) | [protected, virtual] |
| virtual int vtkXMLStructuredDataWriter::WriteFooter | ( | ) | [protected, virtual] |
| virtual void vtkXMLStructuredDataWriter::AllocatePositionArrays | ( | ) | [protected, virtual] |
Reimplemented in vtkXMLRectilinearGridWriter, and vtkXMLStructuredGridWriter.
| virtual void vtkXMLStructuredDataWriter::DeletePositionArrays | ( | ) | [protected, virtual] |
Reimplemented in vtkXMLRectilinearGridWriter, and vtkXMLStructuredGridWriter.
| void vtkXMLStructuredDataWriter::SetupExtentTranslator | ( | ) | [protected] |
| vtkAbstractArray* vtkXMLStructuredDataWriter::CreateExactExtent | ( | vtkAbstractArray * | array, | |
| int * | inExtent, | |||
| int * | outExtent, | |||
| int | isPoint | |||
| ) | [protected] |
| virtual int vtkXMLStructuredDataWriter::WriteInlineMode | ( | vtkIndent | indent | ) | [protected, virtual] |
| vtkIdType vtkXMLStructuredDataWriter::GetStartTuple | ( | int * | extent, | |
| vtkIdType * | increments, | |||
| int | i, | |||
| int | j, | |||
| int | k | |||
| ) | [protected] |
| void vtkXMLStructuredDataWriter::CalculatePieceFractions | ( | float * | fractions | ) | [protected] |
| virtual vtkAbstractArray* vtkXMLStructuredDataWriter::CreateArrayForPoints | ( | vtkAbstractArray * | inArray | ) | [protected, virtual] |
Reimplemented from vtkXMLWriter.
| virtual vtkAbstractArray* vtkXMLStructuredDataWriter::CreateArrayForCells | ( | vtkAbstractArray * | inArray | ) | [protected, virtual] |
Reimplemented from vtkXMLWriter.
| void vtkXMLStructuredDataWriter::SetInputUpdateExtent | ( | int | piece | ) | [protected] |
| int vtkXMLStructuredDataWriter::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 vtkXMLWriter.
| virtual void vtkXMLStructuredDataWriter::SetInternalWriteExtent | ( | int | , | |
| int | , | |||
| int | , | |||
| int | , | |||
| int | , | |||
| int | ||||
| ) | [protected, virtual] |
| virtual void vtkXMLStructuredDataWriter::SetInternalWriteExtent | ( | int | [6] | ) | [protected, virtual] |
Member Data Documentation
int vtkXMLStructuredDataWriter::WriteExtent[6] [protected] |
Definition at line 94 of file vtkXMLStructuredDataWriter.h.
int vtkXMLStructuredDataWriter::InternalWriteExtent[6] [protected] |
Definition at line 100 of file vtkXMLStructuredDataWriter.h.
int vtkXMLStructuredDataWriter::NumberOfPieces [protected] |
Definition at line 103 of file vtkXMLStructuredDataWriter.h.
Definition at line 106 of file vtkXMLStructuredDataWriter.h.
float* vtkXMLStructuredDataWriter::ProgressFractions [protected] |
Definition at line 108 of file vtkXMLStructuredDataWriter.h.
int vtkXMLStructuredDataWriter::CurrentPiece [protected] |
Definition at line 110 of file vtkXMLStructuredDataWriter.h.
Definition at line 114 of file vtkXMLStructuredDataWriter.h.
Definition at line 115 of file vtkXMLStructuredDataWriter.h.
The documentation for this class was generated from the following file:
- dox/IO/vtkXMLStructuredDataWriter.h
