ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | List of all members
vtkPVOptions Class Reference

ParaView options storage. More...

#include <vtkPVOptions.h>

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

Public Types

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

Protected Member Functions

 vtkPVOptions ()
 Default constructor. More...
 
virtual ~vtkPVOptions ()
 Destructor. More...
 
virtual void Initialize ()
 Initialize arguments. More...
 
virtual int PostProcess (int argc, const char *const *argv)
 After parsing, process extra option dependencies. More...
 
virtual int WrongArgument (const char *argument)
 This method is called when wrong argument is found. 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 * 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
vtkCommandOptionsXMLParserXMLParser
 

Friends

class vtkPVOptionsXMLParser
 

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

ParaView options storage.

An object of this class represents a storage for ParaView options

These options can be retrieved during run-time, set using configuration file or using Command Line Arguments.

Definition at line 33 of file vtkPVOptions.h.

Member Typedef Documentation

◆ Superclass

Definition at line 40 of file vtkPVOptions.h.

Member Enumeration Documentation

◆ ProcessTypeEnum

Enumerator
PARAVIEW 
PVCLIENT 
PVSERVER 
PVRENDER_SERVER 
PVDATA_SERVER 
PVBATCH 
ALLPROCESS 

Definition at line 224 of file vtkPVOptions.h.

Constructor & Destructor Documentation

◆ vtkPVOptions()

vtkPVOptions::vtkPVOptions ( )
protected

Default constructor.

◆ ~vtkPVOptions()

virtual vtkPVOptions::~vtkPVOptions ( )
protectedvirtual

Destructor.

Member Function Documentation

◆ New()

static vtkPVOptions* vtkPVOptions::New ( )
static

◆ GetClassName()

virtual const char* vtkPVOptions::GetClassName ( )
virtual

Reimplemented from vtkCommandOptions.

Reimplemented in pqOptions, vtkPVServerOptions, and vtkPVPythonOptions.

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkCommandOptions.

Reimplemented in pqOptions, vtkPVServerOptions, and vtkPVPythonOptions.

◆ SafeDownCast()

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

◆ PrintSelf()

void vtkPVOptions::PrintSelf ( ostream &  os,
vtkIndent  indent 
)

◆ GetHostName()

virtual char* vtkPVOptions::GetHostName ( )
virtual

Convenience method to get the local process's host name.

◆ GetConnectID()

virtual int vtkPVOptions::GetConnectID ( )
virtual

◆ GetUseOffscreenRendering()

virtual int vtkPVOptions::GetUseOffscreenRendering ( )
virtual

◆ GetEGLDeviceIndex()

virtual int vtkPVOptions::GetEGLDeviceIndex ( )
virtual

◆ GetUseStereoRendering()

virtual int vtkPVOptions::GetUseStereoRendering ( )
virtual

◆ GetStereoType()

virtual char* vtkPVOptions::GetStereoType ( )
virtual

Reimplemented in vtkPVServerOptions.

◆ GetReverseConnection()

virtual int vtkPVOptions::GetReverseConnection ( )
virtual

◆ GetUseRenderingGroup()

virtual int vtkPVOptions::GetUseRenderingGroup ( )
virtual

◆ GetTileDimensions() [1/3]

virtual int* vtkPVOptions::GetTileDimensions ( )
virtual

◆ GetTileDimensions() [2/3]

virtual void vtkPVOptions::GetTileDimensions ( int &  ,
int &   
)
virtual

◆ GetTileDimensions() [3/3]

virtual void vtkPVOptions::GetTileDimensions ( int  [2])
virtual

◆ GetTileMullions() [1/3]

virtual int* vtkPVOptions::GetTileMullions ( )
virtual

◆ GetTileMullions() [2/3]

virtual void vtkPVOptions::GetTileMullions ( int &  ,
int &   
)
virtual

◆ GetTileMullions() [3/3]

virtual void vtkPVOptions::GetTileMullions ( int  [2])
virtual

◆ GetParaViewDataName()

virtual char* vtkPVOptions::GetParaViewDataName ( )
virtual

This is the argument specified by –data on the command line.

Additionally, this can also correspond to the last argument specified on the command line if the argument is unknown.

◆ GetStateFileName()

virtual char* vtkPVOptions::GetStateFileName ( )
virtual

State file to load on startup.

◆ GetTimeout()

virtual int vtkPVOptions::GetTimeout ( )
virtual

Valid on PVSERVER and PVDATA_SERVER only.

