Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkRemotingCoreConfiguration Class Reference

runtime configuration options for vtkRemotingCore module. More...

#include <vtkRemotingCoreConfiguration.h>

Inheritance diagram for vtkRemotingCoreConfiguration:
Inheritance graph
[legend]
Collaboration diagram for vtkRemotingCoreConfiguration:
Collaboration graph
[legend]

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
virtual bool GetTellVersion ()
 Flag set when user expects the executable to simply print out the version number and exit. More...
 
virtual bool GetDisableRegistry ()
 Get whether to load user-specific session/configuration files from previous session or start the application using default configuration. More...
 
virtual bool GetPrintMonitors ()
 Print monitor information and exit. More...
 
const std::stringGetHostName () const
 Get the hostname to use. More...
 
const std::stringGetClientHostName () const
 Get the hostname for the "client" process. More...
 
virtual int GetServerPort ()
 Get the server-port number to use. More...
 
virtual bool GetReverseConnection ()
 Get if the process is acting in reverse connection mode. More...
 
virtual int GetConnectID ()
 Returns the connection identifier used to validate client-server connections. More...
 
virtual void SetConnectID (int)
 
virtual int GetTimeout ()
 On server processes, this denotes the time (in minutes) since the time that the connection was established with the server that the server may timeout. More...
 
const std::stringGetTimeoutCommand () const
 Get the timeout command, called regularly on server side and giving remaining time available for server access. More...
 
const std::stringGetServerURL () const
 On client processes, this returns the server connection url to use to connect to the server process(es) on startup, if any. More...
 
const std::stringGetServerResourceName () const
 On client processes, this returns the server connection resource name to use to connect to the server process(es) on startup, if any. More...
 
const std::vector< std::string > & GetServerConfigurationsFiles () const
 On client processes, this provides list of server configurations files to use instead of the default user-specific server configurations file. More...
 
const std::vector< std::string > & GetPluginSearchPaths () const
 Get a list of paths to add to plugin search paths. More...
 
const std::vector< std::string > & GetPlugins () const
 Get a list of names for plugins to load. More...
 
virtual bool GetUseStereoRendering ()
 Get whether stereo rendering is enabled. More...
 
virtual int GetStereoType ()
 Get stereo type requested. More...
 
const char * GetStereoTypeAsString () const
 
double GetEyeSeparation () const
 Eye separation to use when using stereo rendering. More...
 
virtual intGetTileMullions ()
 Get the gap in pixel between tiles in a tile display. More...
 
virtual void GetTileMullions (int &, int &)
 
virtual void GetTileMullions (int [2])
 
void GetTileDimensions (int dims[2])
 Get the dimensions of the tile display. More...
 
const intGetTileDimensions ()
 
bool GetIsInTileDisplay () const
 Returns true if in tile display mode. More...
 
bool GetIsInCave () const
 Returns true of in CAVE mode. More...
 
vtkDisplayConfigurationGetDisplayConfiguration () const
 When in CAVE mode, returns the display configurations. More...
 
virtual bool GetDisableXDisplayTests ()
 XDisplay test on server processes during initialization sometimes happens too early and may result in remote rendering prematurely disabled. More...
 
virtual bool GetForceOffscreenRendering ()
 When set to true, ParaView will create headless only render windows on the current process. More...
 
virtual bool GetForceOnscreenRendering ()
 When set to true, ParaView will create on-screen render windows. More...
 
int GetEGLDeviceIndex ()
 Returns the EGL device index for the current process. More...
 
std::string GetDisplay ()
 Returns the display setting, if any, for the current process. More...
 
virtual bool GetMultiServerMode ()
 Returns true on client process if it should enable connecting to multiple servers at the same time. More...
 
virtual bool GetMultiClientMode ()
 Returns true data server process if the server should allow connecting to multiple clients in a collaboration mode. More...
 
virtual bool GetDisableFurtherConnections ()
 Returns if this server does not allow connection after the first client. More...
 
