Command line options for pqClient. More...

#include <pqOptions.h>

Inheritance diagram for pqOptions:

Collaboration diagram for pqOptions:

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)

virtual char *	GetTileImagePath ()

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	SetTileImagePath (const char *)

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)

Public Member Functions inherited from vtkPVOptions
void	PrintSelf (ostream &os, vtkIndent indent)

virtual int	GetConnectID ()

virtual int	GetUseOffscreenRendering ()

virtual int	GetEGLDeviceIndex ()

virtual int	GetUseStereoRendering ()

virtual char *	GetStereoType ()

virtual int	GetReverseConnection ()

virtual int	GetUseRenderingGroup ()

virtual int *	GetTileDimensions ()

virtual void	GetTileDimensions (int &, int &)

virtual void	GetTileDimensions (int [2])

virtual int *	GetTileMullions ()

virtual void	GetTileMullions (int &, int &)

virtual void	GetTileMullions (int [2])

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 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 *	GetStateFileName ()
	State 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 void	SetTileDimensions (int, int)
	vtkPVProcessModule needs to set this. More...

void	SetTileDimensions (int [2])
	vtkPVProcessModule needs to set this. More...

virtual void	SetTileMullions (int, int)
	vtkPVProcessModule needs to set this. More...

void	SetTileMullions (int [2])
	vtkPVProcessModule needs to set this. More...

virtual void	SetUseOffscreenRendering (int)
	vtkPVProcessModule needs to set this. 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 int	GetEnableStreaming ()
	Until streaming becomes mainstream, we enable streaming support by passing a command line argument to all processes. More...

virtual int	GetUseCudaInterop ()
	When set, use cuda interop feature. 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 *	GetTestPlugin ()
	Adding ability to test plugins by loading them at command line. More...

virtual char *	GetTestPluginPath ()
	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...

Public Member Functions inherited from vtkCommandOptions
void	PrintSelf (ostream &os, vtkIndent indent)

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...

Static Public Member Functions
static pqOptions *	New ()

static int	IsTypeOf (const char *type)

static pqOptions *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkPVOptions
static vtkPVOptions *	New ()

static int	IsTypeOf (const char *type)

static vtkPVOptions *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkCommandOptions
static vtkCommandOptions *	New ()

static int	IsTypeOf (const char *type)

static vtkCommandOptions *	SafeDownCast (vtkObject *o)

Protected Member Functions
	pqOptions ()

virtual	~pqOptions ()

virtual void	Initialize ()
	Initialize arguments. More...

virtual int	PostProcess (int argc, const char const argv)
	After parsing, process extra option dependencies. More...

virtual void	SetPythonScript (const char *)

virtual void	SetServerResourceName (const char *)

virtual int	WrongArgument (const char *argument)
	This method is called when wrong argument is found. More...

Protected Member Functions inherited from vtkPVOptions
	vtkPVOptions ()
	Default constructor. More...

virtual	~vtkPVOptions ()
	Destructor. More...

virtual int	DeprecatedArgument (const char *argument)
	This method is called when a deprecated argument is found. More...

virtual void	SetServerURL (const char *)

virtual void	SetStateFileName (const char *)

virtual void	SetTestPlugin (const char *)

virtual void	SetTestPluginPath (const char *)

Protected Member Functions inherited from vtkCommandOptions
	vtkCommandOptions ()
	Default constructor. More...

virtual	~vtkCommandOptions ()
	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 Attributes
char *	BaselineDirectory

char *	TestDirectory

char *	DataDirectory

char *	ServerResourceName

char *	TileImagePath

int	ExitAppWhenTestsDone

int	DisableRegistry

int	CurrentImageThreshold

int	TestMaster

int	TestSlave

char *	PythonScript

QList< TestInfo >	TestScripts

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	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 *	StateFileName
	Subclasses may need to access these. More...

char *	TestPlugin
	Subclasses may need to access these. More...

char *	TestPluginPath
	Subclasses may need to access these. More...

int	DisableXDisplayTests
	Subclasses may need to access these. More...

Protected Attributes inherited from vtkCommandOptions
vtkCommandOptionsXMLParser *	XMLParser

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

typedef vtkPVOptions pqOptions::Superclass

Definition at line 49 of file pqOptions.h.

Constructor & Destructor Documentation

§ pqOptions()

pqOptions::pqOptions ( )

protected

§ ~pqOptions()

virtual pqOptions::~pqOptions ( )

protectedvirtual

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
	)

§ GetTileImagePath()

virtual char* pqOptions::GetTileImagePath ( )

virtual

§ GetBaselineDirectory()

virtual char* pqOptions::GetBaselineDirectory ( )

virtual

§ GetTestDirectory()

virtual char* pqOptions::GetTestDirectory ( )

virtual

