ParaView
pqServerResource.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: ParaView
4  Module: pqServerResource.h
5 
6  Copyright (c) 2005-2008 Sandia Corporation, Kitware Inc.
7  All rights reserved.
8 
9  ParaView is a free software; you can redistribute it and/or modify it
10  under the terms of the ParaView license version 1.2.
11 
12  See License_v1.2.txt for the full ParaView license.
13  A copy of this license can be obtained by contacting
14  Kitware Inc.
15  28 Corporate Drive
16  Clifton Park, NY 12065
17  USA
18 
19 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR
23 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24 EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25 PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 
31 =========================================================================*/
32 
33 #ifndef _pqServerResource_h
34 #define _pqServerResource_h
35 
36 #include "pqCoreModule.h"
37 
38 #include <QString>
40 
102 class PQCORE_EXPORT pqServerResource
103 {
104 public:
106  pqServerResource(const QString&);
107  pqServerResource(const QString&, const pqServerConfiguration&);
109  pqServerResource& operator=(const pqServerResource&);
110  ~pqServerResource();
111 
116  const pqServerConfiguration& configuration() const;
117 
121  const QString toURI() const;
122 
127  const QString serializeString() const;
128 
131  const QString scheme() const;
135  void setScheme(const QString&);
136 
139  const QString host() const;
143  void setHost(const QString&);
144 
145  int port() const;
146  int port(int default_port) const;
147  void setPort(int);
148 
149  const QString dataServerHost() const;
150  void setDataServerHost(const QString&);
151 
152  int dataServerPort() const;
153  int dataServerPort(int default_port) const;
154  void setDataServerPort(int);
155 
156  const QString renderServerHost() const;
157  void setRenderServerHost(const QString&);
158 
159  int renderServerPort() const;
160  int renderServerPort(int default_port) const;
161  void setRenderServerPort(int);
162 
163  const QString path() const;
164  void setPath(const QString&);
165 
166  const pqServerResource sessionServer() const;
167  void setSessionServer(const pqServerResource&);
168 
169  // add extra data to this resource
170  void addData(const QString& key, const QString& value);
171  // get extra data from this resource
172  const QString data(const QString& key) const;
173  const QString data(const QString& key, const QString& default_value) const;
174  bool hasData(const QString& key) const;
175 
178  const pqServerResource schemeHostsPorts() const;
181  const pqServerResource schemeHosts() const;
184  const pqServerResource hostPath() const;
185 
186  bool operator==(const pqServerResource&) const;
187  bool operator!=(const pqServerResource&) const;
188  bool operator<(const pqServerResource&) const;
189 
190 private:
191  class pqImplementation;
192  pqImplementation* const Implementation;
193 };
194 
195 #endif
pqServerConfiguration corresponds to a server connection configuration.
pqServerResource encapsulates a resource in ParaView.