Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
pqOptions Class Reference

Command line options for pqClient. More...

#include <pqOptions.h>

Inheritance diagram for pqOptions:
Inheritance graph
[legend]
Collaboration diagram for pqOptions:
Collaboration graph
[legend]

Classes

struct  TestInfo
 

Public Types

typedef vtkPVOptions Superclass
 
- Public Types inherited from vtkPVOptions
enum  ProcessTypeEnum {
  PARAVIEW = 0x2, PVCLIENT = 0x4, PVSERVER = 0x8, PVRENDER_SERVER = 0x10,
  PVDATA_SERVER = 0x20, PVBATCH = 0x40, ALLPROCESS = PARAVIEW | PVCLIENT | PVSERVER | PVRENDER_SERVER | PVDATA_SERVER | PVBATCH
}
 
typedef vtkCommandOptions Superclass
 
- Public Types inherited from vtkCommandOptions
enum  { EVERYBODY = 0, XMLONLY = 0x1 }
 
typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
virtual char * GetBaselineDirectory ()
 
virtual char * GetTestDirectory ()
 
virtual char * GetDataDirectory ()
 
virtual int GetExitAppWhenTestsDone ()
 
QStringList GetTestScripts ()
 
virtual char * GetServerResourceName ()
 Returns the server resource name specified to load. More...
 
virtual void SetBaselineDirectory (const char *)
 
virtual void SetTestDirectory (const char *)
 
virtual void SetDataDirectory (const char *)
 
int GetNumberOfTestScripts ()
 
QString GetTestScript (int cc)
 
QString GetTestBaseline (int cc)
 
int GetTestImageThreshold (int cc)
 
virtual void SetCurrentImageThreshold (int)
 HACK: When playing back tests, this variable is set to make it easier to locate the test image threshold for the current test. More...
 
virtual int GetCurrentImageThreshold ()
 
virtual int GetTestMaster ()
 
virtual int GetTestSlave ()
 
virtual char * GetPythonScript ()
 
int AddTestScript (const char *)
 
int SetLastTestBaseline (const char *)
 
int SetLastTestImageThreshold (int)
 
virtual char * GetStateFileName ()
 State file to load on startup. More...
 
- Public Member Functions inherited from vtkPVOptions
void PrintSelf (ostream &os, vtkIndent indent) override
 
virtual int GetConnectID ()
 
virtual int GetUseStereoRendering ()
 
virtual char * GetStereoType ()
 
virtual int GetReverseConnection ()
 
virtual int GetUseRenderingGroup ()
 
virtual intGetTileDimensions ()
 
virtual void GetTileDimensions (int &, int &)
 
virtual void GetTileDimensions (int [2])
 
virtual intGetTileMullions ()
 
virtual void GetTileMullions (int &, int &)
 
virtual void GetTileMullions (int [2])
 
virtual bool GetIsInTileDisplay () const
 Returns true if the tile display configuration is requested. More...
 
virtual bool GetIsInCave () const
 Returns true of CAVE configuration is requested. More...
 
virtual int GetEGLDeviceIndex ()
 Returns the egl device index. More...
 
virtual int GetMultiClientMode ()
 Is this server was started for collaboration meaning that it allow several clients to connect to the same server and share the same pipeline and visualization. More...
 
virtual int IsMultiClientModeDebug ()
 
virtual char * GetServerURL ()
 Provides access to server-url if specified on the command line. More...
 
virtual int GetCatalystLivePort ()
 Provides access to the Catalyst Live port if specified on the command line. More...
 
virtual int GetForceOffscreenRendering ()
 When set to true, ParaView will create headless only render windows on the current process. More...
 
virtual int GetForceOnscreenRendering ()
 When set to true, ParaView will create on-screen render windows. More...
 
virtual char * GetHostName ()
 Convenience method to get the local process's host name. More...
 
virtual char * GetParaViewDataName ()
 This is the argument specified by –data on the command line. More...
 
virtual char * GetServersFileName ()
 Servers file to load on startup. More...
 
virtual int GetTimeout ()
 Valid on PVSERVER and PVDATA_SERVER only. More...
 
virtual void SetConnectID (int)
 Clients need to set the ConnectID so they can handle server connections after the client has started. More...
 
virtual void SetLogFileName (const char *)
 Log filename. More...
 
virtual char * GetLogFileName ()
 Log filename. More...
 
virtual int GetDisableFurtherConnections ()
 Returns if this server does not allow connection after the first client. More...
 
virtual int GetMultiServerMode ()
 Is this client allow multiple server connection in parallel. More...
 
virtual int GetSymmetricMPIMode ()
 Indicates if the application is in symmetric mpi mode. More...
 
virtual void SetSymmetricMPIMode (int)
 Indicates if the application is in symmetric mpi mode. More...
 
