VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes
vtkXMLPDataWriter Class Reference

Write data in a parallel XML format. More...

#include <vtkXMLPDataWriter.h>

Inheritance diagram for vtkXMLPDataWriter:
Inheritance graph
[legend]
Collaboration diagram for vtkXMLPDataWriter:
Collaboration graph
[legend]

List of all members.

Public Types

typedef vtkXMLWriter Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkXMLPDataWriterNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetNumberOfPieces (int)
virtual int GetNumberOfPieces ()
virtual void SetStartPiece (int)
virtual int GetStartPiece ()
virtual void SetEndPiece (int)
virtual int GetEndPiece ()
virtual void SetGhostLevel (int)
virtual int GetGhostLevel ()
virtual void SetWriteSummaryFile (int flag)
virtual int GetWriteSummaryFile ()
virtual void WriteSummaryFileOn ()
virtual void WriteSummaryFileOff ()
virtual void SetController (vtkMultiProcessController *)
virtual vtkMultiProcessControllerGetController ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkXMLPDataWriterSafeDownCast (vtkObjectBase *o)

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkXMLPDataWriter ()
 ~vtkXMLPDataWriter ()
virtual int WriteInternal ()
virtual vtkXMLWriterCreatePieceWriter (int index)=0
virtual void WritePrimaryElementAttributes (ostream &os, vtkIndent indent)
int WriteData ()
virtual void WritePData (vtkIndent indent)
virtual void WritePPieceAttributes (int index)
char * CreatePieceFileName (int index, const char *path=0)
void SplitFileName ()
virtual int WritePieces ()
virtual int WritePiece (int index)
virtual void ProgressCallback (vtkAlgorithm *w)

Static Protected Member Functions

static void ProgressCallbackFunction (vtkObject *, unsigned long, void *, void *)

Protected Attributes

int StartPiece
int EndPiece
int NumberOfPieces
int GhostLevel
int WriteSummaryFile
char * PathName
char * FileNameBase
char * FileNameExtension
char * PieceFileNameExtension
vtkCallbackCommandProgressObserver
vtkMultiProcessControllerController

Detailed Description

Write data in a parallel XML format.

vtkXMLPDataWriter is the superclass for all XML parallel data set writers. It provides functionality needed for writing parallel formats, such as the selection of which writer writes the summary file and what range of pieces are assigned to each serial writer.

Definition at line 33 of file vtkXMLPDataWriter.h.


Member Typedef Documentation


Constructor & Destructor Documentation


Member Function Documentation

static int vtkXMLPDataWriter::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 vtkXMLPRectilinearGridWriter, vtkXMLPStructuredGridWriter, vtkXMLPUnstructuredGridWriter, vtkXMLPImageDataWriter, vtkXMLPDataSetWriter, vtkXMLPPolyDataWriter, vtkXMLPStructuredDataWriter, and vtkXMLPUnstructuredDataWriter.

virtual int vtkXMLPDataWriter::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 vtkXMLPRectilinearGridWriter, vtkXMLPStructuredGridWriter, vtkXMLPUnstructuredGridWriter, vtkXMLPImageDataWriter, vtkXMLPDataSetWriter, vtkXMLPPolyDataWriter, vtkXMLPStructuredDataWriter, and vtkXMLPUnstructuredDataWriter.

virtual vtkObjectBase* vtkXMLPDataWriter::NewInstanceInternal ( ) const [protected, virtual]
void vtkXMLPDataWriter::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 vtkXMLPRectilinearGridWriter, vtkXMLPStructuredGridWriter, vtkXMLPUnstructuredGridWriter, vtkXMLPImageDataWriter, vtkXMLPDataSetWriter, vtkXMLPPolyDataWriter, vtkXMLPStructuredDataWriter, and vtkXMLPUnstructuredDataWriter.

virtual void vtkXMLPDataWriter::SetNumberOfPieces ( int  ) [virtual]

Get/Set the number of pieces that are being written in parallel.

Get/Set the number of pieces that are being written in parallel.

virtual void vtkXMLPDataWriter::SetStartPiece ( int  ) [virtual]

Get/Set the range of pieces assigned to this writer.

virtual int vtkXMLPDataWriter::GetStartPiece ( ) [virtual]

Get/Set the range of pieces assigned to this writer.