It denotes the time (in minutes) since the time that the connection was established with the server that the server may timeout. timeout <= 0 means no timeout.

◆ SetConnectID()

virtual void vtkPVOptions::SetConnectID ( int  )
virtual

Clients need to set the ConnectID so they can handle server connections after the client has started.

◆ SetLogFileName()

virtual void vtkPVOptions::SetLogFileName ( const char *  )
virtual

Log filename.

◆ GetLogFileName()

virtual char* vtkPVOptions::GetLogFileName ( )
virtual

Log filename.

◆ SetTileDimensions() [1/2]

virtual void vtkPVOptions::SetTileDimensions ( int  ,
int   
)
virtual

vtkPVProcessModule needs to set this.

◆ SetTileDimensions() [2/2]

void vtkPVOptions::SetTileDimensions ( int  [2])

vtkPVProcessModule needs to set this.

◆ SetTileMullions() [1/2]

virtual void vtkPVOptions::SetTileMullions ( int  ,
int   
)
virtual

vtkPVProcessModule needs to set this.

◆ SetTileMullions() [2/2]

void vtkPVOptions::SetTileMullions ( int  [2])

vtkPVProcessModule needs to set this.

◆ SetUseOffscreenRendering()

virtual void vtkPVOptions::SetUseOffscreenRendering ( int  )
virtual

vtkPVProcessModule needs to set this.

◆ GetMultiClientMode()

virtual int vtkPVOptions::GetMultiClientMode ( )
inlinevirtual

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.

Definition at line 116 of file vtkPVOptions.h.

◆ IsMultiClientModeDebug()

virtual int vtkPVOptions::IsMultiClientModeDebug ( )
inlinevirtual

Definition at line 120 of file vtkPVOptions.h.

◆ GetMultiServerMode()

virtual int vtkPVOptions::GetMultiServerMode ( )
virtual

Is this client allow multiple server connection in parallel.

◆ GetSymmetricMPIMode()

virtual int vtkPVOptions::GetSymmetricMPIMode ( )
virtual

Indicates if the application is in symmetric mpi mode.

This is applicable only to PVBATCH type of processes. Typically, when set to true, the python script is run on satellites as well, otherwise only the root node processes the python script. Disabled by default.

◆ SetSymmetricMPIMode()

virtual void vtkPVOptions::SetSymmetricMPIMode ( int  )
virtual

Indicates if the application is in symmetric mpi mode.

This is applicable only to PVBATCH type of processes. Typically, when set to true, the python script is run on satellites as well, otherwise only the root node processes the python script. Disabled by default.

◆ GetTellVersion()

virtual int vtkPVOptions::GetTellVersion ( )
virtual

Should this run print the version numbers and exit.

◆ GetServerURL()

virtual char* vtkPVOptions::GetServerURL ( )
virtual

Provides access to server-url if specified on the command line.

◆ SetParaViewDataName()

virtual void vtkPVOptions::SetParaViewDataName ( const char *  )
virtual

This is used when user want to open a file at startup.

◆ GetEnableStreaming()

virtual int vtkPVOptions::GetEnableStreaming ( )
virtual

Until streaming becomes mainstream, we enable streaming support by passing a command line argument to all processes.

◆ GetUseCudaInterop()

virtual int vtkPVOptions::GetUseCudaInterop ( )
virtual

When set, use cuda interop feature.

◆ SetSatelliteMessageIds()

virtual void vtkPVOptions::SetSatelliteMessageIds ( int  )
virtual

Include originating process id text into server to client messages.

◆ GetSatelliteMessageIds()

virtual int vtkPVOptions::GetSatelliteMessageIds ( )
virtual

Include originating process id text into server to client messages.

◆ GetPrintMonitors()

virtual int vtkPVOptions::GetPrintMonitors ( )
virtual

Should this process just print monitor information and exit?

◆ GetTestPlugin()

virtual char* vtkPVOptions::GetTestPlugin ( )
virtual

Adding ability to test plugins by loading them at command line.

◆ GetTestPluginPath()

virtual char* vtkPVOptions::GetTestPluginPath ( )
virtual

Adding ability to test plugins by loading them at command line.

◆ GetEnableStackTrace()

virtual int vtkPVOptions::GetEnableStackTrace ( )
virtual

Flag for controlling auto generation of stack trace on POSIX systems after crash.

◆ SetEnableStackTrace()

virtual void vtkPVOptions::SetEnableStackTrace ( int  )
virtual