virtual int GetTellVersion ()
 Should this run print the version numbers and exit. More...
 
virtual void SetParaViewDataName (const char *)
 This is used when user want to open a file at startup. More...
 
virtual void SetEnableStreaming (int)
 Until streaming becomes mainstream, we enable streaming support by passing a command line argument to all processes. More...
 
virtual int GetEnableStreaming ()
 Until streaming becomes mainstream, we enable streaming support by passing a command line argument to all processes. More...
 
virtual void SetSatelliteMessageIds (int)
 Include originating process id text into server to client messages. More...
 
virtual int GetSatelliteMessageIds ()
 Include originating process id text into server to client messages. More...
 
virtual int GetPrintMonitors ()
 Should this process just print monitor information and exit? More...
 
virtual char * GetTestPlugins ()
 Adding ability to test plugins by loading them at command line. More...
 
virtual char * GetTestPluginPaths ()
 Adding ability to test plugins by loading them at command line. More...
 
virtual int GetEnableStackTrace ()
 Flag for controlling auto generation of stack trace on POSIX systems after crash. More...
 
virtual void SetEnableStackTrace (int)
 Flag for controlling auto generation of stack trace on POSIX systems after crash. More...
 
virtual int GetDisableRegistry ()
 Flag for disabling loading of options and settings stored by the application. More...
 
virtual int GetDisableXDisplayTests ()
 XDisplay test on server processes during initialization sometimes happens too early and may result in remote rendering prematurely disabled. More...
 
virtual int GetForceNoMPIInitOnClient ()
 Get/Set the ForceNoMPIInitOnClient flag. More...
 
virtual void SetForceNoMPIInitOnClient (int)
 Get/Set the ForceNoMPIInitOnClient flag. More...
 
virtual void ForceNoMPIInitOnClientOn ()
 Get/Set the ForceNoMPIInitOnClient flag. More...
 
virtual void ForceNoMPIInitOnClientOff ()
 Get/Set the ForceNoMPIInitOnClient flag. More...
 
virtual int GetForceMPIInitOnClient ()
 Get/Set the ForceMPIInitOnClient flag. More...
 
virtual void SetForceMPIInitOnClient (int)
 Get/Set the ForceMPIInitOnClient flag. More...
 
virtual void ForceMPIInitOnClientOn ()
 Get/Set the ForceMPIInitOnClient flag. More...
 
virtual void ForceMPIInitOnClientOff ()
 Get/Set the ForceMPIInitOnClient flag. More...
 
virtual int GetLogStdErrVerbosity ()
 Returns the verbosity level for stderr output chosen. More...
 
const std::stringGetDisplay (int myrank=0, int num_ranks=1)
 Provides access to display selection. More...
 
- Public Member Functions inherited from vtkCommandOptions
void PrintSelf (ostream &os, vtkIndent indent) override
 
int Parse (int argc, const char *const argv[])
 
void GetRemainingArguments (int *argc, char **argv[])
 
const char * GetHelp ()
 
int GetProcessType ()
 Set/Get the type of the process for this set of options. More...
 
void SetProcessType (int p)
 
const char * GetArgv0 ()
 Get argv[0]. More...
 
int GetLastArgument ()
 Get the index of the last argument parsed. More...
 
virtual int ParseExtraXMLTag (const char *, const char **)
 Pass in the name and the attributes for all tags that are not Options. More...
 
virtual int GetHelpSelected ()
 Was help selected? More...
 
virtual void SetHelpSelected (int)
 Was help selected? More...
 
virtual char * GetUnknownArgument ()
 In case of unknown argument, set this variable with the unknown argument. More...
 
virtual char * GetErrorMessage ()
 Get the error message if Parse returned 0. More...
 
virtual char * GetApplicationPath ()
 Get full path of executable (based on Argv0) More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual vtkMTimeType GetMTime ()
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 

Static Public Member Functions

static pqOptionsNew ()
 
static int IsTypeOf (const char *type)
 
static pqOptionsSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkPVOptions
static vtkPVOptionsNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPVOptionsSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkCommandOptions
static vtkCommandOptionsNew ()
 
static int IsTypeOf (const char *type)
 
static vtkCommandOptionsSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 pqOptions ()
 
 ~pqOptions () override
 
void Initialize () override
 Initialize arguments. More...
 
int PostProcess (int argc, const char *const *argv) override
 After parsing, process extra option dependencies. More...
 
virtual void SetPythonScript (const char *)
 
virtual void SetServerResourceName (const char *)
 
virtual void SetStateFileName (const char *)
 
int WrongArgument (const char *argument) override
 This method is called when wrong argument is found. More...
 
- Protected Member Functions inherited from vtkPVOptions
 vtkPVOptions ()
 Default constructor. More...
 
 ~vtkPVOptions () override
 Destructor. More...
 
void Initialize () override
 Initialize arguments. More...
 
