write eXtensible Data Model and Format files More...

#include <vtkXdmfWriter.h>

Inheritance diagram for vtkXdmfWriter:

Collaboration diagram for vtkXdmfWriter:

Public Types
typedef vtkDataObjectAlgorithm	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkXdmfWriter *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetInputData (vtkDataObject *dobj)
virtual int	Write ()

virtual void	SetFileName (const char *)
virtual char *	GetFileName ()

virtual void	SetHeavyDataFileName (const char *)
virtual char *	GetHeavyDataFileName ()

virtual void	SetHeavyDataGroupName (const char *)
virtual char *	GetHeavyDataGroupName ()

virtual void	SetLightDataLimit (int)
virtual int	GetLightDataLimit ()

virtual void	SetWriteAllTimeSteps (int)
virtual int	GetWriteAllTimeSteps ()
virtual void	WriteAllTimeStepsOn ()
virtual void	WriteAllTimeStepsOff ()

virtual void	SetPiece (int)
virtual void	SetNumberOfPieces (int)
Static Public Member Functions
static vtkXdmfWriter *	New ()
static int	IsTypeOf (const char *type)
static vtkXdmfWriter *	SafeDownCast (vtkObjectBase *o)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkXdmfWriter ()
	~vtkXdmfWriter ()
virtual vtkExecutive *	CreateDefaultExecutive ()
virtual int	FillInputPortInformation (int port, vtkInformation *info)
virtual int	RequestInformation (vtkInformation , vtkInformationVector , vtkInformationVector )
virtual int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector )
virtual int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )
virtual void	CreateTopology (vtkDataSet ds, XdmfGrid grid, vtkIdType PDims[3], vtkIdType CDims[3], vtkIdType &PRank, vtkIdType &CRank, void *staticdata)
virtual void	CreateGeometry (vtkDataSet ds, XdmfGrid grid, void *staticdata)
virtual void	WriteDataSet (vtkDataObject dobj, XdmfGrid grid)
virtual void	WriteCompositeDataSet (vtkCompositeDataSet dobj, XdmfGrid grid)
virtual void	WriteAtomicDataSet (vtkDataObject dobj, XdmfGrid grid)
virtual void	WriteArrays (vtkFieldData dsa, XdmfGrid grid, int association, vtkIdType rank, vtkIdType dims, const char name)
virtual void	ConvertVToXArray (vtkDataArray vda, XdmfArray xda, vtkIdType rank, vtkIdType dims, int AllocStrategy, const char heavyprefix)
Protected Attributes
char *	FileName
char *	HeavyDataFileName
char *	HeavyDataGroupName
int	LightDataLimit
int	WriteAllTimeSteps
int	NumberOfTimeSteps
int	CurrentTimeIndex
int	Piece
int	NumberOfPieces
XdmfDOM *	DOM
XdmfGrid *	TopTemporalGrid
vtkXdmfWriterDomainMemoryHandler *	DomainMemoryHandler

Detailed Description

write eXtensible Data Model and Format files

vtkXdmfWriter converts vtkDataObjects to XDMF format. This is intended to replace vtkXdmfWriter, which is not up to date with the capabilities of the newer XDMF2 library. This writer understands VTK's composite data types and produces full trees in the output XDMF files.

Tests:: vtkXdmfWriter (Tests)

Definition at line 49 of file vtkXdmfWriter.h.

Member Typedef Documentation

typedef vtkDataObjectAlgorithm vtkXdmfWriter::Superclass

Reimplemented from vtkDataObjectAlgorithm.

Definition at line 53 of file vtkXdmfWriter.h.

Constructor & Destructor Documentation

vtkXdmfWriter::vtkXdmfWriter ( ) [protected]

vtkXdmfWriter::~vtkXdmfWriter ( ) [protected]

Member Function Documentation

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

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

Reimplemented from vtkDataObjectAlgorithm.

static int vtkXdmfWriter::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 vtkDataObjectAlgorithm.

virtual int vtkXdmfWriter::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 vtkDataObjectAlgorithm.

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

Reimplemented from vtkDataObjectAlgorithm.

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

Reimplemented from vtkDataObjectAlgorithm.

vtkXdmfWriter* vtkXdmfWriter::NewInstance ( ) const

Reimplemented from vtkDataObjectAlgorithm.

void vtkXdmfWriter::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 vtkDataObjectAlgorithm.

virtual void vtkXdmfWriter::SetInputData ( vtkDataObject * dobj ) [virtual]

Set the input data set.

Reimplemented from vtkDataObjectAlgorithm.

