vtkXMLCompositeDataWriter Class Reference

#include <vtkXMLCompositeDataWriter.h>

Inheritance diagram for vtkXMLCompositeDataWriter:

[legend]

Collaboration diagram for vtkXMLCompositeDataWriter:

[legend]

List of all members.

Detailed Description

Writer for multi-group datasets.

vtkXMLCompositeDataWriter writes (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.

See also:: vtkXMLPCompositeDataWriter

Definition at line 36 of file vtkXMLCompositeDataWriter.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 const char *	GetDefaultFileExtension ()
int	ProcessRequest (vtkInformation , vtkInformationVector , vtkInformationVector )

virtual int	GetPiece ()
virtual void	SetPiece (int)

virtual int	GetNumberOfPieces ()
virtual void	SetNumberOfPieces (int)

virtual int	GetGhostLevel ()
virtual void	SetGhostLevel (int)

virtual int	GetWriteMetaFile ()
virtual void	SetWriteMetaFile (int flag)
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkXMLCompositeDataWriter *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkXMLCompositeDataWriter ()
	~vtkXMLCompositeDataWriter ()
virtual int	GetDataSetMajorVersion ()
virtual int	GetDataSetMinorVersion ()
vtkStdString	CreatePieceFileName (int index)
virtual int	FillInputPortInformation (int port, vtkInformation *info)
int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )
int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector )
virtual int	WriteData ()
virtual const char *	GetDataSetName ()
virtual vtkExecutive *	CreateDefaultExecutive ()
virtual void	FillDataTypes (vtkCompositeDataSet *)
unsigned int	GetNumberOfDataTypes ()
int *	GetDataTypesPointer ()
void	CreateWriters (vtkCompositeDataSet *)
vtkXMLWriter *	GetWriter (int index)
void	SplitFileName ()
const char *	GetFilePrefix ()
const char *	GetFilePath ()
int	WriteMetaFileIfRequested ()
void	MakeDirectory (const char *name)
void	RemoveADirectory (const char *name)
virtual void	ProgressCallback (vtkAlgorithm *w)
virtual void	ReportReferences (vtkGarbageCollector *)
virtual int	WriteComposite (vtkCompositeDataSet compositeData, vtkXMLDataElement element, int &writerIdx)=0
virtual int	WriteNonCompositeData (vtkDataObject dObj, vtkXMLDataElement element, int &writerIdx)
Static Protected Member Functions
static void	ProgressCallbackFunction (vtkObject , unsigned long, void , void *)
Protected Attributes
vtkInformation *	InputInformation
vtkXMLCompositeDataWriterInternals *	Internal
int	Piece
int	NumberOfPieces
int	GhostLevel
int	WriteMetaFile
int	WriteMetaFileInitialized
vtkCallbackCommand *	ProgressObserver

Member Typedef Documentation

typedef vtkXMLWriter vtkXMLCompositeDataWriter::Superclass

Reimplemented from vtkXMLWriter.

Reimplemented in vtkXMLHierarchicalBoxDataWriter, vtkXMLMultiBlockDataWriter, vtkXMLPHierarchicalBoxDataWriter, and vtkXMLPMultiBlockDataWriter.

Definition at line 39 of file vtkXMLCompositeDataWriter.h.

Constructor & Destructor Documentation

vtkXMLCompositeDataWriter::vtkXMLCompositeDataWriter ( ) [protected]

vtkXMLCompositeDataWriter::~vtkXMLCompositeDataWriter ( ) [protected]

Member Function Documentation

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

Reimplemented from vtkXMLWriter.

Reimplemented in vtkXMLHierarchicalBoxDataWriter, vtkXMLMultiBlockDataWriter, vtkXMLPHierarchicalBoxDataWriter, and vtkXMLPMultiBlockDataWriter.

static int vtkXMLCompositeDataWriter::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkXMLWriter.

Reimplemented in vtkXMLHierarchicalBoxDataWriter, vtkXMLMultiBlockDataWriter, vtkXMLPHierarchicalBoxDataWriter, and vtkXMLPMultiBlockDataWriter.

virtual int vtkXMLCompositeDataWriter::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkXMLWriter.

Reimplemented in vtkXMLHierarchicalBoxDataWriter, vtkXMLMultiBlockDataWriter, vtkXMLPHierarchicalBoxDataWriter, and vtkXMLPMultiBlockDataWriter.

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

Reimplemented from vtkXMLWriter.

Reimplemented in vtkXMLHierarchicalBoxDataWriter, vtkXMLMultiBlockDataWriter, vtkXMLPHierarchicalBoxDataWriter, and vtkXMLPMultiBlockDataWriter.

void vtkXMLCompositeDataWriter::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 vtkXMLHierarchicalBoxDataWriter, vtkXMLMultiBlockDataWriter, vtkXMLPHierarchicalBoxDataWriter, and vtkXMLPMultiBlockDataWriter.

virtual const char* vtkXMLCompositeDataWriter::GetDefaultFileExtension ( ) [virtual]

Get the default file extension for files written by this writer.

Implements vtkXMLWriter.

