runtime configuration options for vtkRemotingCore module. More...
#include <vtkRemotingCoreConfiguration.h>
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... | |
virtual std::string | GetServerURL () |
On client processes, this returns the server connection url to use to connect to the server process(es) on startup, if any. More... | |
virtual std::string | GetServerResourceName () |
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 int * | GetTileMullions () |
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 int * | GetTileDimensions () |
bool | GetIsInTileDisplay () const |
Returns true if in tile display mode. More... | |
bool | GetIsInCave () const |
Returns true of in CAVE mode. More... | |
vtkDisplayConfiguration * | GetDisplayConfiguration () 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... | |
virtual void | SetHostName (std::string) |
Set/Get the hostname to use. More... | |
virtual std::string | GetHostName () |
Set/Get the hostname to use. More... | |
virtual void | SetClientHostName (std::string) |
Set/Get the hostname for the "client" process. More... | |
virtual std::string | GetClientHostName () |
Set/Get the hostname for the "client" process. More... | |
virtual void | SetServerPort (int) |
Set/Get the server-port number to use. More... | |
virtual int | GetServerPort () |
Set/Get the server-port number to use. More... | |
virtual void | SetBindAddress (std::string) |
Set/Get the address the server socket is bound to. More... | |
virtual std::string | GetBindAddress () |
Set/Get the address the server socket is bound to. More... | |
virtual void | SetReverseConnection (bool) |
Set/Get if the process is acting in reverse connection mode. More... | |
virtual bool | GetReverseConnection () |
Set/Get if the process is acting in reverse connection mode. More... | |
virtual void | SetConnectID (int) |
Set/Get the connection identifier used to validate client-server connections. More... | |
virtual int | GetConnectID () |
Set/Get the connection identifier used to validate client-server connections. More... | |
virtual void | SetTimeout (int) |
Set/Get the expected infrastructure imposed timeout of the server. More... | |
virtual int | GetTimeout () |
Set/Get the expected infrastructure imposed timeout of the server. More... | |
virtual void | SetTimeoutCommand (std::string) |
Set/Get the timeout command, called regularly on server side and giving remaining time available for server access. More... | |
virtual std::string | GetTimeoutCommand () |
Set/Get the timeout command, called regularly on server side and giving remaining time available for server access. More... | |
virtual void | SetTimeoutCommandInterval (int) |
Set/Get the interval in seconds between consecutive calls of TimeoutCommand , on the server. More... | |
virtual int | GetTimeoutCommandInterval () |
Set/Get the interval in seconds between consecutive calls of TimeoutCommand , on the server. 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 int | IsTypeOf (const char *type) |
static vtkRemotingCoreConfiguration * | SafeDownCast (vtkObject *o) |
static vtkRemotingCoreConfiguration * | GetInstance () |
Provides access to the singleton. More... | |
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 | |
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 |
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 30 of file vtkRemotingCoreConfiguration.h.
Definition at line 33 of file vtkRemotingCoreConfiguration.h.
|
protected |
|
overrideprotected |
|
virtual |
Reimplemented from vtkObjectBase.
|
static |
|
overridevirtual |
Reimplemented from vtkObject.
|
static |
Provides access to the singleton.
|
virtual |
Flag set when user expects the executable to simply print out the version number and exit.
|
virtual |
Get whether to load user-specific session/configuration files from previous session or start the application using default configuration.
|
virtual |
Print monitor information and exit.
This is currently only supported on Windows.
|
virtual |
Set/Get the hostname to use.
By default, this is initialized to the hostname determined automatically using system calls (specifically, vtksys::SystemInformation). Default is "localhost".
|
virtual |
Set/Get the hostname to use.
By default, this is initialized to the hostname determined automatically using system calls (specifically, vtksys::SystemInformation). Default is "localhost".
|
virtual |
Set/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".
|
virtual |
Set/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".
|
virtual |
Set/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. Default is 0 but this value will be computed depending on the process type when populating options.
|
virtual |
Set/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. Default is 0 but this value will be computed depending on the process type when populating options.
|
virtual |
Set/Get the address the server socket is bound to.
Default is "0.0.0.0"
|
virtual |
Set/Get the address the server socket is bound to.
Default is "0.0.0.0"
|
virtual |
Set/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. Default is false.
|
virtual |
Set/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. Default is false.
|
virtual |
Set/Get the connection identifier used to validate client-server connections.
Default is 0.
|
virtual |
Set/Get the connection identifier used to validate client-server connections.
Default is 0.
|
virtual |
Set/Get the expected infrastructure imposed timeout of the server.
Timeout <= 0 means no timeout. Default is 0.
|
virtual |
Set/Get the expected infrastructure imposed timeout of the server.
Timeout <= 0 means no timeout. Default is 0.
|
virtual |
Set/Get the timeout command, called regularly on server side and giving remaining time available for server access.
Default is empty string.
|
virtual |
Set/Get the timeout command, called regularly on server side and giving remaining time available for server access.
Default is empty string.
|
virtual |
Set/Get the interval in seconds between consecutive calls of TimeoutCommand
, on the server.
Default is 60.
|
virtual |
Set/Get the interval in seconds between consecutive calls of TimeoutCommand
, on the server.
Default is 60.
|
virtual |
On client processes, this returns the server connection url to use to connect to the server process(es) on startup, if any.
|
virtual |
On client processes, this returns the server connection resource name to use to connect to the server process(es) on startup, if any.
|
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 179 of file vtkRemotingCoreConfiguration.h.
|
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 194 of file vtkRemotingCoreConfiguration.h.
|
inline |
Get a list of names for plugins to load.
Definition at line 199 of file vtkRemotingCoreConfiguration.h.
|
virtual |
Get whether stereo rendering is enabled.
This is only valid on rendering processes.
|
virtual |
Get stereo type requested.
Returned values are VTK_STEREO_*
defined in vtkRenderWindow.h.
const char* vtkRemotingCoreConfiguration::GetStereoTypeAsString | ( | ) | const |
double vtkRemotingCoreConfiguration::GetEyeSeparation | ( | ) | const |
Eye separation to use when using stereo rendering.
|
virtual |
Get the gap in pixel between tiles in a tile display.
/
|
virtual |
void vtkRemotingCoreConfiguration::GetTileDimensions | ( | int | dims[2] | ) |
Get the dimensions of the tile display.
bool vtkRemotingCoreConfiguration::GetIsInTileDisplay | ( | ) | const |
Returns true if in tile display mode.
bool vtkRemotingCoreConfiguration::GetIsInCave | ( | ) | const |
Returns true of in CAVE mode.
|
inline |
When in CAVE mode, returns the display configurations.
Definition at line 248 of file vtkRemotingCoreConfiguration.h.
|
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.
|
virtual |
When set to true, ParaView will create headless only render windows on the current process.
|
virtual |
When set to true, ParaView will create on-screen render windows.
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.
std::string vtkRemotingCoreConfiguration::GetDisplay | ( | ) |
Returns the display setting, if any, for the current process.
|
virtual |
Returns true on client process if it should enable connecting to multiple servers at the same time.
|
virtual |
Returns true data server process if the server should allow connecting to multiple clients in a collaboration mode.
|
virtual |
Returns if this server does not allow connection after the first client.
This requires MultiClientMode.
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.
bool vtkRemotingCoreConfiguration::PopulateGlobalOptions | ( | vtkCLIOptions * | app, |
vtkProcessModule::ProcessTypes | processType | ||
) |
bool vtkRemotingCoreConfiguration::PopulateConnectionOptions | ( | vtkCLIOptions * | app, |
vtkProcessModule::ProcessTypes | processType | ||
) |
bool vtkRemotingCoreConfiguration::PopulatePluginOptions | ( | vtkCLIOptions * | app, |
vtkProcessModule::ProcessTypes | processType | ||
) |
bool vtkRemotingCoreConfiguration::PopulateRenderingOptions | ( | vtkCLIOptions * | app, |
vtkProcessModule::ProcessTypes | processType | ||
) |
bool vtkRemotingCoreConfiguration::PopulateMiscellaneousOptions | ( | vtkCLIOptions * | app, |
vtkProcessModule::ProcessTypes | processType | ||
) |
void vtkRemotingCoreConfiguration::HandleDisplayEnvironment | ( | ) |
Method to setup environment variables for display.