pqServerLauncher.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: ParaView
4  Module: $RCSfile$
5 
6  Copyright (c) 2005,2006 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 #ifndef pqServerLauncher_h
33 #define pqServerLauncher_h
34 
35 #include "pqComponentsModule.h"
36 #include <QObject>
37 #include <QProcess> // needed for QProcess::ProcessError.
38 
39 class pqServer;
41 class QDialog;
42 class QProcessEnvironment;
43 class vtkObject;
44 
57 class PQCOMPONENTS_EXPORT pqServerLauncher : public QObject
58 {
59  Q_OBJECT
60  typedef QObject Superclass;
61 
62 public:
63  pqServerLauncher(const pqServerConfiguration& configuration, QObject* parent = nullptr);
64  ~pqServerLauncher() override;
65 
73  static const QMetaObject* setServerDefaultLauncherType(const QMetaObject*);
74  static const QMetaObject* defaultServerLauncherType();
75 
80  static pqServerLauncher* newInstance(
81  const pqServerConfiguration& configuration, QObject* parent = nullptr);
82 
90  bool connectToServer(bool showConnectionDialog = true);
91 
96  pqServer* connectedServer() const;
97 
98 protected Q_SLOTS:
99  void processFailed(QProcess::ProcessError);
100  void readStandardOutput();
101  void readStandardError();
102  void launchServerForReverseConnection();
103 
104 protected: // NOLINT(readability-redundant-access-specifiers)
110  bool promptOptions();
111 
116  virtual bool launchServer(bool show_status_dialog);
117 
121  bool processCommand(QString command, double processWait, double delay,
122  const QProcessEnvironment* options = nullptr);
123 
124  virtual bool connectToPrelaunchedServer(bool showConnectionDialog = true);
125 
126  bool isReverseConnection() const;
127 
133  virtual void prepareDialogForPromptOptions(QDialog&) {}
134 
140  pqServerConfiguration& configuration() const;
141 
145  QProcessEnvironment& options() const;
146 
150  virtual void updateOptionsUsingUserSelections();
151 
157  virtual void handleProcessStandardOutput(const QByteArray& data);
158  virtual void handleProcessErrorOutput(const QByteArray& data);
159 
160 private:
161  Q_DISABLE_COPY(pqServerLauncher)
162 
163  class pqInternals;
164  pqInternals* Internals;
165  static const QMetaObject* DefaultServerLauncherType;
166  bool WrongConnectId;
167 };
168 
169 #endif
data
#define PQCOMPONENTS_EXPORT
pqServerLauncher manages launching of server process using the details specified in the server config...
pqServerConfiguration corresponds to a server connection configuration.
virtual void prepareDialogForPromptOptions(QDialog &)
Subclasses can override this method to further customize the dialog being shown to the user to prompt...
pqServer (should be renamed to pqSession) is a pqServerManagerModelItem subclass that represents a vt...
Definition: pqServer.h:63