pqServerResource.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
2 // SPDX-FileCopyrightText: Copyright (c) Sandia Corporation
3 // SPDX-License-Identifier: BSD-3-Clause
4 
5 #ifndef pqServerResource_h
6 #define pqServerResource_h
7 
8 #include "pqCoreModule.h"
9 
10 #include <QString>
12 
72 {
73 public:
76  pqServerResource& operator=(const pqServerResource&);
77 
81  pqServerResource(const QString& uri);
82 
87  pqServerResource(const QString& uri, const pqServerConfiguration& config);
88 
93 
97  const pqServerConfiguration& configuration() const;
98 
102  QString toURI() const;
103 
107  QString serializeString() const;
108 
112  QString scheme() const;
113 
117  void setScheme(const QString&);
118 
122  bool isReverse() const;
123 
127  QString host() const;
128 
132  void setHost(const QString&);
133 
137  int port() const;
138 
142  int port(int default_port) const;
143 
147  void setPort(int);
148 
152  QString dataServerHost() const;
153 
157  void setDataServerHost(const QString&);
158 
162  int dataServerPort() const;
163 
167  int dataServerPort(int default_port) const;
168 
172  void setDataServerPort(int);
173 
177  QString renderServerHost() const;
178 
182  void setRenderServerHost(const QString&);
183 
187  int renderServerPort() const;
188 
192  int renderServerPort(int default_port) const;
193 
197  void setRenderServerPort(int);
198 
202  QString path() const;
203 
207  void setPath(const QString&);
208 
212  QString serverName() const;
213 
217  void setServerName(const QString& name);
218 
222  void addData(const QString& key, const QString& value);
223 
227  QString data(const QString& key) const;
228 
233  QString data(const QString& key, const QString& default_value) const;
234 
238  bool hasData(const QString& key) const;
239 
244  pqServerResource schemeHostsPorts() const;
245 
250  pqServerResource schemeHosts() const;
251 
256  pqServerResource hostPath() const;
257 
262  pqServerResource pathServerName() const;
263 
265 
268  bool operator==(const pqServerResource&) const;
269  bool operator!=(const pqServerResource&) const;
270  bool operator<(const pqServerResource&) const;
272 
273 private:
274  class pqImplementation;
275  pqImplementation* const Implementation;
276 };
277 
278 #endif
data
VTKCOMMONCORE_EXPORT bool operator<(const vtkUnicodeString &lhs, const vtkUnicodeString &rhs)
name
#define PQCORE_EXPORT
Definition: pqCoreModule.h:15
value
VTKCOMMONCORE_EXPORT bool operator!=(const vtkUnicodeString &lhs, const vtkUnicodeString &rhs)
pqServerConfiguration corresponds to a server connection configuration.
VTKCOMMONCORE_EXPORT bool operator==(const vtkUnicodeString &lhs, const vtkUnicodeString &rhs)
port
pqServerResource encapsulates a resource in ParaView.
key