bool PopulateOptions (vtkCLIOptions *app, vtkProcessModule::ProcessTypes processType)
 Populates vtkCLIOptions with available command line options. More...
 
bool PopulateGlobalOptions (vtkCLIOptions *app, vtkProcessModule::ProcessTypes processType)
 
bool PopulateConnectionOptions (vtkCLIOptions *app, vtkProcessModule::ProcessTypes processType)
 
bool PopulatePluginOptions (vtkCLIOptions *app, vtkProcessModule::ProcessTypes processType)
 
bool PopulateRenderingOptions (vtkCLIOptions *app, vtkProcessModule::ProcessTypes processType)
 
bool PopulateMiscellaneousOptions (vtkCLIOptions *app, vtkProcessModule::ProcessTypes processType)
 
void HandleDisplayEnvironment ()
 Method to setup environment variables for display. 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 int IsTypeOf (const char *type)
 
static vtkRemotingCoreConfigurationSafeDownCast (vtkObject *o)
 
static vtkRemotingCoreConfigurationGetInstance ()
 Provides access to the singleton. More...
 
- 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

 vtkRemotingCoreConfiguration ()
 
 ~vtkRemotingCoreConfiguration () override
 
- 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 &)
 

Additional Inherited Members

- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

runtime configuration options for vtkRemotingCore module.

vtkRemotingCoreConfiguration is a singleton that maintains runtime configuration for the process. These can be thought of as options settable by command line arguments and hence are initialized when the process launches and are not changed during the lifetime of the process.

vtkRemotingCoreConfiguration can be setup via command line arguments. For that, create a vtkCLIOptions object and populate it using PopulateOptions method. vtkCLIOptions can then pass command line arguments for parsing.

Definition at line 42 of file vtkRemotingCoreConfiguration.h.

Member Typedef Documentation

◆ Superclass

Definition at line 45 of file vtkRemotingCoreConfiguration.h.

Constructor & Destructor Documentation

◆ vtkRemotingCoreConfiguration()

vtkRemotingCoreConfiguration::vtkRemotingCoreConfiguration ( )
protected

◆ ~vtkRemotingCoreConfiguration()

vtkRemotingCoreConfiguration::~vtkRemotingCoreConfiguration ( )
overrideprotected

Member Function Documentation

◆ GetClassName()

virtual const char* vtkRemotingCoreConfiguration::GetClassName ( )
virtual

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

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

◆ PrintSelf()

void vtkRemotingCoreConfiguration::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Reimplemented from vtkObject.

◆ GetInstance()

static vtkRemotingCoreConfiguration* vtkRemotingCoreConfiguration::GetInstance ( )
static

Provides access to the singleton.

◆ GetTellVersion()

virtual bool vtkRemotingCoreConfiguration::GetTellVersion ( )
virtual

Flag set when user expects the executable to simply print out the version number and exit.

◆ GetDisableRegistry()

virtual bool vtkRemotingCoreConfiguration::GetDisableRegistry ( )
virtual

Get whether to load user-specific session/configuration files from previous session or start the application using default configuration.

◆ GetPrintMonitors()

virtual bool vtkRemotingCoreConfiguration::GetPrintMonitors ( )
virtual

Print monitor information and exit.

This is currently only supported on Windows.

◆ GetHostName()

const std::string& vtkRemotingCoreConfiguration::GetHostName ( ) const
inline

Get the hostname to use.

By default, this is initialized to the hostname determined automatically using system calls (specifically, vtksys::SystemInformation).

Definition at line 84 of file vtkRemotingCoreConfiguration.h.

◆ GetClientHostName()

const std::string& vtkRemotingCoreConfiguration::GetClientHostName ( ) const
inline

Get the hostname for the "client" process.

This is used by server processes when in reverse-connection mode to determine where the client can be reached. Default is "localhost".

