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 
100 class PQCORE_EXPORT pqServerResource
101 {
102 public:
104  pqServerResource(const QString&);
105  pqServerResource(const QString&, const pqServerConfiguration&);
107  pqServerResource& operator=(const pqServerResource&);
108  ~pqServerResource();
109 
112  const pqServerConfiguration& configuration() const;
113 
115  const QString toURI() const;
116 
119  const QString serializeString() const;
120 
123  const QString scheme() const;
125  void setScheme(const QString&);
126 
129  const QString host() const;
131  void setHost(const QString&);
132 
133  int port() const;
134  int port(int default_port) const;
135  void setPort(int);
136 
137  const QString dataServerHost() const;
138  void setDataServerHost(const QString&);
139 
140  int dataServerPort() const;
141  int dataServerPort(int default_port) const;
142  void setDataServerPort(int);
143 
144  const QString renderServerHost() const;
145  void setRenderServerHost(const QString&);
146 
147  int renderServerPort() const;
148  int renderServerPort(int default_port) const;
149  void setRenderServerPort(int);
150 
151  const QString path() const;
152  void setPath(const QString&);
153 
154  const pqServerResource sessionServer() const;
155  void setSessionServer(const pqServerResource&);
156 
157  // add extra data to this resource
158  void addData(const QString& key, const QString& value);
159  // get extra data from this resource
160  const QString data(const QString& key) const;
161  const QString data(const QString& key, const QString& default_value) const;
162  bool hasData(const QString& key) const;
163 
166  const pqServerResource schemeHostsPorts() const;
169  const pqServerResource schemeHosts() const;
172  const pqServerResource hostPath() const;
173 
174  bool operator==(const pqServerResource&) const;
175  bool operator!=(const pqServerResource&) const;
176  bool operator<(const pqServerResource&) const;
177 
178 private:
179  class pqImplementation;
180  pqImplementation* const Implementation;
181 };
182 
183 #endif
pqServerConfiguration corresponds to a server connection configuration.
pqServerResource encapsulates a resource in ParaView.