Flag for controlling auto generation of stack trace on POSIX systems after crash.

◆ GetDisableRegistry()

virtual int vtkPVOptions::GetDisableRegistry ( )
virtual

Flag for disabling loading of options and settings stored by the application.

Often used for testing.

◆ GetDisableXDisplayTests()

virtual int vtkPVOptions::GetDisableXDisplayTests ( )
virtual

XDisplay test on server processes during initialization sometimes happens too early and may result in remote rendering prematurely disabled.

When this flag is set, ParaView will skip such X-display tests. Note, if the display is truly inaccessible when ParaView tries to connect to the server, we will indeed get runtimes errors, including segfaults.

◆ Initialize()

virtual void vtkPVOptions::Initialize ( )
protectedvirtual

Initialize arguments.

Reimplemented from vtkCommandOptions.

Reimplemented in pqOptions, and vtkPVServerOptions.

◆ PostProcess()

virtual int vtkPVOptions::PostProcess ( int  argc,
const char *const *  argv 
)
protectedvirtual

After parsing, process extra option dependencies.

Reimplemented from vtkCommandOptions.

Reimplemented in pqOptions, and vtkPVPythonOptions.

◆ WrongArgument()

virtual int vtkPVOptions::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 vtkCommandOptions.

Reimplemented in pqOptions, and vtkPVPythonOptions.

◆ DeprecatedArgument()

virtual int vtkPVOptions::DeprecatedArgument ( const char *  argument)
protectedvirtual

This method is called when a deprecated argument is found.

If it returns 0, then the parsing will fail.

Reimplemented from vtkCommandOptions.

◆ SetServerURL()

virtual void vtkPVOptions::SetServerURL ( const char *  )
protectedvirtual

◆ SetStateFileName()

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

◆ SetTestPlugin()

virtual void vtkPVOptions::SetTestPlugin ( const char *  )
protectedvirtual

◆ SetTestPluginPath()

virtual void vtkPVOptions::SetTestPluginPath ( const char *  )
protectedvirtual

Friends And Related Function Documentation

◆ vtkPVOptionsXMLParser

friend class vtkPVOptionsXMLParser
friend

Definition at line 36 of file vtkPVOptions.h.

Member Data Documentation

◆ ParaViewDataName

char* vtkPVOptions::ParaViewDataName
protected

Subclasses may need to access these.

Definition at line 272 of file vtkPVOptions.h.

◆ ServerURL

char* vtkPVOptions::ServerURL
protected

Subclasses may need to access these.

Definition at line 273 of file vtkPVOptions.h.

◆ ServerMode

int vtkPVOptions::ServerMode
protected

Subclasses may need to access these.

Definition at line 274 of file vtkPVOptions.h.

◆ ClientMode

int vtkPVOptions::ClientMode
protected

Subclasses may need to access these.

Definition at line 275 of file vtkPVOptions.h.

◆ RenderServerMode

int vtkPVOptions::RenderServerMode
protected

Subclasses may need to access these.

Definition at line 276 of file vtkPVOptions.h.

◆ MultiClientMode

int vtkPVOptions::MultiClientMode
protected

Subclasses may need to access these.

Definition at line 277 of file vtkPVOptions.h.

◆ MultiClientModeWithErrorMacro

int vtkPVOptions::MultiClientModeWithErrorMacro
protected

Subclasses may need to access these.

Definition at line 278 of file vtkPVOptions.h.

◆ MultiServerMode

int vtkPVOptions::MultiServerMode
protected

Subclasses may need to access these.

Definition at line 279 of file vtkPVOptions.h.

◆ SymmetricMPIMode

int vtkPVOptions::SymmetricMPIMode
protected

Subclasses may need to access these.

Definition at line 280 of file vtkPVOptions.h.

◆ StateFileName

char* vtkPVOptions::StateFileName
protected

Subclasses may need to access these.

Definition at line 281 of file vtkPVOptions.h.

◆ TestPlugin

char* vtkPVOptions::TestPlugin
protected

Subclasses may need to access these.

Definition at line 282 of file vtkPVOptions.h.

◆ TestPluginPath

char* vtkPVOptions::TestPluginPath
protected

Subclasses may need to access these.

Definition at line 283 of file vtkPVOptions.h.

◆ DisableXDisplayTests

int vtkPVOptions::DisableXDisplayTests
protected

Subclasses may need to access these.

Definition at line 284 of file vtkPVOptions.h.


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