vtkXMLPMultiBlockDataWriter Class Reference

#include <vtkXMLPMultiBlockDataWriter.h>

Inheritance diagram for vtkXMLPMultiBlockDataWriter:

[legend]

Collaboration diagram for vtkXMLPMultiBlockDataWriter:

[legend]

List of all members.

Detailed Description

parallel writer for vtkHierarchicalBoxDataSet.

vtkXMLPCompositeDataWriter writes (in parallel or serially) the VTK XML multi-group, multi-block hierarchical and hierarchical box files. XML multi-group data files are meta-files that point to a list of serial VTK XML files.

Definition at line 33 of file vtkXMLPMultiBlockDataWriter.h.


Public Types
typedef vtkXMLMultiBlockDataWriter	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetWriteMetaFile (int flag)

virtual void	SetController (vtkMultiProcessController *)
virtual vtkMultiProcessController *	GetController ()
Static Public Member Functions
static vtkXMLPMultiBlockDataWriter *	New ()
static int	IsTypeOf (const char *type)
static vtkXMLPMultiBlockDataWriter *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkXMLPMultiBlockDataWriter ()
	~vtkXMLPMultiBlockDataWriter ()
virtual void	FillDataTypes (vtkCompositeDataSet *)
virtual void	RemoveWrittenFiles (const char *subDirectory)

virtual int	WriteComposite (vtkCompositeDataSet compositeData, vtkXMLDataElement parent, int &currentFileIndex)

int	ParallelWriteNonCompositeData (vtkDataObject dObj, vtkXMLDataElement parentXML, int currentFileIndex)

virtual vtkStdString	CreatePieceFileName (int currentFileIndex, int procId, int dataSetType)
Protected Attributes
vtkMultiProcessController *	Controller

Member Typedef Documentation

typedef vtkXMLMultiBlockDataWriter vtkXMLPMultiBlockDataWriter::Superclass

Reimplemented from vtkXMLMultiBlockDataWriter.

Definition at line 37 of file vtkXMLPMultiBlockDataWriter.h.

Constructor & Destructor Documentation

vtkXMLPMultiBlockDataWriter::vtkXMLPMultiBlockDataWriter ( ) [protected]

vtkXMLPMultiBlockDataWriter::~vtkXMLPMultiBlockDataWriter ( ) [protected]

Member Function Documentation

static vtkXMLPMultiBlockDataWriter* vtkXMLPMultiBlockDataWriter::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkXMLMultiBlockDataWriter.

virtual const char* vtkXMLPMultiBlockDataWriter::GetClassName ( ) [virtual]

Reimplemented from vtkXMLMultiBlockDataWriter.

static int vtkXMLPMultiBlockDataWriter::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 vtkXMLMultiBlockDataWriter.

virtual int vtkXMLPMultiBlockDataWriter::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 vtkXMLMultiBlockDataWriter.

static vtkXMLPMultiBlockDataWriter* vtkXMLPMultiBlockDataWriter::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkXMLMultiBlockDataWriter.

void vtkXMLPMultiBlockDataWriter::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 vtkXMLMultiBlockDataWriter.

virtual void vtkXMLPMultiBlockDataWriter::SetController ( vtkMultiProcessController * ) [virtual]

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. If no controller is set, only the local blocks will be written to the meta-file.

virtual vtkMultiProcessController* vtkXMLPMultiBlockDataWriter::GetController ( ) [virtual]

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. If no controller is set, only the local blocks will be written to the meta-file.

virtual void vtkXMLPMultiBlockDataWriter::SetWriteMetaFile ( int flag ) [virtual]

Set whether this instance will write the meta-file. WriteMetaFile is set to flag only on process 0 and all other processes have WriteMetaFile set to 0 by default.

Reimplemented from vtkXMLCompositeDataWriter.

virtual void vtkXMLPMultiBlockDataWriter::FillDataTypes ( vtkCompositeDataSet * ) [protected, virtual]

Determine the data types for each of the leaf nodes. Currently each process requires this information in order to simplify creating the file names for both the metadata file as well as the actual dataset files. It takes into account that a piece of a dataset may be distributed in multiple pieces over multiple processes.

Reimplemented from vtkXMLCompositeDataWriter.

virtual int vtkXMLPMultiBlockDataWriter::WriteComposite	(	vtkCompositeDataSet *	compositeData,
		vtkXMLDataElement *	parent,
		int &	currentFileIndex
	)			`[protected, virtual]`

Internal method called recursively to create the xml tree for the children of compositeData as well as write the actual data set files. element will only have added nested information. writerIdx is the global piece index used to create unique filenames for each file written. This function returns 0 if no files were written from compositeData. Process 0 creates the metadata for all of the processes/files.

Reimplemented from vtkXMLMultiBlockDataWriter.

int vtkXMLPMultiBlockDataWriter::ParallelWriteNonCompositeData	(	vtkDataObject *	dObj,
		vtkXMLDataElement *	parentXML,
		int	currentFileIndex
	)			`[protected]`

Internal method to write a non vtkCompositeDataSet subclass as well as add in the file name to the metadata file. Element is the containing XML metadata element that may have data overwritten and added to (the index XML attribute should not be touched though). writerIdx is the piece index that gets incremented for the globally numbered piece. If this piece exists on multiple processes than it also takes care of that in the metadata description. This function returns 0 if no file was written.

virtual vtkStdString vtkXMLPMultiBlockDataWriter::CreatePieceFileName	(	int	currentFileIndex,
		int	procId,
		int	dataSetType
	)			`[protected, virtual]`

Return the name of the file given the currentFileIndex (also the current globally numbered piece index), the procId the file exists on, and the dataSetType.

virtual void vtkXMLPMultiBlockDataWriter::RemoveWrittenFiles ( const char * subDirectory ) [protected, virtual]

Utility function to remove any already written files in case writer failed.

Reimplemented from vtkXMLCompositeDataWriter.