ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkPVServerOptions Class Reference

ParaView options for server executables. More...

#include <vtkPVServerOptions.h>

Inheritance diagram for vtkPVServerOptions:
Inheritance graph
[legend]
Collaboration diagram for vtkPVServerOptions:
Collaboration graph
[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)
 
virtual int ParseExtraXMLTag (const char *name, const char **atts)
 Pass in the name and the attributes for all tags that are not Options. More...
 
int GetStereoType (unsigned int idx)
 
virtual char * GetStereoType ()
 
virtual char * GetClientHostName ()
 Name of the client-host. More...
 
virtual int GetServerPort ()
 The configuration port for this process. More...
 
double GetEyeSeparation ()
 Get information about machines used in a data or render server. More...
 
unsigned int GetNumberOfMachines ()
 Get information about machines used in a data or render server. More...
 
const char * GetMachineName (unsigned int idx)
 Get information about machines used in a data or render server. More...
 
const char * GetDisplayName (unsigned int idx)
 Get information about machines used in a data or render server. More...
 
int * GetGeometry (unsigned int idx)
 Get information about machines used in a data or render server. More...
 
bool GetFullScreen (unsigned int idx)
 Get information about machines used in a data or render server. More...
 
bool GetShowBorders (unsigned int idx)
 Get information about machines used in a data or render server. More...
 
double * GetLowerLeft (unsigned int idx)
 Get information about machines used in a data or render server. More...
 
double * GetLowerRight (unsigned int idx)
 Get information about machines used in a data or render server. More...
 
double * GetUpperRight (unsigned int idx)
 Get information about machines used in a data or render server. More...
 
- Public Member Functions inherited from vtkPVOptions
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual int GetConnectID ()
 
virtual int GetUseOffscreenRendering ()
 
virtual int GetEGLDeviceIndex ()
 
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 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...
 
- Public Member Functions inherited from vtkCommandOptions
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 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 vtkPVServerOptionsNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPVServerOptionsSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkPVOptions
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)
 

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...
 
virtual ~vtkPVServerOptions ()
 Destructor. More...
 
virtual void Initialize ()
 Initialize arguments. More...
 
virtual void SetClientHostName (const char *)
 
- Protected Member Functions inherited from vtkPVOptions
 vtkPVOptions ()
 Default constructor. More...
 
virtual ~vtkPVOptions ()
 Destructor. 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 *)
 
- Protected Member Functions inherited from vtkCommandOptions
 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 * 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 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...
 
- Protected Attributes inherited from vtkCommandOptions
vtkCommandOptionsXMLParserXMLParser
 

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

Definition at line 38 of file vtkPVServerOptions.h.

Constructor & Destructor Documentation

◆ vtkPVServerOptions()

vtkPVServerOptions::vtkPVServerOptions ( )
protected

Default constructor.

◆ ~vtkPVServerOptions()

virtual vtkPVServerOptions::~vtkPVServerOptions ( )
protectedvirtual

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 
)

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

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

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.

◆ GetEyeSeparation()

double vtkPVServerOptions::GetEyeSeparation ( )

Get information about machines used in a data or render server.

◆ GetNumberOfMachines()

unsigned int vtkPVServerOptions::GetNumberOfMachines ( )

Get information about machines used in a data or render server.

◆ GetMachineName()

const char* vtkPVServerOptions::GetMachineName ( unsigned int  idx)

Get information about machines used in a data or render server.

◆ GetDisplayName()

const char* vtkPVServerOptions::GetDisplayName ( unsigned int  idx)

Get information about machines used in a data or render server.

◆ GetGeometry()

int* vtkPVServerOptions::GetGeometry ( unsigned int  idx)

Get information about machines used in a data or render server.

◆ GetFullScreen()

bool vtkPVServerOptions::GetFullScreen ( unsigned int  idx)

Get information about machines used in a data or render server.

◆ GetShowBorders()

bool vtkPVServerOptions::GetShowBorders ( unsigned int  idx)

Get information about machines used in a data or render server.

◆ GetLowerLeft()

double* vtkPVServerOptions::GetLowerLeft ( unsigned int  idx)

Get information about machines used in a data or render server.

◆ GetLowerRight()

double* vtkPVServerOptions::GetLowerRight ( unsigned int  idx)

Get information about machines used in a data or render server.

◆ GetUpperRight()

double* vtkPVServerOptions::GetUpperRight ( unsigned int  idx)

Get information about machines used in a data or render server.

◆ GetStereoType() [1/2]

int vtkPVServerOptions::GetStereoType ( unsigned int  idx)

◆ GetStereoType() [2/2]

virtual char* vtkPVServerOptions::GetStereoType ( )
inlinevirtual

Reimplemented from vtkPVOptions.

Definition at line 82 of file vtkPVServerOptions.h.

◆ AddMachineInformation()

int vtkPVServerOptions::AddMachineInformation ( const char **  atts)
protected

Add machine information from the xml tag <Machine ....

>

◆ AddEyeSeparationInformation()

int vtkPVServerOptions::AddEyeSeparationInformation ( const char **  atts)
protected

Add eye separation information from the xml tag <EyeSeparation ...>

◆ Initialize()

virtual void vtkPVServerOptions::Initialize ( )
protectedvirtual

Initialize arguments.

Reimplemented from vtkPVOptions.

◆ SetClientHostName()

virtual void vtkPVServerOptions::SetClientHostName ( const char *  )
protectedvirtual

Member Data Documentation

◆ ClientHostName

char* vtkPVServerOptions::ClientHostName
protected

Definition at line 106 of file vtkPVServerOptions.h.

◆ ServerPort

int vtkPVServerOptions::ServerPort
protected

Definition at line 109 of file vtkPVServerOptions.h.


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