vtkWriter Class Reference

#include <vtkWriter.h>

Inheritance diagram for vtkWriter:

[legend]Collaboration diagram for vtkWriter:

[legend]List of all members.

---

Detailed Description

abstract class to write data to file(s)

vtkWriter is an abstract class for mapper objects that write their data to disk (or into a communications port). All writers respond to Write() method. This method insures that there is input and input is up to date.

Since vtkWriter is a subclass of vtkProcessObject, StartMethod(), EndMethod(), and ProgressMethod() are all available to writers. These methods are executed before and after execution of the Write() method. You can also specify arguments to these methods.

Warning:

Every subclass of vtkWriter must implement a WriteData() method. Most likely will have to create SetInput() method as well.

See also:

vtkBYUWriter vtkDataWriter vtkSTLWriter vtkVoxelWriter vtkMCubesWriter

Events:

vtkCommand::StartEvent vtkCommand::EndEvent

Definition at line 48 of file vtkWriter.h.

Public Types
typedef vtkAlgorithm	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual int	Write ()
vtkDataObject *	GetInput ()
vtkDataObject *	GetInput (int port)
void	EncodeArrayName (char *resname, const char *name)
void	SetInput (vtkDataObject *input)
void	SetInput (int index, vtkDataObject *input)
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkWriter *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkWriter ()
	~vtkWriter ()
virtual int	ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int	RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual void	WriteData ()=0
Protected Attributes
vtkTimeStamp	WriteTime

---

Member Typedef Documentation

typedef vtkAlgorithm vtkWriter::Superclass

Reimplemented from vtkAlgorithm. Reimplemented in vtkBYUWriter, vtkCGMWriter, vtkDataObjectWriter, vtkDataSetWriter, vtkDataWriter, vtkIVWriter, vtkMCubesWriter, vtkPLYWriter, vtkPolyDataWriter, vtkRectilinearGridWriter, vtkSTLWriter, vtkStructuredGridWriter, vtkStructuredPointsWriter, vtkUnstructuredGridWriter, vtkEnSightWriter, vtkExodusIIWriter, and vtkPDataSetWriter. Definition at line 51 of file vtkWriter.h.

---

Constructor & Destructor Documentation

vtkWriter::vtkWriter (   )  [protected]

vtkWriter::~vtkWriter (   )  [protected]

---

Member Function Documentation

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

Reimplemented from vtkAlgorithm. Reimplemented in vtkBYUWriter, vtkCGMWriter, vtkDataObjectWriter, vtkDataSetWriter, vtkDataWriter, vtkIVWriter, vtkMCubesWriter, vtkPLYWriter, vtkPolyDataWriter, vtkRectilinearGridWriter, vtkSTLWriter, vtkStructuredGridWriter, vtkStructuredPointsWriter, vtkUnstructuredGridWriter, vtkEnSightWriter, vtkExodusIIWriter, and vtkPDataSetWriter.

static int vtkWriter::IsTypeOf (  const char *  type  )  [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 vtkAlgorithm. Reimplemented in vtkBYUWriter, vtkCGMWriter, vtkDataObjectWriter, vtkDataSetWriter, vtkDataWriter, vtkIVWriter, vtkMCubesWriter, vtkPLYWriter, vtkPolyDataWriter, vtkRectilinearGridWriter, vtkSTLWriter, vtkStructuredGridWriter, vtkStructuredPointsWriter, vtkUnstructuredGridWriter, vtkEnSightWriter, vtkExodusIIWriter, and vtkPDataSetWriter.

virtual int vtkWriter::IsA (  const char *  type  )  [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 vtkAlgorithm. Reimplemented in vtkBYUWriter, vtkCGMWriter, vtkDataObjectWriter, vtkDataSetWriter, vtkDataWriter, vtkIVWriter, vtkMCubesWriter, vtkPLYWriter, vtkPolyDataWriter, vtkRectilinearGridWriter, vtkSTLWriter, vtkStructuredGridWriter, vtkStructuredPointsWriter, vtkUnstructuredGridWriter, vtkEnSightWriter, vtkExodusIIWriter, and vtkPDataSetWriter.

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

Reimplemented from vtkAlgorithm. Reimplemented in vtkBYUWriter, vtkCGMWriter, vtkDataObjectWriter, vtkDataSetWriter, vtkDataWriter, vtkIVWriter, vtkMCubesWriter, vtkPLYWriter, vtkPolyDataWriter, vtkRectilinearGridWriter, vtkSTLWriter, vtkStructuredGridWriter, vtkStructuredPointsWriter, vtkUnstructuredGridWriter, vtkEnSightWriter, vtkExodusIIWriter, and vtkPDataSetWriter.

void vtkWriter::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 vtkAlgorithm. Reimplemented in vtkBYUWriter, vtkCGMWriter, vtkDataObjectWriter, vtkDataSetWriter, vtkDataWriter, vtkIVWriter, vtkMCubesWriter, vtkPLYWriter, vtkPolyDataWriter, vtkRectilinearGridWriter, vtkSTLWriter, vtkStructuredGridWriter, vtkStructuredPointsWriter, vtkUnstructuredGridWriter, vtkEnSightWriter, vtkExodusIIWriter, and vtkPDataSetWriter.

virtual int vtkWriter::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. Reimplemented in vtkPDataSetWriter.

void vtkWriter::EncodeArrayName (  char *  resname, const char *  name )

Encode the name so that the reader will not have problems. The resulting string is up to four time the size of the input string.

void vtkWriter::SetInput (  vtkDataObject *  input  )

Set/get the input to this writer.

void vtkWriter::SetInput (  int  index, vtkDataObject *  input )

Encode the name so that the reader will not have problems. The resulting string is up to four time the size of the input string.

vtkDataObject* vtkWriter::GetInput (   )

Reimplemented in vtkDataSetWriter, vtkPolyDataWriter, vtkRectilinearGridWriter, vtkStructuredGridWriter, vtkStructuredPointsWriter, vtkUnstructuredGridWriter, vtkEnSightWriter, and vtkExodusIIWriter.

vtkDataObject* vtkWriter::GetInput (  int  port  )

Reimplemented in vtkDataSetWriter, vtkPolyDataWriter, vtkRectilinearGridWriter, vtkStructuredGridWriter, vtkStructuredPointsWriter, and vtkUnstructuredGridWriter.

virtual int vtkWriter::ProcessRequest (  vtkInformation *  request, vtkInformationVector **  inputVector, vtkInformationVector *  outputVector )  [protected, 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 vtkAlgorithm.

virtual int vtkWriter::RequestData (  vtkInformation *  request, vtkInformationVector **  inputVector, vtkInformationVector *  outputVector )  [protected, virtual]

virtual void vtkWriter::WriteData (   )  [protected, pure virtual]

Implemented in vtkBYUWriter, vtkCGMWriter, vtkDataObjectWriter, vtkDataSetWriter, vtkDataWriter, vtkIVWriter, vtkMCubesWriter, vtkPLYWriter, vtkPolyDataWriter, vtkRectilinearGridWriter, vtkSTLWriter, vtkStructuredGridWriter, vtkStructuredPointsWriter, vtkUnstructuredGridWriter, vtkEnSightWriter, and vtkExodusIIWriter.

---

Member Data Documentation

vtkTimeStamp vtkWriter::WriteTime [protected]

Definition at line 85 of file vtkWriter.h.

---

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

• dox/IO/vtkWriter.h

---