virtual void vtkXdmfWriter::SetFileName ( const char * ) [virtual]

Set or get the file name of the xdmf file.

virtual char* vtkXdmfWriter::GetFileName ( ) [virtual]

Set or get the file name of the xdmf file.

virtual void vtkXdmfWriter::SetHeavyDataFileName ( const char * ) [virtual]

Set or get the file name of the hdf5 file. Note that if the File name is not specified, then the group name is ignore

virtual char* vtkXdmfWriter::GetHeavyDataFileName ( ) [virtual]

Set or get the file name of the hdf5 file. Note that if the File name is not specified, then the group name is ignore

virtual void vtkXdmfWriter::SetHeavyDataGroupName ( const char * ) [virtual]

Set or get the group name into which data will be written it may contain nested groups as in "/Proc0/Block0"

virtual char* vtkXdmfWriter::GetHeavyDataGroupName ( ) [virtual]

Set or get the group name into which data will be written it may contain nested groups as in "/Proc0/Block0"

virtual int vtkXdmfWriter::Write ( ) [virtual]

Write data to output. Method executes subclasses WriteData() method, as well as StartMethod() and EndMethod() methods. Returns 1 on success and 0 on failure.

virtual void vtkXdmfWriter::SetLightDataLimit ( int ) [virtual]

Topology Geometry and Attribute arrays smaller than this are written in line into the XML. Default is 100.

virtual int vtkXdmfWriter::GetLightDataLimit ( ) [virtual]

Topology Geometry and Attribute arrays smaller than this are written in line into the XML. Default is 100.

virtual void vtkXdmfWriter::SetWriteAllTimeSteps ( int ) [virtual]

Controls whether writer automatically writes all input time steps, or just the timestep that is currently on the input. Default is OFF.

virtual int vtkXdmfWriter::GetWriteAllTimeSteps ( ) [virtual]

Controls whether writer automatically writes all input time steps, or just the timestep that is currently on the input. Default is OFF.

virtual void vtkXdmfWriter::WriteAllTimeStepsOn ( ) [virtual]

Controls whether writer automatically writes all input time steps, or just the timestep that is currently on the input. Default is OFF.

virtual void vtkXdmfWriter::WriteAllTimeStepsOff ( ) [virtual]

Controls whether writer automatically writes all input time steps, or just the timestep that is currently on the input. Default is OFF.

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

Called in parallel runs to identify the portion this process is responsible for TODO: respect this

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

Called in parallel runs to identify the portion this process is responsible for TODO: respect this

virtual vtkExecutive* vtkXdmfWriter::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 int vtkXdmfWriter::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 vtkDataObjectAlgorithm.

virtual int vtkXdmfWriter::RequestInformation	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)		`[protected, virtual]`

Reimplemented from vtkDataObjectAlgorithm.

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

This is called by the superclass. This is the method you should override.

Reimplemented from vtkDataObjectAlgorithm.

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

Reimplemented from vtkDataObjectAlgorithm.

virtual void vtkXdmfWriter::CreateTopology	(	vtkDataSet *	ds,
		XdmfGrid *	grid,
		vtkIdType	PDims[3],
		vtkIdType	CDims[3],
		vtkIdType &	PRank,
		vtkIdType &	CRank,
		void *	staticdata
	)		`[protected, virtual]`

virtual void vtkXdmfWriter::CreateGeometry	(	vtkDataSet *	ds,
		XdmfGrid *	grid,
		void *	staticdata
	)		`[protected, virtual]`

virtual void vtkXdmfWriter::WriteDataSet	(	vtkDataObject *	dobj,
		XdmfGrid *	grid
	)		`[protected, virtual]`

virtual void vtkXdmfWriter::WriteCompositeDataSet	(	vtkCompositeDataSet *	dobj,
		XdmfGrid *	grid
	)		`[protected, virtual]`

virtual void vtkXdmfWriter::WriteAtomicDataSet	(	vtkDataObject *	dobj,
		XdmfGrid *	grid
	)		`[protected, virtual]`

virtual void vtkXdmfWriter::WriteArrays	(	vtkFieldData *	dsa,
		XdmfGrid *	grid,
		int	association,
		vtkIdType	rank,
		vtkIdType *	dims,
		const char *	name
	)		`[protected, virtual]`

virtual void vtkXdmfWriter::ConvertVToXArray	(	vtkDataArray *	vda,
		XdmfArray *	xda,
		vtkIdType	rank,
		vtkIdType *	dims,
		int	AllocStrategy,
		const char *	heavyprefix
	)		`[protected, virtual]`