vtkPVOptions Class Reference

ParaView options storage. More...

#include <vtkPVOptions.h>

Inheritance diagram for vtkPVOptions:

[legend]Collaboration diagram for vtkPVOptions:

[legend]List of all members.

[NOHEADER]
virtual void	SetParaViewDataName (const char *)
char *	ParaViewDataName
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 }
Public Member Functions
	vtkTypeRevisionMacro (vtkPVOptions, vtkCommandOptions)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual int	GetServerMode ()
virtual int	GetRenderServerMode ()
virtual int	GetConnectID ()
virtual int	GetUseOffscreenRendering ()
virtual int	GetUseStereoRendering ()
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 char *	GetRenderModuleName ()
virtual char *	GetCaveConfigurationFileName ()
virtual char *	GetMachinesFileName ()
virtual char *	GetGroupFileName ()
virtual char *	GetParaViewDataName ()
virtual int	GetServerPort ()
virtual int	GetDataServerPort ()
virtual int	GetRenderServerPort ()
virtual int	GetRenderNodePort ()
virtual char *	GetServerHostName ()
virtual char *	GetDataServerHostName ()
virtual char *	GetRenderServerHostName ()
virtual char *	GetClientHostName ()
virtual void	SetRenderModuleName (const char *)
virtual void	SetTileDimensions (int, int)
void	SetTileDimensions (int[2])
virtual void	SetUseOffscreenRendering (int)
virtual int	GetClientRenderServer ()
virtual int	GetTellVersion ()
Static Public Member Functions
vtkPVOptions *	New ()
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 *)
Protected Attributes
char *	RenderServerHostName
char *	ClientHostName
char *	DataServerHostName
char *	ServerHostName
int	ServerPort
int	DataServerPort
int	RenderServerPort
int	RenderNodePort
int	ServerMode
int	ClientMode
int	RenderServerMode

---

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

Enumeration values: PARAVIEW  PVCLIENT  PVSERVER  PVRENDER_SERVER  PVDATA_SERVER  PVBATCH  ALLPROCESS  Definition at line 34 of file vtkPVOptions.h.

---

Constructor & Destructor Documentation

vtkPVOptions::vtkPVOptions (   )  [protected]

Default constructor.

virtual vtkPVOptions::~vtkPVOptions (   )  [protected, virtual]

Destructor.

---

Member Function Documentation

vtkPVOptions* vtkPVOptions::New (   )  [static]

Reimplemented from vtkCommandOptions. Reimplemented in vtkPVServerOptions, vtkPVBatchOptions, and vtkPVGUIClientOptions.

vtkPVOptions::vtkTypeRevisionMacro (  vtkPVOptions  , vtkCommandOptions  )

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

Reimplemented from vtkCommandOptions. Reimplemented in vtkPVServerOptions, vtkPVBatchOptions, and vtkPVGUIClientOptions.

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 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 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::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::SetTileDimensions (  int  , int  )  [virtual]

vtkPVProcessModule needs to set this.

void vtkPVOptions::SetTileDimensions (  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::GetTellVersion (   )  [virtual]

Should this run print the version numbers and exit.

virtual void vtkPVOptions::Initialize (   )  [protected, virtual]

Initialize arguments. Reimplemented from vtkCommandOptions. Reimplemented in vtkPVServerOptions, vtkPVBatchOptions, and vtkPVGUIClientOptions.

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

After parsing, process extra option dependencies. Reimplemented from vtkCommandOptions. Reimplemented in vtkPVBatchOptions, and vtkPVGUIClientOptions.

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 vtkPVBatchOptions, and vtkPVGUIClientOptions.

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]

---

Member Data Documentation

char* vtkPVOptions::ParaViewDataName [protected]

Subclasses may need to access these Definition at line 128 of file vtkPVOptions.h.

char* vtkPVOptions::RenderServerHostName [protected]

Definition at line 132 of file vtkPVOptions.h.

char* vtkPVOptions::ClientHostName [protected]

Definition at line 135 of file vtkPVOptions.h.

char* vtkPVOptions::DataServerHostName [protected]

Definition at line 138 of file vtkPVOptions.h.

char* vtkPVOptions::ServerHostName [protected]

Definition at line 141 of file vtkPVOptions.h.

int vtkPVOptions::ServerPort [protected]

Definition at line 144 of file vtkPVOptions.h.

int vtkPVOptions::DataServerPort [protected]

Definition at line 145 of file vtkPVOptions.h.

int vtkPVOptions::RenderServerPort [protected]

Definition at line 146 of file vtkPVOptions.h.

int vtkPVOptions::RenderNodePort [protected]

Definition at line 147 of file vtkPVOptions.h.

int vtkPVOptions::ServerMode [protected]

Definition at line 149 of file vtkPVOptions.h.

int vtkPVOptions::ClientMode [protected]

Definition at line 150 of file vtkPVOptions.h.

int vtkPVOptions::RenderServerMode [protected]

Definition at line 151 of file vtkPVOptions.h.

---

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

• Servers/Common/vtkPVOptions.h

---