1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
|
/*=========================================================================
Program: ParaView
Module: vtkSMWriterFactory.h
Copyright (c) Kitware, Inc.
All rights reserved.
See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
/**
* @class vtkSMWriterFactory
* @brief 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 \c 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.
*/
#ifndef vtkSMWriterFactory_h
#define vtkSMWriterFactory_h
#include "vtkPVServerManagerCoreModule.h" //needed for exports
#include "vtkSMObject.h"
class vtkPVXMLElement;
class vtkSMProxy;
class vtkSMSession;
class vtkSMSessionProxyManager;
class vtkSMSourceProxy;
class vtkStringList;
class VTKPVSERVERMANAGERCORE_EXPORT vtkSMWriterFactory : public vtkSMObject
{
public:
static vtkSMWriterFactory* New();
vtkTypeMacro(vtkSMWriterFactory, vtkSMObject);
void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;
/**
* Cleanup all registered prototypes.
*/
void Initialize();
/**
* Register a prototype.
*/
void RegisterPrototype(const char* xmlgroup, const char* xmlname);
/**
* Retruns true if the data from the output port can be written at all.
*/
bool CanWrite(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* CreateWriter(const char* filename, vtkSMSourceProxy*, unsigned int outputport);
vtkSMProxy* CreateWriter(const char* filename, vtkSMSourceProxy* pxy)
{
return this->CreateWriter(filename, pxy, 0);
}
/**
* Returns a formatted string with all supported file types.
* An example returned string would look like:
* \verbatim
* "PVD Files (*.pvd);;VTK Files (*.vtk)"
* \endverbatim
*/
const char* GetSupportedFileTypes(vtkSMSourceProxy* source, unsigned int outputport);
const char* GetSupportedFileTypes(vtkSMSourceProxy* source)
{
return this->GetSupportedFileTypes(source, 0);
}
// Returns the number of registered prototypes.
unsigned int GetNumberOfRegisteredPrototypes();
/**
* 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 UpdateAvailableWriters();
//@{
/**
* Add/remove a group name to look for writers in. By default
* "writers" is included.
*/
void AddGroup(const char* groupName);
void RemoveGroup(const char* groupName);
void GetGroups(vtkStringList* groups);
//@}
/**
* 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.
*/
static void AddWriterToWhitelist(const char* writerxmlgroup, const char* writerxmlname);
protected:
vtkSMWriterFactory();
~vtkSMWriterFactory();
private:
vtkSMWriterFactory(const vtkSMWriterFactory&) VTK_DELETE_FUNCTION;
void operator=(const vtkSMWriterFactory&) VTK_DELETE_FUNCTION;
class vtkInternals;
vtkInternals* Internals;
};
#endif
|
