vtkPVOptions Class Reference

ParaView options storage. More...

#include <vtkPVOptions.h>

Inheritance diagram for vtkPVOptions:

Collaboration diagram for vtkPVOptions:

List of all members.

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual int	GetServerMode ()
virtual int	GetRenderServerMode ()
virtual int	GetConnectID ()
virtual int	GetUseOffscreenRendering ()
virtual int	GetUseStereoRendering ()
virtual char *	GetStereoType ()
virtual int	GetClientMode ()
virtual int	GetDisableComposite ()
virtual int	GetUseSoftwareRendering ()
virtual int	GetUseSatelliteSoftwareRendering ()
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 char *	GetRenderModuleName ()
virtual char *	GetCaveConfigurationFileName ()
virtual char *	GetMachinesFileName ()
virtual char *	GetGroupFileName ()
virtual char *	GetParaViewDataName ()
virtual char *	GetServerURL ()
	Provides access to server-url if specified on the command line.
virtual int	GetServerPort ()
virtual int	GetDataServerPort ()
virtual int	GetRenderServerPort ()
virtual int	GetRenderNodePort ()
virtual char *	GetStateFileName ()
virtual int	GetTimeout ()
virtual void	SetConnectID (int)
virtual char *	GetServerHostName ()
virtual char *	GetDataServerHostName ()
virtual char *	GetRenderServerHostName ()
virtual char *	GetClientHostName ()
virtual void	SetRenderModuleName (const char *)
virtual void	SetLogFileName (const char *)
virtual char *	GetLogFileName ()
virtual void	SetTileDimensions (int, int)
void	SetTileDimensions (int[2])
virtual void	SetTileMullions (int, int)
void	SetTileMullions (int[2])
virtual void	SetUseOffscreenRendering (int)
virtual int	GetClientRenderServer ()
virtual int	GetMultiClientMode ()
virtual int	GetMultiServerMode ()
virtual int	GetSymmetricMPIMode ()
virtual void	SetSymmetricMPIMode (int)
virtual int	GetTellVersion ()
Static Public Member Functions
static vtkPVOptions *	New ()
static int	IsTypeOf (const char *type)
static vtkPVOptions *	SafeDownCast (vtkObject *o)
Protected Types
enum	ProcessTypeEnum {   PARAVIEW = 0x2, PVCLIENT = 0x4, PVSERVER = 0x8, PVRENDER_SERVER = 0x10,   PVDATA_SERVER = 0x20, PVBATCH = 0x40, ALLPROCESS }
Protected Member Functions
	vtkPVOptions ()
virtual	~vtkPVOptions ()
virtual void	Initialize ()
virtual int	PostProcess (int argc, const char *const *argv)
virtual int	WrongArgument (const char *argument)
virtual int	DeprecatedArgument (const char *argument)
virtual void	SetRenderServerHostName (const char *)
virtual void	SetClientHostName (const char *)
virtual void	SetDataServerHostName (const char *)
virtual void	SetServerHostName (const char *)
virtual void	SetServerURL (const char *)
virtual void	SetStateFileName (const char *)
Protected Attributes
char *	RenderServerHostName
char *	ClientHostName
char *	DataServerHostName
char *	ServerHostName
char *	ServerURL
int	ServerPort
int	DataServerPort
int	RenderServerPort
int	RenderNodePort
int	ServerMode
int	ClientMode
int	RenderServerMode
int	MultiClientMode
int	MultiServerMode
int	SymmetricMPIMode
char *	StateFileName
Friends
class	vtkPVOptionsXMLParser
char *	ParaViewDataName
virtual void	SetParaViewDataName (const char *)

---

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

---

Member Enumeration Documentation

enum vtkPVOptions::ProcessTypeEnum [protected]

Enumerator:

PARAVIEW
PVCLIENT
PVSERVER
PVRENDER_SERVER
PVDATA_SERVER
PVBATCH
ALLPROCESS

Definition at line 35 of file vtkPVOptions.h.

---

Constructor & Destructor Documentation

vtkPVOptions::vtkPVOptions

(

)

[protected]

Default constructor.

virtual vtkPVOptions::~vtkPVOptions

(

)

[protected, virtual]

Destructor.

---

Member Function Documentation

static vtkPVOptions* vtkPVOptions::New

(

)

[static]

Reimplemented from vtkCommandOptions.

Reimplemented in pqOptions, vtkPVServerOptions, and vtkPVPythonOptions.

