Writer for multi-group datasets. More...

#include <vtkXMLCompositeDataWriter.h>

Inheritance diagram for vtkXMLCompositeDataWriter:

Collaboration diagram for vtkXMLCompositeDataWriter:

Public Types
typedef vtkXMLWriter	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkXMLCompositeDataWriter *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual const char *	GetDefaultFileExtension ()

virtual int	GetGhostLevel ()
virtual void	SetGhostLevel (int)

virtual int	GetWriteMetaFile ()
virtual void	SetWriteMetaFile (int flag)

int	ProcessRequest (vtkInformation , vtkInformationVector , vtkInformationVector )
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkXMLCompositeDataWriter *	SafeDownCast (vtkObjectBase *o)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkXMLCompositeDataWriter ()
	~vtkXMLCompositeDataWriter ()
vtkStdString	CreatePieceFileName (int Piece)
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	RemoveWrittenFiles (const char *SubDirectory)

virtual int	GetDataSetMajorVersion ()
virtual int	GetDataSetMinorVersion ()

virtual int	WriteComposite (vtkCompositeDataSet compositeData, vtkXMLDataElement element, int &writerIdx)=0

virtual int	WriteNonCompositeData (vtkDataObject dObj, vtkXMLDataElement element, int &writerIdx, const char *FileName)
Static Protected Member Functions
static void	ProgressCallbackFunction (vtkObject , unsigned long, void , void *)
Protected Attributes
vtkInformation *	InputInformation
vtkXMLCompositeDataWriterInternals *	Internal
int	GhostLevel
int	WriteMetaFile
vtkCallbackCommand *	ProgressObserver

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 37 of file vtkXMLCompositeDataWriter.h.

Member Typedef Documentation

typedef vtkXMLWriter vtkXMLCompositeDataWriter::Superclass

Reimplemented from vtkXMLWriter.

Reimplemented in vtkXMLPMultiBlockDataWriter, vtkXMLPUniformGridAMRWriter, vtkXMLUniformGridAMRWriter, vtkXMLMultiBlockDataWriter, vtkXMLPHierarchicalBoxDataWriter, and vtkXMLHierarchicalBoxDataWriter.

Definition at line 40 of file vtkXMLCompositeDataWriter.h.

Constructor & Destructor Documentation

vtkXMLCompositeDataWriter::vtkXMLCompositeDataWriter ( ) [protected]

vtkXMLCompositeDataWriter::~vtkXMLCompositeDataWriter ( ) [protected]

Member Function Documentation

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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkXMLWriter.

Reimplemented in vtkXMLPMultiBlockDataWriter, vtkXMLPUniformGridAMRWriter, vtkXMLUniformGridAMRWriter, vtkXMLMultiBlockDataWriter, vtkXMLPHierarchicalBoxDataWriter, and vtkXMLHierarchicalBoxDataWriter.

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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkXMLWriter.

Reimplemented in vtkXMLPMultiBlockDataWriter, vtkXMLPUniformGridAMRWriter, vtkXMLUniformGridAMRWriter, vtkXMLMultiBlockDataWriter, vtkXMLPHierarchicalBoxDataWriter, and vtkXMLHierarchicalBoxDataWriter.

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

Reimplemented from vtkXMLWriter.

Reimplemented in vtkXMLPMultiBlockDataWriter, vtkXMLPUniformGridAMRWriter, vtkXMLUniformGridAMRWriter, vtkXMLMultiBlockDataWriter, vtkXMLPHierarchicalBoxDataWriter, and vtkXMLHierarchicalBoxDataWriter.

virtual vtkObjectBase* vtkXMLCompositeDataWriter::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkXMLWriter.

Reimplemented in vtkXMLPMultiBlockDataWriter, vtkXMLPUniformGridAMRWriter, vtkXMLUniformGridAMRWriter, vtkXMLMultiBlockDataWriter, vtkXMLPHierarchicalBoxDataWriter, and vtkXMLHierarchicalBoxDataWriter.

vtkXMLCompositeDataWriter* vtkXMLCompositeDataWriter::NewInstance ( ) const