§ GetDataDirectory()

virtual char* pqOptions::GetDataDirectory ( )

virtual

§ GetExitAppWhenTestsDone()

virtual int pqOptions::GetExitAppWhenTestsDone ( )

virtual

§ GetTestScripts()

QStringList pqOptions::GetTestScripts ( )

§ GetServerResourceName()

virtual char* pqOptions::GetServerResourceName ( )

virtual

Returns the server resource name specified to load.

§ SetTileImagePath()

virtual void pqOptions::SetTileImagePath ( const char * )

virtual

§ 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 73 of file pqOptions.h.

§ GetTestScript()

QString pqOptions::GetTestScript ( int cc )

inline

Definition at line 74 of file pqOptions.h.

§ GetTestBaseline()

QString pqOptions::GetTestBaseline ( int cc )

inline

Definition at line 75 of file pqOptions.h.

§ GetTestImageThreshold()

int pqOptions::GetTestImageThreshold ( int cc )

inline

Definition at line 76 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()

virtual void pqOptions::Initialize ( )

protectedvirtual

Initialize arguments.

Reimplemented from vtkPVOptions.

§ PostProcess()

virtual int pqOptions::PostProcess	(	int	argc,
		const char const	argv
	)

protectedvirtual

After parsing, process extra option dependencies.

Reimplemented from vtkPVOptions.

§ SetPythonScript()

virtual void pqOptions::SetPythonScript ( const char * )

protectedvirtual

§ SetServerResourceName()

virtual void pqOptions::SetServerResourceName ( const char * )

protectedvirtual

§ WrongArgument()

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

protectedvirtual

This method is called when wrong argument is found.

If it returns 0, then the parsing will fail.

Reimplemented from vtkPVOptions.

Member Data Documentation

§ BaselineDirectory

char* pqOptions::BaselineDirectory

protected

Definition at line 109 of file pqOptions.h.

§ TestDirectory

char* pqOptions::TestDirectory

protected

Definition at line 110 of file pqOptions.h.

§ DataDirectory

char* pqOptions::DataDirectory

protected

Definition at line 111 of file pqOptions.h.

§ ServerResourceName

char* pqOptions::ServerResourceName

protected

Definition at line 112 of file pqOptions.h.

§ TileImagePath

char* pqOptions::TileImagePath

protected

Definition at line 113 of file pqOptions.h.

§ ExitAppWhenTestsDone

int pqOptions::ExitAppWhenTestsDone

protected

Definition at line 115 of file pqOptions.h.

§ DisableRegistry

int pqOptions::DisableRegistry

protected

Definition at line 116 of file pqOptions.h.

§ CurrentImageThreshold

int pqOptions::CurrentImageThreshold

protected

Definition at line 117 of file pqOptions.h.

§ TestMaster

int pqOptions::TestMaster

protected

Definition at line 118 of file pqOptions.h.

§ TestSlave

int pqOptions::TestSlave

protected

Definition at line 119 of file pqOptions.h.

§ PythonScript

char* pqOptions::PythonScript

protected

Definition at line 120 of file pqOptions.h.

§ TestScripts

QList<TestInfo> pqOptions::TestScripts

protected

Definition at line 136 of file pqOptions.h.

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

/builddir/build/BUILD/ParaView-v5.2.0/Qt/Core/pqOptions.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

§ Superclass

Constructor & Destructor Documentation

§ pqOptions()

§ ~pqOptions()

Member Function Documentation

§ New()

§ GetClassName()

§ IsTypeOf()

§ IsA()

§ SafeDownCast()

§ PrintSelf()

§ GetTileImagePath()

§ GetBaselineDirectory()

§ GetTestDirectory()

§ GetDataDirectory()

§ GetExitAppWhenTestsDone()

§ GetTestScripts()

§ GetServerResourceName()

§ SetTileImagePath()

§ SetBaselineDirectory()

§ SetTestDirectory()

§ SetDataDirectory()

§ GetNumberOfTestScripts()

§ GetTestScript()

§ GetTestBaseline()

§ GetTestImageThreshold()

§ SetCurrentImageThreshold()

§ GetCurrentImageThreshold()

§ GetTestMaster()

§ GetTestSlave()

§ GetPythonScript()

§ AddTestScript()

§ SetLastTestBaseline()

§ SetLastTestImageThreshold()

§ Initialize()

§ PostProcess()

§ SetPythonScript()

§ SetServerResourceName()

§ WrongArgument()

Member Data Documentation

§ BaselineDirectory

§ TestDirectory

§ DataDirectory

§ ServerResourceName

§ TileImagePath

§ ExitAppWhenTestsDone

§ DisableRegistry

§ CurrentImageThreshold

§ TestMaster

§ TestSlave

§ PythonScript

§ TestScripts