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
138
139
140
|
/*=========================================================================
Program: Visualization Toolkit
Module: vtkSMProxyConfigurationReader.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm 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 vtkSMProxyConfigurationReader
* @brief Base readers of a vtkSMProxy's vtkSMProperty's.
*
*
* vtkSMProxyConfigurationReader reads 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.
*
* The subsetting mechanism is implemented in the writer, the reader simply
* reads which ever properties are found.
*
* @sa
* vtkSMProxyConfigurationWriter
*
* @par Thanks:
* This class was contribued by SciberQuest Inc.
*/
#ifndef vtkSMProxyConfigurationReader_h
#define vtkSMProxyConfigurationReader_h
#include "vtkPVServerManagerDefaultModule.h" //needed for exports
#include "vtkSMObject.h"
class vtkPVXMLElement;
class vtkSMProxy;
class VTKPVSERVERMANAGERDEFAULT_EXPORT vtkSMProxyConfigurationReader : public vtkSMObject
{
public:
static vtkSMProxyConfigurationReader* New();
vtkTypeMacro(vtkSMProxyConfigurationReader, vtkSMObject);
void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;
//@{
/**
* Set/Get the file name.
*/
vtkSetStringMacro(FileName);
vtkGetStringMacro(FileName);
//@}
//@{
/**
* Set the proxy to write out.
*/
virtual void SetProxy(vtkSMProxy* proxy);
vtkGetObjectMacro(Proxy, vtkSMProxy);
//@}
//@{
/**
* Set/get file meta data.
*/
vtkSetStringMacro(FileIdentifier);
vtkGetStringMacro(FileIdentifier);
//@}
vtkSetStringMacro(FileDescription);
vtkGetStringMacro(FileDescription);
vtkSetStringMacro(FileExtension);
vtkGetStringMacro(FileExtension);
//@{
/**
* Turns on/off proxy type validation. If on then the proxy's
* type is compared with that found in the configuration file.
* The read fails if they do not match. The feature is on by
* default.
*/
vtkSetMacro(ValidateProxyType, int);
vtkGetMacro(ValidateProxyType, int);
//@}
/**
* Return the reader version.
*/
virtual const char* GetReaderVersion() { return "1.0"; }
/**
* Return true if the reader can read the specified version.
*/
virtual bool CanReadVersion(const char* version);
//@{
/**
* Read the configuration from the file. UpdateVTKObjects
* is intentionally not called so that caller may have full
* control as to when the push from client to server takes
* place.
*/
virtual int ReadConfiguration();
virtual int ReadConfiguration(const char* filename);
//@}
/**
* Read the configuration from the stream. PV state machinery is
* employed.
*/
virtual int ReadConfiguration(vtkPVXMLElement* xmlStream);
protected:
vtkSMProxyConfigurationReader();
virtual ~vtkSMProxyConfigurationReader();
private:
char* FileName;
int ValidateProxyType;
//-------------------
vtkSMProxy* Proxy;
//-------------------
char* FileIdentifier;
char* FileDescription;
char* FileExtension;
private:
vtkSMProxyConfigurationReader(const vtkSMProxyConfigurationReader&) VTK_DELETE_FUNCTION;
void operator=(const vtkSMProxyConfigurationReader&) VTK_DELETE_FUNCTION;
};
#endif
|
