ParaView
|
is a factory or creating a writer based on the data type information from the output port. More...
#include <vtkSMWriterFactory.h>
Public Types | |
typedef vtkSMObject | Superclass |
![]() | |
typedef vtkObject | Superclass |
Public Member Functions | |
virtual const char * | GetClassName () |
virtual int | IsA (const char *type) |
void | PrintSelf (ostream &os, vtkIndent indent) |
void | Initialize () |
Cleanup all registered prototypes. More... | |
void | RegisterPrototype (const char *xmlgroup, const char *xmlname) |
Register a prototype. More... | |
bool | CanWrite (vtkSMSourceProxy *, unsigned int outputport) |
Retruns true if the data from the output port can be written at all. More... | |
vtkSMProxy * | 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. More... | |
vtkSMProxy * | CreateWriter (const char *filename, vtkSMSourceProxy *pxy) |
const char * | GetSupportedFileTypes (vtkSMSourceProxy *source, unsigned int outputport) |
Returns a formatted string with all supported file types. More... | |
const char * | GetSupportedFileTypes (vtkSMSourceProxy *source) |
unsigned int | GetNumberOfRegisteredPrototypes () |
void | UpdateAvailableWriters () |
Every time a new proxy definition is added we check to see if it is a writer and then we add it to the list of available writers. More... | |
void | AddGroup (const char *groupName) |
Add/remove a group name to look for writers in. More... | |
void | RemoveGroup (const char *groupName) |
Add/remove a group name to look for writers in. More... | |
void | GetGroups (vtkStringList *groups) |
Add/remove a group name to look for writers in. More... | |
![]() | |
void | PrintSelf (ostream &os, vtkIndent indent) |
Static Public Member Functions | |
static vtkSMWriterFactory * | New () |
static int | IsTypeOf (const char *type) |
static vtkSMWriterFactory * | SafeDownCast (vtkObject *o) |
static void | AddWriterToWhitelist (const char *writerxmlgroup, const char *writerxmlname) |
This function is for ParaView based applications that only wish to expose a subset of the writers. More... | |
![]() | |
static vtkSMObject * | New () |
static int | IsTypeOf (const char *type) |
static vtkSMObject * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
vtkSMWriterFactory () | |
~vtkSMWriterFactory () | |
![]() | |
vtkSMObject () | |
~vtkSMObject () | |
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. This is done whenever a new proxy definition is added in the writers group.
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 45 of file vtkSMWriterFactory.h.
Definition at line 49 of file vtkSMWriterFactory.h.
|
protected |
|
protected |
|
static |
|
virtual |
Reimplemented from vtkSMObject.
|
static |
|
virtual |
Reimplemented from vtkSMObject.
|
static |
void vtkSMWriterFactory::PrintSelf | ( | ostream & | os, |
vtkIndent | indent | ||
) |
void vtkSMWriterFactory::Initialize | ( | ) |
Cleanup all registered prototypes.
void vtkSMWriterFactory::RegisterPrototype | ( | const char * | xmlgroup, |
const char * | xmlname | ||
) |
Register a prototype.
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.
|
inline |
Definition at line 76 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)" *
|
inline |
Definition at line 89 of file vtkSMWriterFactory.h.
unsigned int vtkSMWriterFactory::GetNumberOfRegisteredPrototypes | ( | ) |
void vtkSMWriterFactory::UpdateAvailableWriters | ( | ) |
Every time a new proxy definition is added we check to see if it is a writer and then we add it to the list of available writers.
void vtkSMWriterFactory::AddGroup | ( | const char * | groupName | ) |
Add/remove a group name to look for writers in.
By default "writers" is included.
void vtkSMWriterFactory::RemoveGroup | ( | const char * | groupName | ) |
Add/remove a group name to look for writers in.
By default "writers" is included.
void vtkSMWriterFactory::GetGroups | ( | vtkStringList * | groups | ) |
Add/remove a group name to look for writers in.
By default "writers" is included.
|
static |
This function is for ParaView based applications that only wish to expose a subset of the writers.
If this function is never called, the reader factory will expose all the writers as it has in the past. However, if any writers are specified by passing their group name and reader name to this function, then only those writers will be available in any reader factories created by the application. This is intended to be called at the begining of the application's execution before any sessions are created.