vtkWriter Class Reference
#include <vtkWriter.h>
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.
- Warning:
- Every subclass of vtkWriter must implement a WriteData() method. Most likely will have to create SetInput() method as well.
Definition at line 43 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 () |
| void | EncodeString (char *resname, const char *name, bool doublePercent) |
| void | EncodeWriteString (ostream *out, const char *name, bool doublePercent) |
| vtkDataObject * | GetInput () |
| vtkDataObject * | GetInput (int port) |
| 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 vtkAbstractParticleWriter, vtkBYUWriter, vtkCGMWriter, vtkDataObjectWriter, vtkDataSetWriter, vtkDataWriter, vtkGenericDataObjectWriter, vtkGraphWriter, vtkIVWriter, vtkMCubesWriter, vtkPLYWriter, vtkPolyDataWriter, vtkRectilinearGridWriter, vtkSTLWriter, vtkStructuredGridWriter, vtkStructuredPointsWriter, vtkTableWriter, vtkTreeWriter, vtkUnstructuredGridWriter, vtkEnSightWriter, vtkExodusIIWriter, and vtkPDataSetWriter.
Definition at line 46 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 vtkAbstractParticleWriter, vtkBYUWriter, vtkCGMWriter, vtkDataObjectWriter, vtkDataSetWriter, vtkDataWriter, vtkGenericDataObjectWriter, vtkGraphWriter, vtkIVWriter, vtkMCubesWriter, vtkPLYWriter, vtkPolyDataWriter, vtkRectilinearGridWriter, vtkSTLWriter, vtkStructuredGridWriter, vtkStructuredPointsWriter, vtkTableWriter, vtkTreeWriter, vtkUnstructuredGridWriter, vtkEnSightWriter, vtkExodusIIWriter, and vtkPDataSetWriter.
| static int vtkWriter::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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkAlgorithm.
Reimplemented in vtkAbstractParticleWriter, vtkBYUWriter, vtkCGMWriter, vtkDataObjectWriter, vtkDataSetWriter, vtkDataWriter, vtkGenericDataObjectWriter, vtkGraphWriter, vtkIVWriter, vtkMCubesWriter, vtkPLYWriter, vtkPolyDataWriter, vtkRectilinearGridWriter, vtkSTLWriter, vtkStructuredGridWriter, vtkStructuredPointsWriter, vtkTableWriter, vtkTreeWriter, vtkUnstructuredGridWriter, vtkEnSightWriter, vtkExodusIIWriter, and vtkPDataSetWriter.
| virtual int vtkWriter::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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkAlgorithm.
Reimplemented in vtkAbstractParticleWriter, vtkBYUWriter, vtkCGMWriter, vtkDataObjectWriter, vtkDataSetWriter, vtkDataWriter, vtkGenericDataObjectWriter, vtkGraphWriter, vtkIVWriter, vtkMCubesWriter, vtkPLYWriter, vtkPolyDataWriter, vtkRectilinearGridWriter, vtkSTLWriter, vtkStructuredGridWriter, vtkStructuredPointsWriter, vtkTableWriter, vtkTreeWriter, vtkUnstructuredGridWriter, vtkEnSightWriter, vtkExodusIIWriter, and vtkPDataSetWriter.
Reimplemented from vtkAlgorithm.
Reimplemented in vtkAbstractParticleWriter, vtkBYUWriter, vtkCGMWriter, vtkDataObjectWriter, vtkDataSetWriter, vtkDataWriter, vtkGenericDataObjectWriter, vtkGraphWriter, vtkIVWriter, vtkMCubesWriter, vtkPLYWriter, vtkPolyDataWriter, vtkRectilinearGridWriter, vtkSTLWriter, vtkStructuredGridWriter, vtkStructuredPointsWriter, vtkTableWriter, vtkTreeWriter, 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 vtkAbstractParticleWriter, vtkBYUWriter, vtkCGMWriter, vtkDataObjectWriter, vtkDataSetWriter, vtkDataWriter, vtkGenericDataObjectWriter, vtkGraphWriter, vtkIVWriter, vtkMCubesWriter, vtkPLYWriter, vtkPolyDataWriter, vtkRectilinearGridWriter, vtkSTLWriter, vtkStructuredGridWriter, vtkStructuredPointsWriter, vtkTableWriter, vtkTreeWriter, 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::EncodeString | ( | char * | resname, | |
| const char * | name, | |||
| bool | doublePercent | |||
| ) |
Encode the string so that the reader will not have problems. The resulting string is up to three times the size of the input string. doublePercent indicates whether to output a double '' before escaped characters so the string may be used as a printf format string.
| void vtkWriter::EncodeWriteString | ( | ostream * | out, | |
| const char * | name, | |||
| bool | doublePercent | |||
| ) |
Encode the string so that the reader will not have problems. The resulting string is up to three times the size of the input string. Write the string to the output stream. doublePercent indicates whether to output a double '' before escaped characters so the string may be used as a printf format string.
| void vtkWriter::SetInput | ( | vtkDataObject * | input | ) |
Set/get the input to this writer.
| void vtkWriter::SetInput | ( | int | index, | |
| vtkDataObject * | input | |||
| ) |
Set/get the input to this writer.
| vtkDataObject* vtkWriter::GetInput | ( | ) |
| vtkDataObject* vtkWriter::GetInput | ( | int | port | ) |
| virtual int vtkWriter::ProcessRequest | ( | vtkInformation * | request, | |
| vtkInformationVector ** | inInfo, | |||
| vtkInformationVector * | outInfo | |||
| ) | [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.
Reimplemented in vtkExodusIIWriter.
| virtual int vtkWriter::RequestData | ( | vtkInformation * | request, | |
| vtkInformationVector ** | inputVector, | |||
| vtkInformationVector * | outputVector | |||
| ) | [protected, virtual] |
Reimplemented in vtkExodusIIWriter.
| virtual void vtkWriter::WriteData | ( | ) | [protected, pure virtual] |
Implemented in vtkAbstractParticleWriter, vtkBYUWriter, vtkCGMWriter, vtkDataObjectWriter, vtkDataSetWriter, vtkDataWriter, vtkGenericDataObjectWriter, vtkGraphWriter, vtkIVWriter, vtkMCubesWriter, vtkPLYWriter, vtkPolyDataWriter, vtkRectilinearGridWriter, vtkSTLWriter, vtkStructuredGridWriter, vtkStructuredPointsWriter, vtkTableWriter, vtkTreeWriter, vtkUnstructuredGridWriter, vtkEnSightWriter, and vtkExodusIIWriter.
Member Data Documentation
vtkTimeStamp vtkWriter::WriteTime [protected] |
Definition at line 89 of file vtkWriter.h.
The documentation for this class was generated from the following file:
- dox/IO/vtkWriter.h