virtual void vtkXMLPDataWriter::SetEndPiece ( int  ) [virtual]

Get/Set the range of pieces assigned to this writer.

virtual int vtkXMLPDataWriter::GetEndPiece ( ) [virtual]

Get/Set the range of pieces assigned to this writer.

virtual void vtkXMLPDataWriter::SetGhostLevel ( int  ) [virtual]

Get/Set the ghost level used for this writer's piece.

virtual int vtkXMLPDataWriter::GetGhostLevel ( ) [virtual]

Get/Set the ghost level used for this writer's piece.

virtual void vtkXMLPDataWriter::SetWriteSummaryFile ( int  flag) [virtual]

Get/Set whether the writer should write the summary file that refers to all of the pieces' individual files. This is on by default. Note that only the first process writes the summary file.

Get/Set whether the writer should write the summary file that refers to all of the pieces' individual files. This is on by default. Note that only the first process writes the summary file.

virtual void vtkXMLPDataWriter::WriteSummaryFileOn ( ) [virtual]

Get/Set whether the writer should write the summary file that refers to all of the pieces' individual files. This is on by default. Note that only the first process writes the summary file.

virtual void vtkXMLPDataWriter::WriteSummaryFileOff ( ) [virtual]

Get/Set whether the writer should write the summary file that refers to all of the pieces' individual files. This is on by default. Note that only the first process writes the summary file.

Controller used to communicate data type of blocks. By default, the global controller is used. If you want another controller to be used, set it with this.

Controller used to communicate data type of blocks. By default, the global controller is used. If you want another controller to be used, set it with this.

virtual int vtkXMLPDataWriter::WriteInternal ( ) [protected, virtual]

Reimplemented from vtkXMLWriter.

Reimplemented in vtkXMLPDataSetWriter, and vtkXMLPStructuredDataWriter.

virtual vtkXMLWriter* vtkXMLPDataWriter::CreatePieceWriter ( int  index) [protected, pure virtual]
virtual void vtkXMLPDataWriter::WritePrimaryElementAttributes ( ostream &  os,
vtkIndent  indent 
) [protected, virtual]

Reimplemented from vtkXMLWriter.

Reimplemented in vtkXMLPImageDataWriter, and vtkXMLPStructuredDataWriter.

int vtkXMLPDataWriter::WriteData ( ) [protected, virtual]

Reimplemented from vtkXMLWriter.

virtual void vtkXMLPDataWriter::WritePData ( vtkIndent  indent) [protected, virtual]
virtual void vtkXMLPDataWriter::WritePPieceAttributes ( int  index) [protected, virtual]

Reimplemented in vtkXMLPStructuredDataWriter.

char* vtkXMLPDataWriter::CreatePieceFileName ( int  index,
const char *  path = 0 
) [protected]
void vtkXMLPDataWriter::SplitFileName ( ) [protected]
virtual int vtkXMLPDataWriter::WritePieces ( ) [protected, virtual]

Reimplemented in vtkXMLPStructuredDataWriter.

virtual int vtkXMLPDataWriter::WritePiece ( int  index) [protected, virtual]

Reimplemented in vtkXMLPStructuredDataWriter.

static void vtkXMLPDataWriter::ProgressCallbackFunction ( vtkObject ,
unsigned  long,
void *  ,
void *   
) [static, protected]
virtual void vtkXMLPDataWriter::ProgressCallback ( vtkAlgorithm w) [protected, virtual]

Member Data Documentation

Definition at line 101 of file vtkXMLPDataWriter.h.

Definition at line 102 of file vtkXMLPDataWriter.h.

Definition at line 103 of file vtkXMLPDataWriter.h.

Definition at line 104 of file vtkXMLPDataWriter.h.

Definition at line 105 of file vtkXMLPDataWriter.h.

char* vtkXMLPDataWriter::PathName [protected]

Definition at line 107 of file vtkXMLPDataWriter.h.

Definition at line 108 of file vtkXMLPDataWriter.h.

Definition at line 109 of file vtkXMLPDataWriter.h.

Definition at line 110 of file vtkXMLPDataWriter.h.

Reimplemented from vtkAlgorithm.

Definition at line 113 of file vtkXMLPDataWriter.h.

Definition at line 115 of file vtkXMLPDataWriter.h.


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