ParaView options for server executables. More...

#include <vtkPVServerOptions.h>

Inheritance diagram for vtkPVServerOptions:

Collaboration diagram for vtkPVServerOptions:

[legend]

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

int	ParseExtraXMLTag (const char name, const char *atts) override
	Pass in the name and the attributes for all tags that are not Options. More...

int	GetStereoType (unsigned int idx) const

char *	GetStereoType () override

bool	GetIsInCave () const override
	Returns true of CAVE configuration is requested. More...


virtual char *	GetClientHostName ()
	Name of the client-host. More...


virtual int	GetServerPort ()
	The configuration port for this process. More...


double	GetEyeSeparation () const
	Get information about machines used in a data or render server. More...

unsigned int	GetNumberOfMachines () const
	Get information about machines used in a data or render server. More...

const char *	GetMachineName (unsigned int idx) const
	Get information about machines used in a data or render server. More...

const char *	GetDisplayName (unsigned int idx) const
	Get information about machines used in a data or render server. More...

int *	GetGeometry (unsigned int idx) const
	Get information about machines used in a data or render server. More...

bool	GetFullScreen (unsigned int idx) const
	Get information about machines used in a data or render server. More...

bool	GetShowBorders (unsigned int idx) const
	Get information about machines used in a data or render server. More...

double *	GetLowerLeft (unsigned int idx) const
	Get information about machines used in a data or render server. More...

double *	GetLowerRight (unsigned int idx) const
	Get information about machines used in a data or render server. More...

double *	GetUpperRight (unsigned int idx) const
	Get information about machines used in a data or render server. More...

bool	GetCaveBoundsSet (unsigned int idx) const
	Get information about machines used in a data or render server. More...

Public Member Functions inherited from vtkPVOptions
virtual int	GetConnectID ()

virtual int	GetUseStereoRendering ()

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 bool	GetIsInTileDisplay () const
	Returns true if the tile display 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::string &	GetDisplay (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	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)

vtkCommand *	GetCommand (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)

vtkCommand *	GetCommand (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 vtkPVServerOptions *	New ()

static int	IsTypeOf (const char *type)

static vtkPVServerOptions *	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)

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

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 vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Protected Member Functions
int	AddMachineInformation (const char **atts)
	Add machine information from the xml tag <Machine .... More...

int	AddEyeSeparationInformation (const char **atts)
	Add eye separation information from the xml tag <EyeSeparation ...> More...

	vtkPVServerOptions ()
	Default constructor. More...

	~vtkPVServerOptions () override
	Destructor. More...

void	Initialize () override
	Initialize arguments. More...

virtual void	SetClientHostName (const char *)

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

	~vtkPVOptions () override
	Destructor. 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 *	ClientHostName

int	ServerPort

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

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

ParaView options for server executables.

An object of this class represents a storage for command line options for various server executables.

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

Definition at line 34 of file vtkPVServerOptions.h.

Member Typedef Documentation

◆ Superclass

typedef vtkPVOptions vtkPVServerOptions::Superclass

Definition at line 38 of file vtkPVServerOptions.h.

Constructor & Destructor Documentation

◆ vtkPVServerOptions()

vtkPVServerOptions::vtkPVServerOptions ( )

protected

Default constructor.

◆ ~vtkPVServerOptions()

vtkPVServerOptions::~vtkPVServerOptions ( )

overrideprotected

Destructor.

Member Function Documentation

◆ New()

static vtkPVServerOptions* vtkPVServerOptions::New ( )

static

◆ GetClassName()

virtual const char* vtkPVServerOptions::GetClassName ( )

virtual

Reimplemented from vtkPVOptions.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkPVOptions.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkPVOptions.

◆ GetClientHostName()

virtual char* vtkPVServerOptions::GetClientHostName ( )

virtual

Name of the client-host.

By default, the client are server are assumed to be on the same host.

◆ GetServerPort()

virtual int vtkPVServerOptions::GetServerPort ( )

virtual

The configuration port for this process.

The interpretation of the port number depends on the configuration and process type.

◆ ParseExtraXMLTag()

int vtkPVServerOptions::ParseExtraXMLTag	(	const char *	name,
		const char **	atts
	)

overridevirtual

Pass in the name and the attributes for all tags that are not Options.

If it returns 1, then it is successful, and 0 if it failed.

Reimplemented from vtkCommandOptions.