Definition at line 91 of file vtkRemotingCoreConfiguration.h.

◆ GetServerPort()

virtual int vtkRemotingCoreConfiguration::GetServerPort ( )
virtual

Get the server-port number to use.

This is the port number that a server-process is expected to use as the 'listening' port. For reverse-connection, this is the port number that the client process is listening on.

◆ GetReverseConnection()

virtual bool vtkRemotingCoreConfiguration::GetReverseConnection ( )
virtual

Get if the process is acting in reverse connection mode.

This flag is only read on the server processes since client is capable of supported reverse and non-reverse connections in the same process.

◆ GetConnectID()

virtual int vtkRemotingCoreConfiguration::GetConnectID ( )
virtual

Returns the connection identifier used to validate client-server connections.

◆ SetConnectID()

virtual void vtkRemotingCoreConfiguration::SetConnectID ( int  )
virtual
Note
This API may change in future. This is left as is for now to keep changes in this MR to a minimal.

◆ GetTimeout()

virtual int vtkRemotingCoreConfiguration::GetTimeout ( )
virtual

On server processes, this 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.

◆ GetTimeoutCommand()

const std::string& vtkRemotingCoreConfiguration::GetTimeoutCommand ( ) const
inline

Get the timeout command, called regularly on server side and giving remaining time available for server access.

Definition at line 131 of file vtkRemotingCoreConfiguration.h.

◆ GetServerURL()

const std::string& vtkRemotingCoreConfiguration::GetServerURL ( ) const
inline

On client processes, this returns the server connection url to use to connect to the server process(es) on startup, if any.

See also
GetServerResourceName

Definition at line 139 of file vtkRemotingCoreConfiguration.h.

◆ GetServerResourceName()

const std::string& vtkRemotingCoreConfiguration::GetServerResourceName ( ) const
inline

On client processes, this returns the server connection resource name to use to connect to the server process(es) on startup, if any.

Definition at line 145 of file vtkRemotingCoreConfiguration.h.

◆ GetServerConfigurationsFiles()

const std::vector<std::string>& vtkRemotingCoreConfiguration::GetServerConfigurationsFiles ( ) const
inline

On client processes, this provides list of server configurations files to use instead of the default user-specific server configurations file.

Definition at line 151 of file vtkRemotingCoreConfiguration.h.

◆ GetPluginSearchPaths()

const std::vector<std::string>& vtkRemotingCoreConfiguration::GetPluginSearchPaths ( ) const
inline

Get a list of paths to add to plugin search paths.

Any plugin requested by name will be searched under these paths.

Definition at line 165 of file vtkRemotingCoreConfiguration.h.

◆ GetPlugins()

const std::vector<std::string>& vtkRemotingCoreConfiguration::GetPlugins ( ) const
inline

Get a list of names for plugins to load.

Definition at line 170 of file vtkRemotingCoreConfiguration.h.

◆ GetUseStereoRendering()

virtual bool vtkRemotingCoreConfiguration::GetUseStereoRendering ( )
virtual

Get whether stereo rendering is enabled.

This is only valid on rendering processes.

◆ GetStereoType()

virtual int vtkRemotingCoreConfiguration::GetStereoType ( )
virtual

Get stereo type requested.

Returned values are VTK_STEREO_* defined in vtkRenderWindow.h.

◆ GetStereoTypeAsString()

const char* vtkRemotingCoreConfiguration::GetStereoTypeAsString ( ) const

◆ GetEyeSeparation()

double vtkRemotingCoreConfiguration::GetEyeSeparation ( ) const

Eye separation to use when using stereo rendering.

◆ GetTileMullions() [1/3]

virtual int* vtkRemotingCoreConfiguration::GetTileMullions ( )
virtual

Get the gap in pixel between tiles in a tile display.

/

◆ GetTileMullions() [2/3]

virtual void vtkRemotingCoreConfiguration::GetTileMullions ( int ,
int  
)
virtual