Reimplemented from vtkXMLWriter.

Reimplemented in vtkXMLPMultiBlockDataWriter, vtkXMLPUniformGridAMRWriter, vtkXMLUniformGridAMRWriter, vtkXMLMultiBlockDataWriter, vtkXMLPHierarchicalBoxDataWriter, and vtkXMLHierarchicalBoxDataWriter.

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 vtkXMLPMultiBlockDataWriter, vtkXMLPUniformGridAMRWriter, vtkXMLUniformGridAMRWriter, vtkXMLMultiBlockDataWriter, vtkXMLPHierarchicalBoxDataWriter, and vtkXMLHierarchicalBoxDataWriter.

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

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

Implements vtkXMLWriter.

Reimplemented in vtkXMLUniformGridAMRWriter, vtkXMLMultiBlockDataWriter, and vtkXMLHierarchicalBoxDataWriter.

virtual int vtkXMLCompositeDataWriter::GetGhostLevel ( ) [virtual]

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

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

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

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

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.

Reimplemented in vtkXMLPMultiBlockDataWriter, and vtkXMLPUniformGridAMRWriter.

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

See the vtkAlgorithm for a desciption of what these do

Reimplemented from vtkXMLWriter.

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

Methods to define the file's major and minor version numbers. Major version incremented since v0.1 composite data readers cannot read the files written by this new reader.

Reimplemented from vtkXMLWriter.

Reimplemented in vtkXMLUniformGridAMRWriter.

Definition at line 75 of file vtkXMLCompositeDataWriter.h.

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

Methods to define the file's major and minor version numbers. Major version incremented since v0.1 composite data readers cannot read the files written by this new reader.

Reimplemented from vtkXMLWriter.

Reimplemented in vtkXMLUniformGridAMRWriter.

Definition at line 76 of file vtkXMLCompositeDataWriter.h.

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

Create a filename for the given index.

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 vtkXMLUniformGridAMRWriter, 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 vtkXMLPMultiBlockDataWriter, and vtkXMLPUniformGridAMRWriter.

unsigned int vtkXMLCompositeDataWriter::GetNumberOfDataTypes ( ) [protected]

Returns the number of leaf nodes (also includes empty leaf nodes).

int* vtkXMLCompositeDataWriter::GetDataTypesPointer ( ) [protected]

Returns the array pointer to the array of leaf nodes.

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 communicate 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 int vtkXMLCompositeDataWriter::WriteComposite	(	vtkCompositeDataSet *	compositeData,
		vtkXMLDataElement *	element,
		int &	writerIdx
	)		`[protected, pure 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.

Implemented in vtkXMLPMultiBlockDataWriter, vtkXMLUniformGridAMRWriter, and vtkXMLMultiBlockDataWriter.

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

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. This function returns 0 if no file was written (not necessarily an error). this->ErrorCode is set on error.

virtual void vtkXMLCompositeDataWriter::RemoveWrittenFiles ( const char * SubDirectory ) [protected, virtual]

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

Reimplemented in vtkXMLPMultiBlockDataWriter.

Member Data Documentation

vtkInformation* vtkXMLCompositeDataWriter::InputInformation [protected]

Definition at line 96 of file vtkXMLCompositeDataWriter.h.

vtkXMLCompositeDataWriterInternals* vtkXMLCompositeDataWriter::Internal [protected]

Definition at line 128 of file vtkXMLCompositeDataWriter.h.

int vtkXMLCompositeDataWriter::GhostLevel [protected]

Definition at line 131 of file vtkXMLCompositeDataWriter.h.

int vtkXMLCompositeDataWriter::WriteMetaFile [protected]

Whether to write the collection file on this node. This could potentially be set to 0 (i.e. do not write) for optimization if the file structured does not change but the data does.

Definition at line 136 of file vtkXMLCompositeDataWriter.h.

vtkCallbackCommand* vtkXMLCompositeDataWriter::ProgressObserver [protected]

Definition at line 145 of file vtkXMLCompositeDataWriter.h.

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

dox/IO/XML/vtkXMLCompositeDataWriter.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation