vtkPVWriter Class Reference

Wraps a VTK file writer. More...

#include <vtkPVWriter.h>

Inheritance diagram for vtkPVWriter:

[legend]Collaboration diagram for vtkPVWriter:

[legend]List of all members.

Public Member Functions
	vtkTypeRevisionMacro (vtkPVWriter, vtkKWObject)
void	PrintSelf (ostream &os, vtkIndent indent)
void	AddExtension (const char *)
vtkIdType	GetNumberOfExtensions ()
const char *	GetExtension (vtkIdType i)
virtual int	CanWriteData (vtkDataObject *data, int parallel, int numParts)
virtual int	CanWriteFile (const char *fname)
vtkPVApplication *	GetPVApplication ()
virtual void	SetInputClassName (const char *)
virtual char *	GetInputClassName ()
virtual void	SetWriterClassName (const char *)
virtual char *	GetWriterClassName ()
virtual void	SetDescription (const char *)
virtual char *	GetDescription ()
virtual void	SetParallel (int)
virtual int	GetParallel ()
virtual void	ParallelOn ()
virtual void	ParallelOff ()
virtual void	SetDataModeMethod (const char *)
virtual char *	GetDataModeMethod ()
virtual void	Write (const char *fileName, vtkPVSource *pvs, int numProcs, int ghostLevel, int timeSeries)
virtual void	SetSupportsTime (int)
virtual int	GetSupportsTime ()
Static Public Member Functions
vtkPVWriter *	New ()
Protected Member Functions
	vtkPVWriter ()
	~vtkPVWriter ()
virtual int	WriteOneFile (const char *fileName, vtkPVSource *pvs, int numProcs, int ghostLevel)
char *	ExtractExtension (const char *fname)
Protected Attributes
char *	InputClassName
char *	WriterClassName
char *	Description
vtkVector< const char * > *	Extensions
vtkVectorIterator< const char * > *	Iterator
int	Parallel
char *	DataModeMethod
int	SupportsTime

---

Detailed Description

Wraps a VTK file writer.

vtkPVWriter provides functionality for writers similar to that provided by vtkPVReaderModule for readers. An instance of this class is configured by an XML ModuleInterface specification and knows how to create and use a single VTK file writer object.

Definition at line 39 of file vtkPVWriter.h.

---

Constructor & Destructor Documentation

vtkPVWriter::vtkPVWriter (   )  [protected]

vtkPVWriter::~vtkPVWriter (   )  [protected]

---

Member Function Documentation

vtkPVWriter* vtkPVWriter::New (   )  [static]

Reimplemented from vtkKWObject. Reimplemented in vtkPVDWriter, and vtkPVEWriter.

vtkPVWriter::vtkTypeRevisionMacro (  vtkPVWriter  , vtkKWObject  )

void vtkPVWriter::PrintSelf (  ostream &  os, vtkIndent  indent )

Reimplemented from vtkKWObject. Reimplemented in vtkPVDWriter, and vtkPVEWriter.

virtual void vtkPVWriter::SetInputClassName (  const char *   )  [virtual]

Get/Set the name of the vtk data type that this writer can write.

virtual char* vtkPVWriter::GetInputClassName (   )  [virtual]

Get/Set the name of the vtk data type that this writer can write.

virtual void vtkPVWriter::SetWriterClassName (  const char *   )  [virtual]

Get/Set the name of the actual class that implements the writer.

virtual char* vtkPVWriter::GetWriterClassName (   )  [virtual]

Get/Set the name of the actual class that implements the writer.

virtual void vtkPVWriter::SetDescription (  const char *   )  [virtual]

Get/Set the description of the file type supported by this writer.

virtual char* vtkPVWriter::GetDescription (   )  [virtual]

Get/Set the description of the file type supported by this writer.

void vtkPVWriter::AddExtension (  const char *   )

Add extension recognized by the writer. This is displayed in the selection dialog

vtkIdType vtkPVWriter::GetNumberOfExtensions (   )

Get the number of registered file extensions.

const char* vtkPVWriter::GetExtension (  vtkIdType  i  )

Get the ith file extension.

virtual void vtkPVWriter::SetParallel (  int   )  [virtual]

Get/Set whether the file writer is for parallel file formats.

virtual int vtkPVWriter::GetParallel (   )  [virtual]

Get/Set whether the file writer is for parallel file formats.

virtual void vtkPVWriter::ParallelOn (   )  [virtual]

Get/Set whether the file writer is for parallel file formats.

virtual void vtkPVWriter::ParallelOff (   )  [virtual]

Get/Set whether the file writer is for parallel file formats.

virtual void vtkPVWriter::SetDataModeMethod (  const char *   )  [virtual]

Get/Set the method called to set the writer's data mode. Default is no method.

virtual char* vtkPVWriter::GetDataModeMethod (   )  [virtual]

Get/Set the method called to set the writer's data mode. Default is no method.

virtual int vtkPVWriter::CanWriteData (  vtkDataObject *  data, int  parallel, int  numParts )  [virtual]

Check whether this writer supports the given VTK data set's type. Reimplemented in vtkPVDWriter.

virtual int vtkPVWriter::CanWriteFile (  const char *  fname  )  [virtual]

Returns true (1) if the current writer can write to the specified file, false (0) otherwise. In the default implementation, this is done by comparing the extension of the file to a list of extensions specified by the configuration (XML) file -see AddExtension-.

vtkPVApplication* vtkPVWriter::GetPVApplication (   )

This just returns the application typecast correctly.

virtual void vtkPVWriter::Write (  const char *  fileName, vtkPVSource *  pvs, int  numProcs, int  ghostLevel, int  timeSeries )  [virtual]

Write the data from the given source to the given file name. Reimplemented in vtkPVDWriter.

virtual void vtkPVWriter::SetSupportsTime (  int   )  [virtual]

If the writer supports writing multiple time steps, set this to true. Set to false otherwise.

virtual int vtkPVWriter::GetSupportsTime (   )  [virtual]

If the writer supports writing multiple time steps, set this to true. Set to false otherwise.

virtual int vtkPVWriter::WriteOneFile (  const char *  fileName, vtkPVSource *  pvs, int  numProcs, int  ghostLevel )  [protected, virtual]

Reimplemented in vtkPVEWriter.

char* vtkPVWriter::ExtractExtension (  const char *  fname  )  [protected]

---

Member Data Documentation

char* vtkPVWriter::InputClassName [protected]

Definition at line 122 of file vtkPVWriter.h.

char* vtkPVWriter::WriterClassName [protected]

Definition at line 123 of file vtkPVWriter.h.

char* vtkPVWriter::Description [protected]

Definition at line 124 of file vtkPVWriter.h.

vtkVector<const char*>* vtkPVWriter::Extensions [protected]

Definition at line 126 of file vtkPVWriter.h.

vtkVectorIterator<const char*>* vtkPVWriter::Iterator [protected]

Definition at line 127 of file vtkPVWriter.h.

int vtkPVWriter::Parallel [protected]

Definition at line 129 of file vtkPVWriter.h.

char* vtkPVWriter::DataModeMethod [protected]

Definition at line 130 of file vtkPVWriter.h.

int vtkPVWriter::SupportsTime [protected]

Definition at line 132 of file vtkPVWriter.h.

---

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

• GUI/Client/vtkPVWriter.h

---