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

write eXtensible Data Model and Format files More...

#include <vtkXdmf3Writer.h>

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

List of all members.

Public Types

typedef vtkDataObjectAlgorithm Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkXdmf3WriterNewInstance () 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 SetLightDataLimit (unsigned int)
virtual unsigned int GetLightDataLimit ()
virtual void SetWriteAllTimeSteps (bool)
virtual bool GetWriteAllTimeSteps ()
virtual void WriteAllTimeStepsOn ()
virtual void WriteAllTimeStepsOff ()

Static Public Member Functions

static vtkXdmf3WriterNew ()
static int IsTypeOf (const char *type)
static vtkXdmf3WriterSafeDownCast (vtkObjectBase *o)

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkXdmf3Writer ()
 ~vtkXdmf3Writer ()
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)

Protected Attributes

char * FileName
unsigned int LightDataLimit
bool WriteAllTimeSteps

Detailed Description

write eXtensible Data Model and Format files

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

Tests:
vtkXdmf3Writer (Tests)

Definition at line 35 of file vtkXdmf3Writer.h.


Member Typedef Documentation

Reimplemented from vtkDataObjectAlgorithm.

Definition at line 39 of file vtkXdmf3Writer.h.


Constructor & Destructor Documentation


Member Function Documentation

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

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

Reimplemented from vtkDataObjectAlgorithm.

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

Reimplemented from vtkDataObjectAlgorithm.

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

Reimplemented from vtkDataObjectAlgorithm.

Reimplemented from vtkDataObjectAlgorithm.

void vtkXdmf3Writer::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 vtkXdmf3Writer::SetInputData ( vtkDataObject dobj) [virtual]

Set the input data set.

Reimplemented from vtkDataObjectAlgorithm.

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

Set or get the file name of the xdmf file.

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

Set or get the file name of the xdmf file.

virtual int vtkXdmf3Writer::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 vtkXdmf3Writer::SetLightDataLimit ( unsigned  int) [virtual]

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

virtual unsigned int vtkXdmf3Writer::GetLightDataLimit ( ) [virtual]

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

virtual void vtkXdmf3Writer::SetWriteAllTimeSteps ( bool  ) [virtual]

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

virtual bool vtkXdmf3Writer::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 vtkXdmf3Writer::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 vtkXdmf3Writer::WriteAllTimeStepsOff ( ) [virtual]

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

Reimplemented from vtkDataObjectAlgorithm.

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

Reimplemented from vtkDataObjectAlgorithm.

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

Reimplemented from vtkDataObjectAlgorithm.


Member Data Documentation

char* vtkXdmf3Writer::FileName [protected]

Definition at line 88 of file vtkXdmf3Writer.h.

unsigned int vtkXdmf3Writer::LightDataLimit [protected]

Definition at line 89 of file vtkXdmf3Writer.h.

Definition at line 90 of file vtkXdmf3Writer.h.


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