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

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

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 37 of file vtkPVOptions.h.

Member Typedef Documentation

◆ Superclass

Definition at line 44 of file vtkPVOptions.h.

Member Enumeration Documentation

◆ ProcessTypeEnum

Enumerator
PARAVIEW 
PVCLIENT 
PVSERVER 
PVRENDER_SERVER 
PVDATA_SERVER 
PVBATCH 
ALLPROCESS 

Definition at line 283 of file vtkPVOptions.h.

Constructor & Destructor Documentation

◆ vtkPVOptions()

vtkPVOptions::vtkPVOptions ( )
protected

Default constructor.

◆ ~vtkPVOptions()

vtkPVOptions::~vtkPVOptions ( )
overrideprotected

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

Reimplemented from vtkObject.

Reimplemented in vtkPVServerOptions, and vtkPVPythonOptions.

◆ GetHostName()

virtual char* vtkPVOptions::GetHostName ( )
virtual

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

◆ GetConnectID()

virtual int vtkPVOptions::GetConnectID ( )
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

◆ GetIsInTileDisplay()

virtual bool vtkPVOptions::GetIsInTileDisplay ( ) const
virtual

Returns true if the tile display configuration is requested.

◆ GetIsInCave()

virtual bool vtkPVOptions::GetIsInCave ( ) const
virtual

Returns true of CAVE configuration is requested.

Reimplemented in vtkPVServerOptions.

◆ GetEGLDeviceIndex()

virtual int vtkPVOptions::GetEGLDeviceIndex ( )
virtual

Returns the egl device index.

-1 indicates that no value was specified.

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

◆ GetServersFileName()

virtual char* vtkPVOptions::GetServersFileName ( )
virtual

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

◆ 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 124 of file vtkPVOptions.h.

◆ IsMultiClientModeDebug()

virtual int vtkPVOptions::IsMultiClientModeDebug ( )
inlinevirtual

Definition at line 128 of file vtkPVOptions.h.

◆ GetDisableFurtherConnections()

virtual int vtkPVOptions::GetDisableFurtherConnections ( )
virtual

Returns if this server does not allow connection after the first client.

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

◆ GetCatalystLivePort()

virtual int vtkPVOptions::GetCatalystLivePort ( )
virtual

Provides access to the Catalyst Live port if specified on the command line.

A value of -1 indicates that no value was set.

◆ SetParaViewDataName()

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

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

◆ SetEnableStreaming()

virtual void vtkPVOptions::SetEnableStreaming ( int  )
virtual

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

◆ GetEnableStreaming()

virtual int vtkPVOptions::GetEnableStreaming ( )
virtual

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

◆ 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?

◆ GetTestPlugins()

virtual char* vtkPVOptions::GetTestPlugins ( )
virtual

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

◆ GetTestPluginPaths()

virtual char* vtkPVOptions::GetTestPluginPaths ( )
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.

◆ GetForceOffscreenRendering()

virtual int vtkPVOptions::GetForceOffscreenRendering ( )
virtual

When set to true, ParaView will create headless only render windows on the current process.

◆ GetForceOnscreenRendering()

virtual int vtkPVOptions::GetForceOnscreenRendering ( )
virtual

When set to true, ParaView will create on-screen render windows.

◆ GetForceNoMPIInitOnClient()

virtual int vtkPVOptions::GetForceNoMPIInitOnClient ( )
virtual

Get/Set the ForceNoMPIInitOnClient flag.

◆ SetForceNoMPIInitOnClient()

virtual void vtkPVOptions::SetForceNoMPIInitOnClient ( int  )
virtual

Get/Set the ForceNoMPIInitOnClient flag.

◆ ForceNoMPIInitOnClientOn()

virtual void vtkPVOptions::ForceNoMPIInitOnClientOn ( )
virtual

Get/Set the ForceNoMPIInitOnClient flag.

◆ ForceNoMPIInitOnClientOff()

virtual void vtkPVOptions::ForceNoMPIInitOnClientOff ( )
virtual

Get/Set the ForceNoMPIInitOnClient flag.

◆ GetForceMPIInitOnClient()

virtual int vtkPVOptions::GetForceMPIInitOnClient ( )
virtual

Get/Set the ForceMPIInitOnClient flag.

◆ SetForceMPIInitOnClient()

virtual void vtkPVOptions::SetForceMPIInitOnClient ( int  )
virtual

