abstract class to write data to file(s) More...
#include <vtkWriter.h>
Public Types | |
| typedef vtkAlgorithm | Superclass |
Public Member Functions | |
| virtual int | IsA (const char *type) |
| vtkWriter * | NewInstance () const |
| 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) |
| void | SetInputData (vtkDataObject *input) |
| void | SetInputData (int index, vtkDataObject *input) |
| vtkDataObject * | GetInput () |
| vtkDataObject * | GetInput (int port) |
Static Public Member Functions | |
| static int | IsTypeOf (const char *type) |
| static vtkWriter * | SafeDownCast (vtkObjectBase *o) |
Protected Member Functions | |
| virtual vtkObjectBase * | NewInstanceInternal () const |
| 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 |
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.
- Events:
- vtkCommand::StartEvent vtkCommand::EndEvent
Definition at line 44 of file vtkWriter.h.
Member Typedef Documentation
| typedef vtkAlgorithm vtkWriter::Superclass |
Reimplemented from vtkAlgorithm.
Reimplemented in vtkExodusIIWriter, vtkPExodusIIWriter, vtkMNITagPointWriter, vtkMNIObjectWriter, vtkArrayWriter, vtkArrayDataWriter, vtkDIMACSGraphWriter, vtkPLYWriter, vtkCGMWriter, vtkMCubesWriter, vtkCompositeDataWriter, vtkSTLWriter, vtkDataWriter, vtkBYUWriter, vtkDataObjectWriter, vtkEnSightWriter, vtkPDataSetWriter, vtkDelimitedTextWriter, vtkPolyDataWriter, vtkUnstructuredGridWriter, vtkIVWriter, vtkRectilinearGridWriter, vtkStructuredGridWriter, vtkAbstractParticleWriter, vtkJavaScriptDataWriter, vtkGeoJSONWriter, vtkNewickTreeWriter, vtkTableWriter, vtkSimplePointsWriter, vtkTableToMySQLWriter, vtkTableToPostgreSQLWriter, vtkTableToSQLiteWriter, vtkDataSetWriter, vtkGraphWriter, vtkStructuredPointsWriter, vtkTreeWriter, vtkTableToDatabaseWriter, and vtkGenericDataObjectWriter.
Definition at line 47 of file vtkWriter.h.
Constructor & Destructor Documentation
| vtkWriter::vtkWriter | ( | ) | [protected] |
| vtkWriter::~vtkWriter | ( | ) | [protected] |
Member Function Documentation
| 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 vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkAlgorithm.
Reimplemented in vtkExodusIIWriter, vtkPExodusIIWriter, vtkMNITagPointWriter, vtkMNIObjectWriter, vtkArrayWriter, vtkArrayDataWriter, vtkDIMACSGraphWriter, vtkPLYWriter, vtkCGMWriter, vtkMCubesWriter, vtkCompositeDataWriter, vtkSTLWriter, vtkDataWriter, vtkBYUWriter, vtkDataObjectWriter, vtkEnSightWriter, vtkPDataSetWriter, vtkDelimitedTextWriter, vtkPolyDataWriter, vtkUnstructuredGridWriter, vtkIVWriter, vtkRectilinearGridWriter, vtkStructuredGridWriter, vtkAbstractParticleWriter, vtkJavaScriptDataWriter, vtkGeoJSONWriter, vtkNewickTreeWriter, vtkTableWriter, vtkSimplePointsWriter, vtkTableToMySQLWriter, vtkTableToPostgreSQLWriter, vtkTableToSQLiteWriter, vtkDataSetWriter, vtkGraphWriter, vtkStructuredPointsWriter, vtkTreeWriter, vtkTableToDatabaseWriter, and vtkGenericDataObjectWriter.
| 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 vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkAlgorithm.
Reimplemented in vtkExodusIIWriter, vtkPExodusIIWriter, vtkMNITagPointWriter, vtkMNIObjectWriter, vtkArrayWriter, vtkArrayDataWriter, vtkDIMACSGraphWriter, vtkPLYWriter, vtkCGMWriter, vtkMCubesWriter, vtkCompositeDataWriter, vtkSTLWriter, vtkDataWriter, vtkBYUWriter, vtkDataObjectWriter, vtkEnSightWriter, vtkPDataSetWriter, vtkDelimitedTextWriter, vtkPolyDataWriter, vtkUnstructuredGridWriter, vtkIVWriter, vtkRectilinearGridWriter, vtkStructuredGridWriter, vtkAbstractParticleWriter, vtkJavaScriptDataWriter, vtkGeoJSONWriter, vtkNewickTreeWriter, vtkTableWriter, vtkSimplePointsWriter, vtkTableToMySQLWriter, vtkTableToPostgreSQLWriter, vtkTableToSQLiteWriter, vtkDataSetWriter, vtkGraphWriter, vtkStructuredPointsWriter, vtkTreeWriter, vtkTableToDatabaseWriter, and vtkGenericDataObjectWriter.
| static vtkWriter* vtkWriter::SafeDownCast | ( | vtkObjectBase * | o | ) | [static] |
Reimplemented from vtkAlgorithm.
Reimplemented in vtkExodusIIWriter, vtkPExodusIIWriter, vtkMNITagPointWriter, vtkMNIObjectWriter, vtkArrayWriter, vtkArrayDataWriter, vtkDIMACSGraphWriter, vtkPLYWriter, vtkCGMWriter, vtkMCubesWriter, vtkCompositeDataWriter, vtkSTLWriter, vtkDataWriter, vtkBYUWriter, vtkDataObjectWriter, vtkEnSightWriter, vtkPDataSetWriter, vtkDelimitedTextWriter, vtkPolyDataWriter, vtkUnstructuredGridWriter, vtkIVWriter, vtkRectilinearGridWriter, vtkStructuredGridWriter, vtkAbstractParticleWriter, vtkJavaScriptDataWriter, vtkGeoJSONWriter, vtkNewickTreeWriter, vtkTableWriter, vtkSimplePointsWriter, vtkTableToMySQLWriter, vtkTableToPostgreSQLWriter, vtkTableToSQLiteWriter, vtkDataSetWriter, vtkGraphWriter, vtkStructuredPointsWriter, vtkTreeWriter, vtkTableToDatabaseWriter, and vtkGenericDataObjectWriter.
| virtual vtkObjectBase* vtkWriter::NewInstanceInternal | ( | ) | const [protected, virtual] |
Reimplemented from vtkAlgorithm.
Reimplemented in vtkExodusIIWriter, vtkPExodusIIWriter, vtkMNITagPointWriter, vtkMNIObjectWriter, vtkArrayWriter, vtkArrayDataWriter, vtkDIMACSGraphWriter, vtkPLYWriter, vtkCGMWriter, vtkMCubesWriter, vtkCompositeDataWriter, vtkSTLWriter, vtkDataWriter, vtkBYUWriter, vtkDataObjectWriter, vtkEnSightWriter, vtkPDataSetWriter, vtkDelimitedTextWriter, vtkPolyDataWriter, vtkUnstructuredGridWriter, vtkIVWriter, vtkRectilinearGridWriter, vtkStructuredGridWriter, vtkAbstractParticleWriter, vtkJavaScriptDataWriter, vtkGeoJSONWriter, vtkNewickTreeWriter, vtkTableWriter, vtkSimplePointsWriter, vtkTableToMySQLWriter, vtkTableToPostgreSQLWriter, vtkTableToSQLiteWriter, vtkDataSetWriter, vtkGraphWriter, vtkStructuredPointsWriter, vtkTreeWriter, vtkTableToDatabaseWriter, and vtkGenericDataObjectWriter.
| vtkWriter* vtkWriter::NewInstance | ( | ) | const |
Reimplemented from vtkAlgorithm.
Reimplemented in vtkExodusIIWriter, vtkPExodusIIWriter, vtkMNITagPointWriter, vtkMNIObjectWriter, vtkArrayWriter, vtkArrayDataWriter, vtkDIMACSGraphWriter, vtkPLYWriter, vtkCGMWriter, vtkMCubesWriter, vtkCompositeDataWriter, vtkSTLWriter, vtkDataWriter, vtkBYUWriter, vtkDataObjectWriter, vtkEnSightWriter, vtkPDataSetWriter, vtkDelimitedTextWriter, vtkPolyDataWriter, vtkUnstructuredGridWriter, vtkIVWriter, vtkRectilinearGridWriter, vtkStructuredGridWriter, vtkAbstractParticleWriter, vtkJavaScriptDataWriter, vtkGeoJSONWriter, vtkNewickTreeWriter, vtkTableWriter, vtkSimplePointsWriter, vtkTableToMySQLWriter, vtkTableToPostgreSQLWriter, vtkTableToSQLiteWriter, vtkDataSetWriter, vtkGraphWriter, vtkStructuredPointsWriter, vtkTreeWriter, vtkTableToDatabaseWriter, and vtkGenericDataObjectWriter.
| 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 vtkExodusIIWriter, vtkMNITagPointWriter, vtkPExodusIIWriter, vtkMNIObjectWriter, vtkArrayWriter, vtkArrayDataWriter, vtkDIMACSGraphWriter, vtkPLYWriter, vtkCGMWriter, vtkMCubesWriter, vtkCompositeDataWriter, vtkSTLWriter, vtkDataWriter, vtkBYUWriter, vtkDataObjectWriter, vtkEnSightWriter, vtkDelimitedTextWriter, vtkPolyDataWriter, vtkUnstructuredGridWriter, vtkPDataSetWriter, vtkIVWriter, vtkRectilinearGridWriter, vtkStructuredGridWriter, vtkAbstractParticleWriter, vtkJavaScriptDataWriter, vtkNewickTreeWriter, vtkTableWriter, vtkSimplePointsWriter, vtkTableToMySQLWriter, vtkTableToPostgreSQLWriter, vtkTableToSQLiteWriter, vtkGeoJSONWriter, vtkDataSetWriter, vtkGraphWriter, vtkStructuredPointsWriter, vtkTreeWriter, vtkTableToDatabaseWriter, and vtkGenericDataObjectWriter.
| 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 vtkMNITagPointWriter, vtkArrayWriter, vtkArrayDataWriter, and 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::SetInputData | ( | vtkDataObject * | input | ) |
Set/get the input to this writer.
| void vtkWriter::SetInputData | ( | int | index, |
| vtkDataObject * | input | ||
| ) |
Set/get the input to this writer.
Set/get the input to this writer.
Reimplemented in vtkPLYWriter, vtkMNIObjectWriter, vtkEnSightWriter, vtkBYUWriter, vtkDIMACSGraphWriter, vtkMCubesWriter, vtkTableToDatabaseWriter, vtkCompositeDataWriter, vtkSTLWriter, vtkPolyDataWriter, vtkUnstructuredGridWriter, vtkIVWriter, vtkRectilinearGridWriter, vtkStructuredGridWriter, vtkNewickTreeWriter, vtkTableWriter, vtkTableToMySQLWriter, vtkTableToPostgreSQLWriter, vtkTableToSQLiteWriter, vtkDataSetWriter, vtkGraphWriter, vtkStructuredPointsWriter, and vtkTreeWriter.
| vtkDataObject* vtkWriter::GetInput | ( | int | port | ) |
Set/get the input to this writer.
Reimplemented in vtkPLYWriter, vtkMNIObjectWriter, vtkBYUWriter, vtkDIMACSGraphWriter, vtkMCubesWriter, vtkTableToDatabaseWriter, vtkCompositeDataWriter, vtkSTLWriter, vtkPolyDataWriter, vtkUnstructuredGridWriter, vtkIVWriter, vtkRectilinearGridWriter, vtkStructuredGridWriter, vtkNewickTreeWriter, vtkTableWriter, vtkTableToMySQLWriter, vtkTableToPostgreSQLWriter, vtkTableToSQLiteWriter, vtkDataSetWriter, vtkGraphWriter, vtkStructuredPointsWriter, and vtkTreeWriter.
| 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, and vtkMNITagPointWriter.
| virtual void vtkWriter::WriteData | ( | ) | [protected, pure virtual] |
Implemented in vtkExodusIIWriter, vtkDataWriter, vtkMNITagPointWriter, vtkMNIObjectWriter, vtkPLYWriter, vtkArrayWriter, vtkArrayDataWriter, vtkEnSightWriter, vtkCGMWriter, vtkBYUWriter, vtkGeoJSONWriter, vtkDelimitedTextWriter, vtkAbstractParticleWriter, vtkJavaScriptDataWriter, vtkMCubesWriter, vtkSTLWriter, vtkDIMACSGraphWriter, vtkDataObjectWriter, vtkNewickTreeWriter, vtkIVWriter, vtkCompositeDataWriter, vtkTableToDatabaseWriter, vtkPolyDataWriter, vtkUnstructuredGridWriter, vtkRectilinearGridWriter, vtkStructuredGridWriter, vtkTableWriter, vtkDataSetWriter, vtkGraphWriter, vtkStructuredPointsWriter, vtkTreeWriter, vtkTableToMySQLWriter, vtkTableToPostgreSQLWriter, vtkTableToSQLiteWriter, vtkSimplePointsWriter, and vtkGenericDataObjectWriter.
Member Data Documentation
vtkTimeStamp vtkWriter::WriteTime [protected] |
Definition at line 90 of file vtkWriter.h.
The documentation for this class was generated from the following file:
- /Users/kitware/Dashboards/MyTests/VTK_BLD_Release_docs/Utilities/Doxygen/dox/IO/Core/vtkWriter.h