virtual const char* vtkPVOptions::GetClassName

(

)

[virtual]

Reimplemented from vtkCommandOptions.

Reimplemented in pqOptions, vtkPVServerOptions, and vtkPVPythonOptions.

static int vtkPVOptions::IsTypeOf

(

const char *

type

)

[static]

Reimplemented from vtkCommandOptions.

Reimplemented in pqOptions, vtkPVServerOptions, and vtkPVPythonOptions.

virtual int vtkPVOptions::IsA

(

const char *

type

)

[virtual]

Reimplemented from vtkCommandOptions.

Reimplemented in pqOptions, vtkPVServerOptions, and vtkPVPythonOptions.

static vtkPVOptions* vtkPVOptions::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkCommandOptions.

Reimplemented in pqOptions, vtkPVServerOptions, and vtkPVPythonOptions.

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

Reimplemented from vtkCommandOptions.

Reimplemented in pqOptions, vtkPVServerOptions, and vtkPVPythonOptions.

virtual int vtkPVOptions::GetServerMode

(

)

[virtual]

virtual int vtkPVOptions::GetRenderServerMode

(

)

[virtual]

virtual int vtkPVOptions::GetConnectID

(

)

[virtual]

virtual int vtkPVOptions::GetUseOffscreenRendering

(

)

[virtual]

virtual int vtkPVOptions::GetUseStereoRendering

(

)

[virtual]

virtual char* vtkPVOptions::GetStereoType

(

)

[virtual]

virtual int vtkPVOptions::GetClientMode

(

)

[virtual]

virtual int vtkPVOptions::GetServerPort

(

)

[virtual]

Get Various ports.

virtual int vtkPVOptions::GetDataServerPort

(

)

[virtual]

Get Various ports.

virtual int vtkPVOptions::GetRenderServerPort

(

)

[virtual]

Get Various ports.

virtual int vtkPVOptions::GetRenderNodePort

(

)

[virtual]

Get Various ports.

virtual int vtkPVOptions::GetDisableComposite

(

)

[virtual]

virtual int vtkPVOptions::GetUseSoftwareRendering

(

)

[virtual]

virtual int vtkPVOptions::GetUseSatelliteSoftwareRendering

(

)

[virtual]

virtual int vtkPVOptions::GetReverseConnection

(

)

[virtual]

virtual int vtkPVOptions::GetUseRenderingGroup

(

)

[virtual]

virtual int* vtkPVOptions::GetTileDimensions

(

)

[virtual]

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

virtual void vtkPVOptions::GetTileDimensions

(

int

[2]

)

[virtual]

virtual int* vtkPVOptions::GetTileMullions

(

)

[virtual]

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

virtual void vtkPVOptions::GetTileMullions

(

int

[2]

)

[virtual]

virtual char* vtkPVOptions::GetRenderModuleName

(

)

[virtual]

virtual char* vtkPVOptions::GetCaveConfigurationFileName

(

)

[virtual]

virtual char* vtkPVOptions::GetMachinesFileName

(

)

[virtual]

virtual char* vtkPVOptions::GetGroupFileName

(

)

[virtual]

virtual char* vtkPVOptions::GetParaViewDataName

(

)

[virtual]

virtual char* vtkPVOptions::GetStateFileName

(

)

[virtual]

State file to load on startup.

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.

virtual void vtkPVOptions::SetConnectID

(

int

)

[virtual]

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

virtual char* vtkPVOptions::GetServerHostName

(

)

[virtual]

Get the various types of host names.

virtual char* vtkPVOptions::GetDataServerHostName

(

)

[virtual]

Get the various types of host names.

virtual char* vtkPVOptions::GetRenderServerHostName

(

)

[virtual]

Get the various types of host names.

virtual char* vtkPVOptions::GetClientHostName

(

)

[virtual]

Get the various types of host names.

virtual void vtkPVOptions::SetRenderModuleName

(

const char *

)

[virtual]

vtkProcessModule needs to set the render module name

virtual void vtkPVOptions::SetLogFileName

(

const char *

)

[virtual]

Log filename.

virtual char* vtkPVOptions::GetLogFileName

(

)

[virtual]

Log filename.

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

vtkPVProcessModule needs to set this.

void vtkPVOptions::SetTileDimensions

(

int

[2]

)

vtkPVProcessModule needs to set this.

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

vtkPVProcessModule needs to set this.

void vtkPVOptions::SetTileMullions

(

int

[2]

)

