is a factory or creating a writer based on the data type information from the output port. More...
#include <vtkSMWriterFactory.h>
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| void | Initialize () |
| void | RegisterPrototypes (vtkSMSession *session, const char *xmlgroup) |
| bool | CanWrite (vtkSMSourceProxy *, unsigned int outputport) |
| unsigned int | GetNumberOfRegisteredPrototypes () |
| void | RegisterPrototype (const char *xmlgroup, const char *xmlname) |
| void | UnRegisterPrototype (const char *xmlgroup, const char *xmlname) |
| bool | LoadConfigurationFile (const char *filename) |
| bool | LoadConfiguration (const char *xmlcontents) |
| bool | LoadConfiguration (vtkPVXMLElement *root) |
| vtkSMProxy * | CreateWriter (const char *filename, vtkSMSourceProxy *, unsigned int outputport) |
| vtkSMProxy * | CreateWriter (const char *filename, vtkSMSourceProxy *pxy) |
| const char * | GetSupportedFileTypes (vtkSMSourceProxy *source, unsigned int outputport) |
| const char * | GetSupportedFileTypes (vtkSMSourceProxy *source) |
Static Public Member Functions | |
| static vtkSMWriterFactory * | New () |
| static int | IsTypeOf (const char *type) |
| static vtkSMWriterFactory * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
| vtkSMWriterFactory () | |
| ~vtkSMWriterFactory () | |
| void | RegisterPrototype (const char *xmlgroup, const char *xmlname, const char *extensions, const char *description) |
Detailed Description
is a factory or creating a writer based on the data type information from the output port.
vtkSMWriterFactory is a factory for creating a writer to write the data provided at an output port. The writer factory needs to be configured to register the writer prototypes supported by the application. This can be done using an XML with the following format:
<ParaViewWriters>
<Proxy name="[xmlname for the writer proxy]"
group="[optional: xmlgroup for the writer proxy, 'writers' by default]"
/>
...
</ParaViewWriters>
Alternatively, one can register prototypes using RegisterPrototype API. The proxy definitions for the writer proxies must provide hints that indicate the file extension and description for the writer.
Once the factory has been configured, the API to create writers, get available writers etc. can be used.
Definition at line 51 of file vtkSMWriterFactory.h.
Constructor & Destructor Documentation
| vtkSMWriterFactory::vtkSMWriterFactory | ( | ) | [protected] |
| vtkSMWriterFactory::~vtkSMWriterFactory | ( | ) | [protected] |
Member Function Documentation
| static vtkSMWriterFactory* vtkSMWriterFactory::New | ( | ) | [static] |
Reimplemented from vtkSMObject.
| virtual const char* vtkSMWriterFactory::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkSMObject.
| static int vtkSMWriterFactory::IsTypeOf | ( | const char * | type | ) | [static] |
Reimplemented from vtkSMObject.
| virtual int vtkSMWriterFactory::IsA | ( | const char * | type | ) | [virtual] |
Reimplemented from vtkSMObject.
| static vtkSMWriterFactory* vtkSMWriterFactory::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkSMObject.
| void vtkSMWriterFactory::PrintSelf | ( | ostream & | os, |
| vtkIndent | indent | ||
| ) | [virtual] |
Reimplemented from vtkSMObject.
| void vtkSMWriterFactory::Initialize | ( | ) |
Cleanup all registered prototypes.
| void vtkSMWriterFactory::RegisterPrototype | ( | const char * | xmlgroup, |
| const char * | xmlname | ||
| ) |
Register a prototype.
| void vtkSMWriterFactory::UnRegisterPrototype | ( | const char * | xmlgroup, |
| const char * | xmlname | ||
| ) |
Register a prototype.
| void vtkSMWriterFactory::RegisterPrototypes | ( | vtkSMSession * | session, |
| const char * | xmlgroup | ||
| ) |
Registers all prototypes from a particular group that have the "ReaderFactory" hint.
| bool vtkSMWriterFactory::LoadConfigurationFile | ( | const char * | filename | ) |
Load configuration XML. This adds the prototypes specified in the configuration XML to those already present in the factory. Use Initialize() is start with an empty factory before calling this method if needed. If two readers support reading the same file, the reader added more recently is given priority.
| bool vtkSMWriterFactory::LoadConfiguration | ( | const char * | xmlcontents | ) |
Load configuration XML. This adds the prototypes specified in the configuration XML to those already present in the factory. Use Initialize() is start with an empty factory before calling this method if needed. If two readers support reading the same file, the reader added more recently is given priority.
| bool vtkSMWriterFactory::LoadConfiguration | ( | vtkPVXMLElement * | root | ) |
Load configuration XML. This adds the prototypes specified in the configuration XML to those already present in the factory. Use Initialize() is start with an empty factory before calling this method if needed. If two readers support reading the same file, the reader added more recently is given priority.
| bool vtkSMWriterFactory::CanWrite | ( | vtkSMSourceProxy * | , |
| unsigned int | outputport | ||
| ) |
Retruns true if the data from the output port can be written at all.
| vtkSMProxy* vtkSMWriterFactory::CreateWriter | ( | const char * | filename, |
| vtkSMSourceProxy * | , | ||
| unsigned int | outputport | ||
| ) |
Create a new writer proxy to write the data from the specified output port to the file specified, if possible. As internally UpdatePipeline() will be called on the source proxy, in order to prevent a double pipeline execution when you want to write a given timestep, you should call updatePipeline( time ) before the CreateWriter call.
| vtkSMProxy* vtkSMWriterFactory::CreateWriter | ( | const char * | filename, |
| vtkSMSourceProxy * | pxy | ||
| ) | [inline] |
Create a new writer proxy to write the data from the specified output port to the file specified, if possible. As internally UpdatePipeline() will be called on the source proxy, in order to prevent a double pipeline execution when you want to write a given timestep, you should call updatePipeline( time ) before the CreateWriter call.
Definition at line 94 of file vtkSMWriterFactory.h.
| const char* vtkSMWriterFactory::GetSupportedFileTypes | ( | vtkSMSourceProxy * | source, |
| unsigned int | outputport | ||
| ) |
Returns a formatted string with all supported file types. An example returned string would look like:
"PVD Files (*.pvd);;VTK
Files (*.vtk)" | const char* vtkSMWriterFactory::GetSupportedFileTypes | ( | vtkSMSourceProxy * | source | ) | [inline] |
Returns a formatted string with all supported file types. An example returned string would look like:
"PVD Files (*.pvd);;VTK
Files (*.vtk)" Definition at line 104 of file vtkSMWriterFactory.h.
| unsigned int vtkSMWriterFactory::GetNumberOfRegisteredPrototypes | ( | ) |
| void vtkSMWriterFactory::RegisterPrototype | ( | const char * | xmlgroup, |
| const char * | xmlname, | ||
| const char * | extensions, | ||
| const char * | description | ||
| ) | [protected] |
The documentation for this class was generated from the following file:
- dox/ParaViewCore/ServerManager/vtkSMWriterFactory.h