int PostProcess (int argc, const char *const *argv) override
 After parsing, process extra option dependencies. More...
 
int WrongArgument (const char *argument) override
 This method is called when wrong argument is found. More...
 
int DeprecatedArgument (const char *argument) override
 This method is called when a deprecated argument is found. More...
 
virtual void SetServerURL (const char *)
 
virtual void SetServersFileName (const char *)
 
virtual void SetTestPlugins (const char *)
 
virtual void SetTestPluginPaths (const char *)
 
- Protected Member Functions inherited from vtkCommandOptions
 vtkCommandOptions ()
 Default constructor. More...
 
 ~vtkCommandOptions () override
 Destructor. More...
 
void AddCallback (const char *longarg, const char *shortarg, CallbackType callback, void *call_data, const char *help, int type=EVERYBODY)
 
int LoadXMLConfigFile (const char *)
 This method loads the paraview config file. More...
 
virtual void SetUnknownArgument (const char *)
 
virtual void SetErrorMessage (const char *)
 
virtual void SetXMLConfigFile (const char *)
 
void CleanArgcArgv ()
 
virtual void SetApplicationPath (const char *)
 
void ComputeApplicationPath ()
 
void AddBooleanArgument (const char *longarg, const char *shortarg, int *var, const char *help, int type=EVERYBODY)
 Add a command line option. More...
 
void AddDeprecatedArgument (const char *longarg, const char *shortarg, const char *help, int type=EVERYBODY)
 Add a command line option. More...
 
void AddArgument (const char *longarg, const char *shortarg, int *var, const char *help, int type=EVERYBODY)
 Add a command line option. More...
 
void AddArgument (const char *longarg, const char *shortarg, char **var, const char *help, int type=EVERYBODY)
 Add a command line option. More...
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

char * BaselineDirectory
 
char * TestDirectory
 
char * DataDirectory
 
char * ServerResourceName
 
char * StateFileName
 
int ExitAppWhenTestsDone
 
int DisableRegistry
 
int CurrentImageThreshold
 
int TestMaster
 
int TestSlave
 
char * PythonScript
 
QList< TestInfoTestScripts
 
- Protected Attributes inherited from vtkPVOptions
char * ParaViewDataName
 Subclasses may need to access these. More...
 
char * ServerURL
 Subclasses may need to access these. More...
 
int ServerMode
 Subclasses may need to access these. More...
 
int ClientMode
 Subclasses may need to access these. More...
 
int RenderServerMode
 Subclasses may need to access these. More...
 
int MultiClientMode
 Subclasses may need to access these. More...
 
int DisableFurtherConnections
 Subclasses may need to access these. More...
 
int MultiClientModeWithErrorMacro
 Subclasses may need to access these. More...
 
int MultiServerMode
 Subclasses may need to access these. More...
 
int SymmetricMPIMode
 Subclasses may need to access these. More...
 
char * ServersFileName
 Subclasses may need to access these. More...
 
char * TestPlugins
 Subclasses may need to access these. More...
 
char * TestPluginPaths
 Subclasses may need to access these. More...
 
int DisableXDisplayTests
 Subclasses may need to access these. More...
 
int CatalystLivePort
 Subclasses may need to access these. More...
 
- Protected Attributes inherited from vtkCommandOptions
vtkCommandOptionsXMLParserXMLParser
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Protected Types inherited from vtkCommandOptions
typedef int(* CallbackType) (const char *argument, const char *value, void *call_data)
 Prototype for callbacks. More...
 

Detailed Description

Command line options for pqClient.

pqOptions extends vtkPVOptions to handle pqClient specific command line options.

Definition at line 45 of file pqOptions.h.

Member Typedef Documentation

◆ Superclass

Definition at line 49 of file pqOptions.h.

Constructor & Destructor Documentation

◆ pqOptions()

pqOptions::pqOptions ( )
protected

◆ ~pqOptions()

pqOptions::~pqOptions ( )
overrideprotected

Member Function Documentation

◆ New()

static pqOptions* pqOptions::New ( )
static

◆ GetClassName()

virtual const char* pqOptions::GetClassName ( )
virtual

Reimplemented from vtkPVOptions.

◆ IsTypeOf()

static int pqOptions::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual int pqOptions::IsA ( const char *  type)
virtual

Reimplemented from vtkPVOptions.

◆ SafeDownCast()

static pqOptions* pqOptions::SafeDownCast ( vtkObject o)
static

◆ PrintSelf()

void pqOptions::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Reimplemented from vtkObject.

◆ GetBaselineDirectory()

virtual char* pqOptions::GetBaselineDirectory ( )
virtual

◆ GetTestDirectory()

virtual char* pqOptions::GetTestDirectory ( )
virtual

◆ GetDataDirectory()

virtual char* pqOptions::GetDataDirectory ( )
virtual

