ParaView
pqServerConfiguration.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 pqServerConfiguration_h
33 #define pqServerConfiguration_h
34 
35 #include "pqCoreModule.h"
36 #include "vtkSmartPointer.h"
37 #include <QObject>
38 
39 class vtkPVXMLElement;
40 class pqServerResource;
41 class vtkIndent;
42 
47 class PQCORE_EXPORT pqServerConfiguration
48 {
49 public:
53 
58  bool isMutable() const { return this->Mutable; }
59  void setMutable(bool val) { this->Mutable = val; }
60 
64  void setName(const QString& name);
65  QString name() const;
66 
72  bool isNameDefault() const;
73 
77  pqServerResource resource() const;
78  void setResource(const pqServerResource&);
79  void setResource(const QString&);
80 
85  {
88  COMMAND
89  };
90 
95  StartupType startupType() const;
96 
102  QString command(double& timeout, double& delay) const;
103 
107  void setStartupToManual();
108 
112  void setStartupToCommand(double timeout, double delay, const QString& command);
113 
117  QString toString(vtkIndent indent) const;
118 
122  pqServerConfiguration clone() const;
123 
127  vtkPVXMLElement* optionsXML() const;
128 
132  vtkPVXMLElement* hintsXML() const;
133 
134 protected:
135  vtkPVXMLElement* startupXML() const;
136 
137 private:
138  void constructor(vtkPVXMLElement*);
139  bool Mutable;
140  vtkSmartPointer<vtkPVXMLElement> XML;
141 };
142 
143 #endif
bool isMutable() const
Get/Set whether the configuration is mutable.
pqServerConfiguration corresponds to a server connection configuration.
This is used by vtkPVXMLParser to represent an XML document starting at the root element.
pqServerResource encapsulates a resource in ParaView.