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
|
/*=========================================================================
Program: ParaView
Module: vtkSMProxyConfigurationWriter.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.
=========================================================================*/
// .NAME vtkSMProxyConfigurationWriter - Base readers of a vtkSMProxy's vtkSMProperty's.
//
// .SECTION Description
// vtkSMProxyConfigurationWriter writes state for properties for a single
// proxy. Internally the ParaView state machinery is employed.
//
// The notion of proxy configuration is similar to state but lighter
// as the proxy its domains and and its server side objects are assumed to
// already exist. Configuration also provides subseting mechanism so that
// properties may be excluded if needed.
//
// Subsetting is achieved through a specialized iterator derived from
// vtkSMPropertyIterator.
//
// .SECTION See also
// vtkSMProxyConfigurationReader, vtkSMPropertyIterator, vtkSMNamedPropertyIterator
//
// .SECTION Thanks
// This class was contribued by SciberQuest Inc.
#ifndef vtkSMProxyConfigurationWriter_h
#define vtkSMProxyConfigurationWriter_h
#include "vtkPVServerManagerDefaultModule.h" //needed for exports
#include "vtkSMObject.h"
class vtkSMPropertyIterator;
class vtkSMProxy;
class vtkStringList;
class VTKPVSERVERMANAGERDEFAULT_EXPORT vtkSMProxyConfigurationWriter : public vtkSMObject
{
public:
static vtkSMProxyConfigurationWriter* New();
vtkTypeMacro(vtkSMProxyConfigurationWriter, vtkSMObject);
virtual void PrintSelf(ostream& os, vtkIndent indent);
// Description:
// Set the proxy to write out.
virtual void SetProxy(vtkSMProxy *proxy);
vtkGetObjectMacro(Proxy,vtkSMProxy);
// Description:
// Set the ieterator used to traverse properties during the write.
// If no iterator is set then all properties are written.
virtual void SetPropertyIterator(vtkSMPropertyIterator *iter);
vtkGetObjectMacro(PropertyIterator,vtkSMPropertyIterator);
// Description:
// Set/Get the file name.
vtkSetStringMacro(FileName);
vtkGetStringMacro(FileName);
// Description:
// Set/get file meta data.
vtkSetStringMacro(FileIdentifier);
vtkGetStringMacro(FileIdentifier);
vtkSetStringMacro(FileDescription);
vtkGetStringMacro(FileDescription);
vtkSetStringMacro(FileExtension);
vtkGetStringMacro(FileExtension);
// Description:
// Return the writer version string.
virtual const char *GetWriterVersion(){ return "1.0"; }
// Description:
// Write the proxy's state directly to an XML file, in PV state format.
virtual int WriteConfiguration();
virtual int WriteConfiguration(const char *fileName);
// Description:
// Write the proxy's state to a stream, in PV state format.
virtual int WriteConfiguration(ostream &os);
protected:
vtkSMProxyConfigurationWriter();
virtual ~vtkSMProxyConfigurationWriter();
private:
vtkSMProxyConfigurationWriter(const vtkSMProxyConfigurationWriter&); // Not implemented
void operator=(const vtkSMProxyConfigurationWriter&); // Not implemented
private:
char *FileName;
//-------------------
vtkSMProxy *Proxy;
vtkSMPropertyIterator *PropertyIterator;
//-------------------
char *FileIdentifier;
char *FileDescription;
char *FileExtension;
};
#endif
|
