ParaView
pqOptions.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: ParaView
4  Module: pqOptions.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 pqOptions_h
34 #define pqOptions_h
35 
36 #include "pqCoreModule.h"
37 #include <QStringList>
38 #include <vtkPVOptions.h>
39 
45 class PQCORE_EXPORT pqOptions : public vtkPVOptions
46 {
47 public:
48  static pqOptions *New();
49  vtkTypeMacro(pqOptions, vtkPVOptions);
50  void PrintSelf(ostream &os, vtkIndent indent);
51 
52  vtkGetStringMacro(TileImagePath);
53  vtkGetStringMacro(BaselineDirectory);
54  vtkGetStringMacro(TestDirectory);
55  vtkGetStringMacro(DataDirectory);
56 
57  vtkGetMacro(ExitAppWhenTestsDone, int);
58 
59  // Returns the test scripts as a list.
60  QStringList GetTestScripts();
61 
64  vtkGetStringMacro(ServerResourceName);
65 
66  vtkSetStringMacro(TileImagePath);
67  vtkSetStringMacro(BaselineDirectory);
68  vtkSetStringMacro(TestDirectory);
69  vtkSetStringMacro(DataDirectory);
70 
72  { return this->TestScripts.size(); }
73  QString GetTestScript(int cc)
74  { return this->TestScripts[cc].TestFile; }
75  QString GetTestBaseline(int cc)
76  { return this->TestScripts[cc].TestBaseline; }
78  { return this->TestScripts[cc].ImageThreshold; }
79 
83  vtkSetMacro(CurrentImageThreshold, int);
84  vtkGetMacro(CurrentImageThreshold, int);
85 
86  // Description:
87  // These flags are used for testing multi-clients configurations.
88  vtkGetMacro(TestMaster, int);
89  vtkGetMacro(TestSlave, int);
90 
91  // Description:
92  // Using --script option, user can specify a python script to be run on
93  // startup. This have any effect only when ParaView is built with Python
94  // support.
95  vtkGetStringMacro(PythonScript);
96 
97  // DO NOT CALL. Public for internal callbacks.
98  int AddTestScript(const char*);
99  int SetLastTestBaseline(const char*);
100  int SetLastTestImageThreshold(int);
101 
102 protected:
103  pqOptions();
104  virtual ~pqOptions();
105 
106  virtual void Initialize();
107  virtual int PostProcess(int argc, const char * const *argv);
108 
114 
121 
122  vtkSetStringMacro(PythonScript);
123  vtkSetStringMacro(ServerResourceName);
124 
125  struct TestInfo
126  {
127  QString TestFile;
128  QString TestBaseline;
130  TestInfo():ImageThreshold(12) { }
131  };
132 
133  QList<TestInfo> TestScripts;
134 
135  // Description:
136  // This method is called when wrong argument is found. If it returns 0, then
137  // the parsing will fail.
138  virtual int WrongArgument(const char* argument);
139 private:
140  pqOptions(const pqOptions &);
141  void operator=(const pqOptions &);
142 };
143 
144 #endif //pqOptions_h
145 
int DisableRegistry
Definition: pqOptions.h:116
char * DataDirectory
Definition: pqOptions.h:111
QList< TestInfo > TestScripts
Definition: pqOptions.h:133
QString TestBaseline
Definition: pqOptions.h:128
int ExitAppWhenTestsDone
Definition: pqOptions.h:115
char * TestDirectory
Definition: pqOptions.h:110
int TestMaster
Definition: pqOptions.h:118
int TestSlave
Definition: pqOptions.h:119
char * TileImagePath
Definition: pqOptions.h:113
char * ServerResourceName
Definition: pqOptions.h:112
QString GetTestScript(int cc)
Definition: pqOptions.h:73
char * BaselineDirectory
Definition: pqOptions.h:109
char * PythonScript
Definition: pqOptions.h:120
int GetTestImageThreshold(int cc)
Definition: pqOptions.h:77
int CurrentImageThreshold
Definition: pqOptions.h:117
QString GetTestBaseline(int cc)
Definition: pqOptions.h:75
int GetNumberOfTestScripts()
Definition: pqOptions.h:71
Command line options for pqClient.
Definition: pqOptions.h:45