Reimplemented in vtkXMLHierarchicalBoxDataWriter, and vtkXMLMultiBlockDataWriter.

virtual int vtkXMLCompositeDataWriter::GetPiece ( ) [virtual]

Get/Set the piece number to write. The same piece number is used for all inputs.

virtual void vtkXMLCompositeDataWriter::SetPiece ( int ) [virtual]

Get/Set the piece number to write. The same piece number is used for all inputs.

virtual int vtkXMLCompositeDataWriter::GetNumberOfPieces ( ) [virtual]

Get/Set the number of pieces into which the inputs are split.

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

Get/Set the number of pieces into which the inputs are split.

virtual int vtkXMLCompositeDataWriter::GetGhostLevel ( ) [virtual]

Get/Set the number of ghost levels to be written.

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

Get/Set the number of ghost levels to be written.

virtual int vtkXMLCompositeDataWriter::GetWriteMetaFile ( ) [virtual]

Get/Set whether this instance will write the meta-file.

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

Get/Set whether this instance will write the meta-file.

int vtkXMLCompositeDataWriter::ProcessRequest	(	vtkInformation *	request,
		vtkInformationVector **	inInfo,
		vtkInformationVector *	outInfo
	)			`[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 int vtkXMLCompositeDataWriter::GetDataSetMajorVersion ( ) [inline, protected, virtual]

Reimplemented from vtkXMLWriter.

Definition at line 82 of file vtkXMLCompositeDataWriter.h.

virtual int vtkXMLCompositeDataWriter::GetDataSetMinorVersion ( ) [inline, protected, virtual]

Reimplemented from vtkXMLWriter.

Definition at line 83 of file vtkXMLCompositeDataWriter.h.

vtkStdString vtkXMLCompositeDataWriter::CreatePieceFileName ( int index ) [protected]

virtual int vtkXMLCompositeDataWriter::FillInputPortInformation	(	int	port,
		vtkInformation *	info
	)			`[protected, virtual]`

Fill the input port information objects for this algorithm. This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkAlgorithm.

Reimplemented in vtkXMLHierarchicalBoxDataWriter, and vtkXMLMultiBlockDataWriter.

int vtkXMLCompositeDataWriter::RequestData	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)			`[protected, virtual]`

Reimplemented from vtkXMLWriter.

int vtkXMLCompositeDataWriter::RequestUpdateExtent	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)			`[protected]`

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

Reimplemented from vtkXMLWriter.

virtual const char* vtkXMLCompositeDataWriter::GetDataSetName ( ) [protected, virtual]

Implements vtkXMLWriter.

virtual vtkExecutive* vtkXMLCompositeDataWriter::CreateDefaultExecutive ( ) [protected, virtual]

Create a default executive. If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). Otherwise, vtkStreamingDemandDrivenPipeline is created.

Reimplemented from vtkAlgorithm.

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

Determine the data types for each of the leaf nodes.

Reimplemented in vtkXMLPHierarchicalBoxDataWriter, and vtkXMLPMultiBlockDataWriter.

unsigned int vtkXMLCompositeDataWriter::GetNumberOfDataTypes ( ) [protected]

int* vtkXMLCompositeDataWriter::GetDataTypesPointer ( ) [protected]

void vtkXMLCompositeDataWriter::CreateWriters ( vtkCompositeDataSet * ) [protected]

vtkXMLWriter* vtkXMLCompositeDataWriter::GetWriter ( int index ) [protected]

void vtkXMLCompositeDataWriter::SplitFileName ( ) [protected]

const char* vtkXMLCompositeDataWriter::GetFilePrefix ( ) [protected]

const char* vtkXMLCompositeDataWriter::GetFilePath ( ) [protected]

int vtkXMLCompositeDataWriter::WriteMetaFileIfRequested ( ) [protected]

Write the collection file if it is requested. This is overridden in parallel writers to comminitate the hierarchy to the root which then write the meta file.

void vtkXMLCompositeDataWriter::MakeDirectory ( const char * name ) [protected]

void vtkXMLCompositeDataWriter::RemoveADirectory ( const char * name ) [protected]

static void vtkXMLCompositeDataWriter::ProgressCallbackFunction	(	vtkObject *	,
		unsigned	long,
		void *	,
		void *
	)			`[static, protected]`

virtual void vtkXMLCompositeDataWriter::ProgressCallback ( vtkAlgorithm * w ) [protected, virtual]

virtual void vtkXMLCompositeDataWriter::ReportReferences ( vtkGarbageCollector * ) [protected, virtual]

Reimplemented from vtkAlgorithm.

virtual int vtkXMLCompositeDataWriter::WriteComposite	(	vtkCompositeDataSet *	compositeData,
		vtkXMLDataElement *	element,
		int &	writerIdx
	)			`[protected, pure virtual]`

Implemented in vtkXMLHierarchicalBoxDataWriter, and vtkXMLMultiBlockDataWriter.

virtual int vtkXMLCompositeDataWriter::WriteNonCompositeData	(	vtkDataObject *	dObj,
		vtkXMLDataElement *	element,
		int &	writerIdx
	)			`[protected, virtual]`