◆ GetStateFileName()

virtual char* pqOptions::GetStateFileName ( )
virtual

State file to load on startup.

◆ GetExitAppWhenTestsDone()

virtual int pqOptions::GetExitAppWhenTestsDone ( )
virtual

◆ GetTestScripts()

QStringList pqOptions::GetTestScripts ( )

◆ GetServerResourceName()

virtual char* pqOptions::GetServerResourceName ( )
virtual

Returns the server resource name specified to load.

◆ SetBaselineDirectory()

virtual void pqOptions::SetBaselineDirectory ( const char *  )
virtual

◆ SetTestDirectory()

virtual void pqOptions::SetTestDirectory ( const char *  )
virtual

◆ SetDataDirectory()

virtual void pqOptions::SetDataDirectory ( const char *  )
virtual

◆ GetNumberOfTestScripts()

int pqOptions::GetNumberOfTestScripts ( )
inline

Definition at line 79 of file pqOptions.h.

◆ GetTestScript()

QString pqOptions::GetTestScript ( int  cc)
inline

Definition at line 80 of file pqOptions.h.

◆ GetTestBaseline()

QString pqOptions::GetTestBaseline ( int  cc)
inline

Definition at line 81 of file pqOptions.h.

◆ GetTestImageThreshold()

int pqOptions::GetTestImageThreshold ( int  cc)
inline

Definition at line 82 of file pqOptions.h.

◆ SetCurrentImageThreshold()

virtual void pqOptions::SetCurrentImageThreshold ( int  )
virtual

HACK: When playing back tests, this variable is set to make it easier to locate the test image threshold for the current test.

This is updated by the test playback code.

◆ GetCurrentImageThreshold()

virtual int pqOptions::GetCurrentImageThreshold ( )
virtual

◆ GetTestMaster()

virtual int pqOptions::GetTestMaster ( )
virtual

◆ GetTestSlave()

virtual int pqOptions::GetTestSlave ( )
virtual

◆ GetPythonScript()

virtual char* pqOptions::GetPythonScript ( )
virtual

◆ AddTestScript()

int pqOptions::AddTestScript ( const char *  )

◆ SetLastTestBaseline()

int pqOptions::SetLastTestBaseline ( const char *  )

◆ SetLastTestImageThreshold()

int pqOptions::SetLastTestImageThreshold ( int  )

◆ Initialize()

void pqOptions::Initialize ( )
overrideprotectedvirtual

Initialize arguments.

Reimplemented from vtkCommandOptions.

◆ PostProcess()

int pqOptions::PostProcess ( int  argc,
const char *const argv 
)
overrideprotectedvirtual

After parsing, process extra option dependencies.

Reimplemented from vtkCommandOptions.

◆ SetPythonScript()

virtual void pqOptions::SetPythonScript ( const char *  )
protectedvirtual

◆ SetServerResourceName()

virtual void pqOptions::SetServerResourceName ( const char *  )
protectedvirtual

◆ SetStateFileName()

virtual void pqOptions::SetStateFileName ( const char *  )
protectedvirtual

◆ WrongArgument()

int pqOptions::WrongArgument ( const char *  argument)
overrideprotectedvirtual

This method is called when wrong argument is found.

If it returns 0, then the parsing will fail.

Reimplemented from vtkCommandOptions.

Member Data Documentation

◆ BaselineDirectory

char* pqOptions::BaselineDirectory
protected

Definition at line 115 of file pqOptions.h.

◆ TestDirectory

char* pqOptions::TestDirectory
protected

Definition at line 116 of file pqOptions.h.

◆ DataDirectory

char* pqOptions::DataDirectory
protected

Definition at line 117 of file pqOptions.h.

◆ ServerResourceName

char* pqOptions::ServerResourceName
protected

Definition at line 118 of file pqOptions.h.

◆ StateFileName

char* pqOptions::StateFileName
protected

Definition at line 119 of file pqOptions.h.

◆ ExitAppWhenTestsDone

int pqOptions::ExitAppWhenTestsDone
protected

Definition at line 121 of file pqOptions.h.

◆ DisableRegistry

int pqOptions::DisableRegistry
protected

Definition at line 122 of file pqOptions.h.

◆ CurrentImageThreshold

int pqOptions::CurrentImageThreshold
protected

Definition at line 123 of file pqOptions.h.

◆ TestMaster

int pqOptions::TestMaster
protected

Definition at line 124 of file pqOptions.h.

◆ TestSlave

int pqOptions::TestSlave
protected

Definition at line 125 of file pqOptions.h.

◆ PythonScript

char* pqOptions::PythonScript
protected

Definition at line 126 of file pqOptions.h.

◆ TestScripts

QList<TestInfo> pqOptions::TestScripts
protected

Definition at line 143 of file pqOptions.h.


The documentation for this class was generated from the following file: