Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
pqCoreConfiguration Class Reference

runtime configuration options for ParaView Qt client More...

#include <pqCoreConfiguration.h>

Inherits QObject.

Public Member Functions

const std::string & stateFileName () const
 Returns state file to load on startup, if any. More...
 
const std::vector< std::string > & dataFileNames () const
 Returns data file to load on startup, if any. More...
 
const std::string & pythonScript () const
 Returns the Python script to load on startup, if any. More...
 
const std::string & baselineDirectory () const
 Returns directory where to output test results and temporary files, if any else an empty string is returned. More...
 
const std::string & testDirectory () const
 Returns directory where to output test results and temporary files, if any else an empty string is returned. More...
 
const std::string & dataDirectory () const
 Returns directory containing test data files, if any, else an empty string is returned. More...
 
bool exitApplicationWhenTestsDone () const
 Returns true if the application should exit after test playback is complete. More...
 
int catalystLivePort () const
 When specified, ParaView will attempt to connect a Catalyst Live session at the given port. More...
 
bool populateOptions (vtkCLIOptions *options)
 Populate vtkCLIOptions instance with command line options to control the configurable options provided by this class. More...
 
int testScriptCount () const
 Returns information about tests scripts. More...
 
const std::string & testScript (int index) const
 Returns information about tests scripts. More...
 
const std::string & testBaseline (int index) const
 Returns information about tests scripts. More...
 
int testThreshold (int index) const
 Returns information about tests scripts. More...
 
void setActiveTestIndex (int index)
 A little bit of hack to activate a particular test script. More...
 
const std::string & testScript () const
 A little bit of hack to activate a particular test script. More...
 
const std::string & testBaseline () const
 A little bit of hack to activate a particular test script. More...
 
int testThreshold () const
 A little bit of hack to activate a particular test script. More...
 
bool testMaster () const
 Collaboration testing related flags. More...
 
bool testSlave () const
 Collaboration testing related flags. More...
 

Static Public Member Functions

static pqCoreConfiguration * instance ()
 Provides access to the singleton. More...
 

Protected Member Functions

 pqCoreConfiguration ()
 
 ~pqCoreConfiguration () override
 
class pqPVApplicationCore
 
void addDataFile (const std::string &data)
 

Detailed Description

runtime configuration options for ParaView Qt client

pqCoreConfiguration is a singleton that maintains runtime configuration options for the ParaView Qt client.

See also
vtkCLIOptions, vtkRemotingCoreConfiguration, vtkProcessModuleConfiguration

Definition at line 25 of file pqCoreConfiguration.h.

Constructor & Destructor Documentation

◆ pqCoreConfiguration()

pqCoreConfiguration::pqCoreConfiguration ( )
protected

◆ ~pqCoreConfiguration()

pqCoreConfiguration::~pqCoreConfiguration ( )
overrideprotected

Member Function Documentation

◆ instance()

static pqCoreConfiguration* pqCoreConfiguration::instance ( )
static

Provides access to the singleton.

◆ stateFileName()

const std::string& pqCoreConfiguration::stateFileName ( ) const
inline

Returns state file to load on startup, if any.

Definition at line 37 of file pqCoreConfiguration.h.

◆ dataFileNames()

const std::vector<std::string>& pqCoreConfiguration::dataFileNames ( ) const
inline

Returns data file to load on startup, if any.

Definition at line 42 of file pqCoreConfiguration.h.

◆ pythonScript()

const std::string& pqCoreConfiguration::pythonScript ( ) const
inline

Returns the Python script to load on startup, if any.

Definition at line 47 of file pqCoreConfiguration.h.

◆ baselineDirectory()

const std::string& pqCoreConfiguration::baselineDirectory ( ) const
inline

Returns directory where to output test results and temporary files, if any else an empty string is returned.

Definition at line 53 of file pqCoreConfiguration.h.

◆ testDirectory()

const std::string& pqCoreConfiguration::testDirectory ( ) const
inline

Returns directory where to output test results and temporary files, if any else an empty string is returned.

Definition at line 59 of file pqCoreConfiguration.h.

◆ dataDirectory()

const std::string& pqCoreConfiguration::dataDirectory ( ) const
inline

Returns directory containing test data files, if any, else an empty string is returned.

Definition at line 65 of file pqCoreConfiguration.h.

◆ testScriptCount()

int pqCoreConfiguration::testScriptCount ( ) const
inline

Returns information about tests scripts.

Definition at line 71 of file pqCoreConfiguration.h.

◆ testScript() [1/2]

const std::string& pqCoreConfiguration::testScript ( int  index) const
inline

Returns information about tests scripts.

Definition at line 72 of file pqCoreConfiguration.h.

◆ testBaseline() [1/2]

const std::string& pqCoreConfiguration::testBaseline ( int  index) const
inline

Returns information about tests scripts.

Definition at line 73 of file pqCoreConfiguration.h.

◆ testThreshold() [1/2]

int pqCoreConfiguration::testThreshold ( int  index) const
inline

Returns information about tests scripts.

Definition at line 74 of file pqCoreConfiguration.h.

◆ exitApplicationWhenTestsDone()

bool pqCoreConfiguration::exitApplicationWhenTestsDone ( ) const
inline

Returns true if the application should exit after test playback is complete.

Definition at line 81 of file pqCoreConfiguration.h.

◆ catalystLivePort()

int pqCoreConfiguration::catalystLivePort ( ) const
inline

When specified, ParaView will attempt to connect a Catalyst Live session at the given port.

Definition at line 87 of file pqCoreConfiguration.h.

◆ populateOptions()

bool pqCoreConfiguration::populateOptions ( vtkCLIOptions *  options)

Populate vtkCLIOptions instance with command line options to control the configurable options provided by this class.

◆ setActiveTestIndex()

void pqCoreConfiguration::setActiveTestIndex ( int  index)
inline

A little bit of hack to activate a particular test script.

Definition at line 99 of file pqCoreConfiguration.h.

◆ testScript() [2/2]

const std::string& pqCoreConfiguration::testScript ( ) const
inline

A little bit of hack to activate a particular test script.

Definition at line 100 of file pqCoreConfiguration.h.

◆ testBaseline() [2/2]

const std::string& pqCoreConfiguration::testBaseline ( ) const
inline

A little bit of hack to activate a particular test script.

Definition at line 101 of file pqCoreConfiguration.h.

◆ testThreshold() [2/2]

int pqCoreConfiguration::testThreshold ( ) const
inline

A little bit of hack to activate a particular test script.

Definition at line 102 of file pqCoreConfiguration.h.

◆ testMaster()

bool pqCoreConfiguration::testMaster ( ) const
inline

Collaboration testing related flags.

Definition at line 109 of file pqCoreConfiguration.h.

◆ testSlave()

bool pqCoreConfiguration::testSlave ( ) const
inline

Collaboration testing related flags.

Definition at line 110 of file pqCoreConfiguration.h.

◆ addDataFile()

void pqCoreConfiguration::addDataFile ( const std::string &  data)
inlineprotected

Definition at line 121 of file pqCoreConfiguration.h.

Friends And Related Function Documentation

◆ pqPVApplicationCore

friend class pqPVApplicationCore
friend

Definition at line 120 of file pqCoreConfiguration.h.

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.13 on Tue Oct 1 2024