vtkSMProxyConfigurationReader.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
2 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
3 // SPDX-License-Identifier: BSD-3-Clause
27 #ifndef vtkSMProxyConfigurationReader_h
28 #define vtkSMProxyConfigurationReader_h
29 
30 #include "vtkRemotingMiscModule.h" //needed for exports
31 #include "vtkSMObject.h"
32 
33 class vtkPVXMLElement;
34 class vtkSMProxy;
35 
36 class VTKREMOTINGMISC_EXPORT vtkSMProxyConfigurationReader : public vtkSMObject
37 {
38 public:
41  void PrintSelf(ostream& os, vtkIndent indent) override;
42 
44 
47  vtkSetStringMacro(FileName);
48  vtkGetStringMacro(FileName);
50 
52 
55  virtual void SetProxy(vtkSMProxy* proxy);
56  vtkGetObjectMacro(Proxy, vtkSMProxy);
58 
60 
63  vtkSetStringMacro(FileIdentifier);
64  vtkGetStringMacro(FileIdentifier);
66 
67  vtkSetStringMacro(FileDescription);
68  vtkGetStringMacro(FileDescription);
69 
70  vtkSetStringMacro(FileExtension);
71  vtkGetStringMacro(FileExtension);
72 
74 
80  vtkSetMacro(ValidateProxyType, int);
81  vtkGetMacro(ValidateProxyType, int);
83 
87  virtual const char* GetReaderVersion() { return "1.0"; }
88 
92  virtual bool CanReadVersion(const char* version);
93 
95 
101  virtual int ReadConfiguration();
102  virtual int ReadConfiguration(const char* filename);
104 
108  virtual int ReadConfiguration(vtkPVXMLElement* xmlStream);
109 
110 protected:
112  ~vtkSMProxyConfigurationReader() override;
113 
114 private:
115  char* FileName;
116  int ValidateProxyType;
117  //-------------------
118  vtkSMProxy* Proxy;
119  //-------------------
120  char* FileIdentifier;
121  char* FileDescription;
122  char* FileExtension;
123 
125  void operator=(const vtkSMProxyConfigurationReader&) = delete;
126 };
127 
128 #endif
vtkSMObject
superclass for most server manager classes
Definition: vtkSMObject.h:17
vtkSMObject::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
vtkSMObject.h
vtkSMProxy
proxy for a VTK object(s) on a server
Definition: vtkSMProxy.h:140
vtkSMProxyConfigurationReader::GetReaderVersion
virtual const char * GetReaderVersion()
Return the reader version.
Definition: vtkSMProxyConfigurationReader.h:87
vtkIndent
vtkPVXMLElement
Definition: vtkPVXMLElement.h:23
vtkSMObject::New
static vtkSMObject * New()
vtkSMProxyConfigurationReader
Base readers of a vtkSMProxy's vtkSMProperty's.
Definition: vtkSMProxyConfigurationReader.h:36