ParaView
|
ParaView options storage. More...
#include <vtkPVOptions.h>
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 |
![]() | |
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... | |
![]() | |
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 vtkPVOptions * | New () |
static int | IsTypeOf (const char *type) |
static vtkPVOptions * | SafeDownCast (vtkObject *o) |
![]() | |
static vtkCommandOptions * | New () |
static int | IsTypeOf (const char *type) |
static vtkCommandOptions * | SafeDownCast (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 *) |
![]() | |
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... | |
![]() | |
vtkCommandOptionsXMLParser * | XMLParser |
Friends | |
class | vtkPVOptionsXMLParser |
Additional Inherited Members | |
![]() | |
typedef int(* | CallbackType) (const char *argument, const char *value, void *call_data) |
Prototype for callbacks. More... | |
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.
Definition at line 40 of file vtkPVOptions.h.
Enumerator | |
---|---|
PARAVIEW | |
PVCLIENT | |
PVSERVER | |
PVRENDER_SERVER | |
PVDATA_SERVER | |
PVBATCH | |
ALLPROCESS |
Definition at line 224 of file vtkPVOptions.h.
|
protected |
Default constructor.
|
protectedvirtual |
Destructor.
|
static |
|
virtual |
Reimplemented from vtkCommandOptions.
Reimplemented in pqOptions, vtkPVServerOptions, and vtkPVPythonOptions.
|
static |
|
virtual |
Reimplemented from vtkCommandOptions.
Reimplemented in pqOptions, vtkPVServerOptions, and vtkPVPythonOptions.
|
static |
void vtkPVOptions::PrintSelf | ( | ostream & | os, |
vtkIndent | indent | ||
) |
|
virtual |
Convenience method to get the local process's host name.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Reimplemented in vtkPVServerOptions.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
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.
|
virtual |
State file to load on startup.
|
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.
|
virtual |
Clients need to set the ConnectID so they can handle server connections after the client has started.
|
virtual |
Log filename.
|
virtual |
Log filename.
|
virtual |
vtkPVProcessModule needs to set this.
void vtkPVOptions::SetTileDimensions | ( | int | [2] | ) |
vtkPVProcessModule needs to set this.
|
virtual |
vtkPVProcessModule needs to set this.
void vtkPVOptions::SetTileMullions | ( | int | [2] | ) |
vtkPVProcessModule needs to set this.
|
virtual |
vtkPVProcessModule needs to set this.
|
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.
|
inlinevirtual |
Definition at line 120 of file vtkPVOptions.h.
|
virtual |
Is this client allow multiple server connection in parallel.
|
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.
|
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.
|
virtual |
Should this run print the version numbers and exit.
|
virtual |
Provides access to server-url if specified on the command line.
|
virtual |
This is used when user want to open a file at startup.
|
virtual |
Until streaming becomes mainstream, we enable streaming support by passing a command line argument to all processes.
|
virtual |
When set, use cuda interop feature.
|
virtual |
Include originating process id text into server to client messages.
|
virtual |
Include originating process id text into server to client messages.
|
virtual |
Should this process just print monitor information and exit?
|
virtual |
Adding ability to test plugins by loading them at command line.
|
virtual |
Adding ability to test plugins by loading them at command line.
|
virtual |
Flag for controlling auto generation of stack trace on POSIX systems after crash.
|
virtual |
Flag for controlling auto generation of stack trace on POSIX systems after crash.
|
virtual |
Flag for disabling loading of options and settings stored by the application.
Often used for testing.
|
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.
|
protectedvirtual |
Initialize arguments.
Reimplemented from vtkCommandOptions.
Reimplemented in pqOptions, and vtkPVServerOptions.
|
protectedvirtual |
After parsing, process extra option dependencies.
Reimplemented from vtkCommandOptions.
Reimplemented in pqOptions, and vtkPVPythonOptions.
|
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.
|
protectedvirtual |
This method is called when a deprecated argument is found.
If it returns 0, then the parsing will fail.
Reimplemented from vtkCommandOptions.
|
protectedvirtual |
|
protectedvirtual |
|
protectedvirtual |
|
protectedvirtual |
|
friend |
Definition at line 36 of file vtkPVOptions.h.
|
protected |
Subclasses may need to access these.
Definition at line 272 of file vtkPVOptions.h.
|
protected |
Subclasses may need to access these.
Definition at line 273 of file vtkPVOptions.h.
|
protected |
Subclasses may need to access these.
Definition at line 274 of file vtkPVOptions.h.
|
protected |
Subclasses may need to access these.
Definition at line 275 of file vtkPVOptions.h.
|
protected |
Subclasses may need to access these.
Definition at line 276 of file vtkPVOptions.h.
|
protected |
Subclasses may need to access these.
Definition at line 277 of file vtkPVOptions.h.
|
protected |
Subclasses may need to access these.
Definition at line 278 of file vtkPVOptions.h.
|
protected |
Subclasses may need to access these.
Definition at line 279 of file vtkPVOptions.h.
|
protected |
Subclasses may need to access these.
Definition at line 280 of file vtkPVOptions.h.
|
protected |
Subclasses may need to access these.
Definition at line 281 of file vtkPVOptions.h.
|
protected |
Subclasses may need to access these.
Definition at line 282 of file vtkPVOptions.h.
|
protected |
Subclasses may need to access these.
Definition at line 283 of file vtkPVOptions.h.
|
protected |
Subclasses may need to access these.
Definition at line 284 of file vtkPVOptions.h.