◆ GetTileMullions() [3/3]

virtual void vtkRemotingCoreConfiguration::GetTileMullions ( int  [2])
virtual

◆ GetTileDimensions() [1/2]

void vtkRemotingCoreConfiguration::GetTileDimensions ( int  dims[2])

Get the dimensions of the tile display.

◆ GetTileDimensions() [2/2]

const int* vtkRemotingCoreConfiguration::GetTileDimensions ( )

◆ GetIsInTileDisplay()

bool vtkRemotingCoreConfiguration::GetIsInTileDisplay ( ) const

Returns true if in tile display mode.

◆ GetIsInCave()

bool vtkRemotingCoreConfiguration::GetIsInCave ( ) const

Returns true of in CAVE mode.

◆ GetDisplayConfiguration()

vtkDisplayConfiguration* vtkRemotingCoreConfiguration::GetDisplayConfiguration ( ) const
inline

When in CAVE mode, returns the display configurations.

Definition at line 219 of file vtkRemotingCoreConfiguration.h.

◆ GetDisableXDisplayTests()

virtual bool vtkRemotingCoreConfiguration::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 bool vtkRemotingCoreConfiguration::GetForceOffscreenRendering ( )
virtual

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

◆ GetForceOnscreenRendering()

virtual bool vtkRemotingCoreConfiguration::GetForceOnscreenRendering ( )
virtual

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

◆ GetEGLDeviceIndex()

int vtkRemotingCoreConfiguration::GetEGLDeviceIndex ( )

Returns the EGL device index for the current process.

This uses vtkMultiProcessController::GetLocalProcessId to determine the rank of the process. -1 indicates no index was specified.

◆ GetDisplay()

std::string vtkRemotingCoreConfiguration::GetDisplay ( )

Returns the display setting, if any, for the current process.

◆ GetMultiServerMode()

virtual bool vtkRemotingCoreConfiguration::GetMultiServerMode ( )
virtual

Returns true on client process if it should enable connecting to multiple servers at the same time.

◆ GetMultiClientMode()

virtual bool vtkRemotingCoreConfiguration::GetMultiClientMode ( )
virtual

Returns true data server process if the server should allow connecting to multiple clients in a collaboration mode.

◆ GetDisableFurtherConnections()

virtual bool vtkRemotingCoreConfiguration::GetDisableFurtherConnections ( )
virtual

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

This requires MultiClientMode.

◆ PopulateOptions()

bool vtkRemotingCoreConfiguration::PopulateOptions ( vtkCLIOptions app,
vtkProcessModule::ProcessTypes  processType 
)

Populates vtkCLIOptions with available command line options.

processType indicates which type of ParaView process the options are being setup for. That may affect available options.

◆ PopulateGlobalOptions()

bool vtkRemotingCoreConfiguration::PopulateGlobalOptions ( vtkCLIOptions app,
vtkProcessModule::ProcessTypes  processType 
)

◆ PopulateConnectionOptions()

bool vtkRemotingCoreConfiguration::PopulateConnectionOptions ( vtkCLIOptions app,
vtkProcessModule::ProcessTypes  processType 
)

◆ PopulatePluginOptions()

bool vtkRemotingCoreConfiguration::PopulatePluginOptions ( vtkCLIOptions app,
vtkProcessModule::ProcessTypes  processType 
)

◆ PopulateRenderingOptions()

bool vtkRemotingCoreConfiguration::PopulateRenderingOptions ( vtkCLIOptions app,
vtkProcessModule::ProcessTypes  processType 
)

◆ PopulateMiscellaneousOptions()

bool vtkRemotingCoreConfiguration::PopulateMiscellaneousOptions ( vtkCLIOptions app,
vtkProcessModule::ProcessTypes  processType 
)

◆ HandleDisplayEnvironment()

void vtkRemotingCoreConfiguration::HandleDisplayEnvironment ( )

Method to setup environment variables for display.


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