Get/Set the ForceMPIInitOnClient flag.

◆ ForceMPIInitOnClientOn()

virtual void vtkPVOptions::ForceMPIInitOnClientOn ( )
virtual

Get/Set the ForceMPIInitOnClient flag.

◆ ForceMPIInitOnClientOff()

virtual void vtkPVOptions::ForceMPIInitOnClientOff ( )
virtual

Get/Set the ForceMPIInitOnClient flag.

◆ GetLogStdErrVerbosity()

virtual int vtkPVOptions::GetLogStdErrVerbosity ( )
virtual

Returns the verbosity level for stderr output chosen.

Is set to vtkLogger::VERBOSITY_INVALID if not specified.

◆ GetDisplay()

const std::string& vtkPVOptions::GetDisplay ( int  myrank = 0,
int  num_ranks = 1 
)

Provides access to display selection.

These can be interpreted as EGL device indices or DISPLAY selection. When not specified, this returns an empty string.

◆ Initialize()

void vtkPVOptions::Initialize ( )
overrideprotectedvirtual

Initialize arguments.

Reimplemented from vtkCommandOptions.

Reimplemented in vtkPVServerOptions.

◆ PostProcess()

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

After parsing, process extra option dependencies.

Reimplemented from vtkCommandOptions.

◆ WrongArgument()

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

Reimplemented in vtkPVPythonOptions.

◆ DeprecatedArgument()

int vtkPVOptions::DeprecatedArgument ( const char *  argument)
overrideprotectedvirtual

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

◆ SetServersFileName()

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

◆ SetTestPlugins()

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

◆ SetTestPluginPaths()

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

Friends And Related Function Documentation

◆ vtkPVOptionsXMLParser

friend class vtkPVOptionsXMLParser
friend

Definition at line 40 of file vtkPVOptions.h.

Member Data Documentation

◆ ParaViewDataName

char* vtkPVOptions::ParaViewDataName
protected

Subclasses may need to access these.

Definition at line 331 of file vtkPVOptions.h.

◆ ServerURL

char* vtkPVOptions::ServerURL
protected

Subclasses may need to access these.

Definition at line 332 of file vtkPVOptions.h.

◆ ServerMode

int vtkPVOptions::ServerMode
protected

Subclasses may need to access these.

Definition at line 333 of file vtkPVOptions.h.

◆ ClientMode

int vtkPVOptions::ClientMode
protected

Subclasses may need to access these.

Definition at line 334 of file vtkPVOptions.h.

◆ RenderServerMode

int vtkPVOptions::RenderServerMode
protected

Subclasses may need to access these.

Definition at line 335 of file vtkPVOptions.h.

◆ MultiClientMode

int vtkPVOptions::MultiClientMode
protected

Subclasses may need to access these.

Definition at line 336 of file vtkPVOptions.h.

◆ DisableFurtherConnections

int vtkPVOptions::DisableFurtherConnections
protected

Subclasses may need to access these.

Definition at line 337 of file vtkPVOptions.h.

◆ MultiClientModeWithErrorMacro

int vtkPVOptions::MultiClientModeWithErrorMacro
protected

Subclasses may need to access these.

Definition at line 338 of file vtkPVOptions.h.

◆ MultiServerMode

int vtkPVOptions::MultiServerMode
protected

Subclasses may need to access these.

Definition at line 339 of file vtkPVOptions.h.

◆ SymmetricMPIMode

int vtkPVOptions::SymmetricMPIMode
protected

Subclasses may need to access these.

Definition at line 340 of file vtkPVOptions.h.

◆ ServersFileName

char* vtkPVOptions::ServersFileName
protected

Subclasses may need to access these.

Definition at line 341 of file vtkPVOptions.h.

◆ TestPlugins

char* vtkPVOptions::TestPlugins
protected

Subclasses may need to access these.

Definition at line 342 of file vtkPVOptions.h.

◆ TestPluginPaths

char* vtkPVOptions::TestPluginPaths
protected

Subclasses may need to access these.

Definition at line 343 of file vtkPVOptions.h.

◆ DisableXDisplayTests

int vtkPVOptions::DisableXDisplayTests
protected

Subclasses may need to access these.

Definition at line 344 of file vtkPVOptions.h.

◆ CatalystLivePort

int vtkPVOptions::CatalystLivePort
protected

Subclasses may need to access these.

Definition at line 346 of file vtkPVOptions.h.


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