vtkPVProcessModule needs to set this.

virtual void vtkPVOptions::SetUseOffscreenRendering

(

int

)

[virtual]

vtkPVProcessModule needs to set this.

virtual int vtkPVOptions::GetClientRenderServer

(

)

[virtual]

Is this in render server mode.

virtual int vtkPVOptions::GetMultiClientMode

(

)

[virtual]

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.

virtual int vtkPVOptions::GetMultiServerMode

(

)

[virtual]

Is this client allow multiple server connection in parallel

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.

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.

virtual int vtkPVOptions::GetTellVersion

(

)

[virtual]

Should this run print the version numbers and exit.

virtual char* vtkPVOptions::GetServerURL

(

)

[virtual]

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

virtual void vtkPVOptions::Initialize

(

)

[protected, virtual]

Initialize arguments.

Reimplemented from vtkCommandOptions.

Reimplemented in pqOptions, and vtkPVServerOptions.

virtual int vtkPVOptions::PostProcess	(	int	argc,
		const char *const *	argv
	)		[protected, virtual]

After parsing, process extra option dependencies.

Reimplemented from vtkCommandOptions.

Reimplemented in pqOptions, and vtkPVPythonOptions.

virtual int vtkPVOptions::WrongArgument

(

const char *

argument

)

[protected, virtual]

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.

virtual int vtkPVOptions::DeprecatedArgument

(

const char *

argument

)

[protected, virtual]

This method is called when a deprecated argument is found. If it returns 0, then the parsing will fail.

Reimplemented from vtkCommandOptions.

virtual void vtkPVOptions::SetParaViewDataName

(

const char *

)

[protected, virtual]

Subclasses may need to access these

virtual void vtkPVOptions::SetRenderServerHostName

(

const char *

)

[protected, virtual]

virtual void vtkPVOptions::SetClientHostName

(

const char *

)

[protected, virtual]

virtual void vtkPVOptions::SetDataServerHostName

(

const char *

)

[protected, virtual]

virtual void vtkPVOptions::SetServerHostName

(

const char *

)

[protected, virtual]

virtual void vtkPVOptions::SetServerURL

(

const char *

)

[protected, virtual]

virtual void vtkPVOptions::SetStateFileName

(

const char *

)

[protected, virtual]

---

Friends And Related Function Documentation

friend class vtkPVOptionsXMLParser [friend]

Definition at line 46 of file vtkPVOptions.h.

---

Member Data Documentation

char* vtkPVOptions::ParaViewDataName [protected]

Subclasses may need to access these

Definition at line 185 of file vtkPVOptions.h.

char* vtkPVOptions::RenderServerHostName [protected]

Definition at line 189 of file vtkPVOptions.h.

char* vtkPVOptions::ClientHostName [protected]

Definition at line 192 of file vtkPVOptions.h.

char* vtkPVOptions::DataServerHostName [protected]

Definition at line 195 of file vtkPVOptions.h.

char* vtkPVOptions::ServerHostName [protected]

Definition at line 198 of file vtkPVOptions.h.

char* vtkPVOptions::ServerURL [protected]

Definition at line 202 of file vtkPVOptions.h.

int vtkPVOptions::ServerPort [protected]

Definition at line 206 of file vtkPVOptions.h.

int vtkPVOptions::DataServerPort [protected]

Definition at line 207 of file vtkPVOptions.h.

int vtkPVOptions::RenderServerPort [protected]

Definition at line 208 of file vtkPVOptions.h.

int vtkPVOptions::RenderNodePort [protected]

Definition at line 209 of file vtkPVOptions.h.

int vtkPVOptions::ServerMode [protected]

Definition at line 211 of file vtkPVOptions.h.

int vtkPVOptions::ClientMode [protected]

Definition at line 212 of file vtkPVOptions.h.

int vtkPVOptions::RenderServerMode [protected]

Definition at line 213 of file vtkPVOptions.h.

int vtkPVOptions::MultiClientMode [protected]

Definition at line 214 of file vtkPVOptions.h.

int vtkPVOptions::MultiServerMode [protected]

Definition at line 215 of file vtkPVOptions.h.

int vtkPVOptions::SymmetricMPIMode [protected]

Definition at line 217 of file vtkPVOptions.h.

char* vtkPVOptions::StateFileName [protected]

Definition at line 220 of file vtkPVOptions.h.

---

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

• dox/ParaViewCore/ClientServerCore/vtkPVOptions.h