process initialization and management core for ParaView processes. More...

#include <vtkProcessModule.h>

Inheritance diagram for vtkProcessModule:

Collaboration diagram for vtkProcessModule:

[legend]

Public Types
enum	ProcessTypes { PROCESS_CLIENT, PROCESS_SERVER, PROCESS_DATA_SERVER, PROCESS_RENDER_SERVER, PROCESS_BATCH, PROCESS_INVALID = -1 }

enum	ServerFlags { DATA_SERVER = 0x01, DATA_SERVER_ROOT = 0x02, RENDER_SERVER = 0x04, RENDER_SERVER_ROOT = 0x08, SERVERS = DATA_SERVER \| RENDER_SERVER, CLIENT = 0x10, CLIENT_AND_SERVERS = DATA_SERVER \| CLIENT \| RENDER_SERVER }
	These flags are used to specify destination servers for the SendStream function. More...

typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

void	UpdateProcessType (ProcessTypes newType, bool dontKnowWhatImDoing=true)
	This method has been added to support migration from one type to another but this method call if NOT RECOMMENDED. More...

vtkIdType	RegisterSession (vtkSession *)
	Registers a new session. More...

vtkSession *	GetSession (vtkIdType)
	Returns the session associated with a given ID. More...

vtkIdType	GetSessionID (vtkSession *)
	Returns the session id for the session, if any. More...

vtkSessionIterator *	NewSessionIterator ()
	Returns a new session iterator that can be used to iterate over the registered sessions. More...

vtkSession *	GetActiveSession ()
	Whenever any session is processing some message, it typically marks itself active with the process module. More...

vtkSession *	GetSession ()
	This is a convenience method that either returns the active session, if present, otherwise the first session. More...

vtkMultiProcessController *	GetGlobalController ()
	Provides access to the global MPI controller, if any. More...

int	GetNumberOfLocalPartitions ()
	Returns the number of processes in this process group. More...

int	GetPartitionId ()
	Returns the local process id. More...

bool	IsMPIInitialized ()
	Return whether MPI is initialized in this process group. More...

const std::string &	GetProgramPath () const
	The full path to the current executable that is running (or empty if unknown). More...

const std::string &	GetSelfDir () const
	The directory containing the current executable (or empty if unknown). More...


bool	UnRegisterSession (vtkIdType sessionID)
	Unregister a session given its ID. More...

bool	UnRegisterSession (vtkSession *session)
	Unregister a session given its ID. More...


virtual vtkIdType	GetEventCallDataSessionId ()
	RegisterSession and UnRegisterSession fire events with SessionID in calldata. More...


virtual bool	GetMultipleSessionsSupport ()
	Return true, if multiple sessions can be used simultanuously. More...

virtual void	SetMultipleSessionsSupport (bool)
	Return true, if multiple sessions can be used simultanuously. More...

virtual void	MultipleSessionsSupportOn ()
	Return true, if multiple sessions can be used simultanuously. More...

virtual void	MultipleSessionsSupportOff ()
	Return true, if multiple sessions can be used simultanuously. More...


virtual vtkPVOptions *	GetOptions ()
	Set/Get the application command line options object. More...

void	SetOptions (vtkPVOptions *op)
	Set/Get the application command line options object. More...


virtual vtkNetworkAccessManager *	GetNetworkAccessManager ()
	Get/Set the network access manager. More...

void	SetNetworkAccessManager (vtkNetworkAccessManager *)
	Get/Set the network access manager. More...


virtual bool	GetReportInterpreterErrors ()
	Set/Get whether to report errors from the Interpreter. More...

virtual void	SetReportInterpreterErrors (bool)
	Set/Get whether to report errors from the Interpreter. More...

virtual void	ReportInterpreterErrorsOn ()
	Set/Get whether to report errors from the Interpreter. More...

virtual void	ReportInterpreterErrorsOff ()
	Set/Get whether to report errors from the Interpreter. More...


virtual bool	GetSymmetricMPIMode ()
	Returns true if ParaView is to be run in symmetric mode. 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 vtkProcessModule *	New ()

static int	IsTypeOf (const char *type)

static vtkProcessModule *	SafeDownCast (vtkObject *o)

static ProcessTypes	GetProcessType ()

static unsigned int	GetProcessTypeAsInt ()

static bool	Initialize (ProcessTypes type, int &argc, char **&argv)
	Initializes the process and the ProcessModule. More...

static bool	Finalize ()
	Finalizes and cleans up the process. More...

static vtkProcessModule *	GetProcessModule ()
	Provides access to the global ProcessModule. More...

static int	GetNumberOfGhostLevelsToRequest (vtkInformation *outInfo)
	This returns number of ghost level to request based on characteristics of the pipelines. More...


static void	SetDefaultMinimumGhostLevelsToRequestForStructuredPipelines (int)
	This is temporary approach to control the number of ghost-levels to request by default for data pipelines. More...

static int	GetDefaultMinimumGhostLevelsToRequestForStructuredPipelines ()
	This is temporary approach to control the number of ghost-levels to request by default for data pipelines. More...

static void	SetDefaultMinimumGhostLevelsToRequestForUnstructuredPipelines (int)
	This is temporary approach to control the number of ghost-levels to request by default for data pipelines. More...

static int	GetDefaultMinimumGhostLevelsToRequestForUnstructuredPipelines ()
	This is temporary approach to control the number of ghost-levels to request by default for data pipelines. 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
	vtkProcessModule ()

	~vtkProcessModule () override

virtual void	SetSymmetricMPIMode (bool)

void	SetExecutablePath (const std::string &path)
	Sets the executable path of the process so that ParaView can, e.g., set up paths for Python properly. More...


void	PushActiveSession (vtkSession *)
	Push/Pop the active session. More...

void	PopActiveSession (vtkSession *)
	Push/Pop the active session. More...

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 &)

Protected Attributes
vtkNetworkAccessManager *	NetworkAccessManager

vtkPVOptions *	Options

vtkIdType	MaxSessionId
	Used to keep track of maximum session used. More...

vtkProcessModuleInternals *	Internals

bool	ReportInterpreterErrors

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Friends
class	vtkSession
	Marking vtkSession as friend since it needs access to PushActiveSession/PopActiveSession. More...

class	vtkSessionIterator

Detailed Description

process initialization and management core for ParaView processes.

vtkProcessModule is the process initialization and session management core for ParaView processes.

Definition at line 40 of file vtkProcessModule.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkProcessModule::Superclass

Definition at line 44 of file vtkProcessModule.h.

Member Enumeration Documentation

◆ ProcessTypes

enum vtkProcessModule::ProcessTypes

Enumerator
PROCESS_CLIENT
PROCESS_SERVER
PROCESS_DATA_SERVER
PROCESS_RENDER_SERVER
PROCESS_BATCH
PROCESS_INVALID

Definition at line 47 of file vtkProcessModule.h.

◆ ServerFlags

enum vtkProcessModule::ServerFlags

These flags are used to specify destination servers for the SendStream function.

FIXME: These flags should simply move to PVSession. They don't make sense in non-PVSessions since the processes may have different roles in that case.

Enumerator
DATA_SERVER
DATA_SERVER_ROOT
RENDER_SERVER
RENDER_SERVER_ROOT
SERVERS
CLIENT
CLIENT_AND_SERVERS

Definition at line 66 of file vtkProcessModule.h.

Constructor & Destructor Documentation

◆ vtkProcessModule()

vtkProcessModule::vtkProcessModule ( )

protected

◆ ~vtkProcessModule()

vtkProcessModule::~vtkProcessModule ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkProcessModule* vtkProcessModule::New ( )

static

◆ GetClassName()

virtual const char* vtkProcessModule::GetClassName ( )

virtual

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

◆ GetProcessType()

static ProcessTypes vtkProcessModule::GetProcessType ( )

static

◆ GetProcessTypeAsInt()

static unsigned int vtkProcessModule::GetProcessTypeAsInt ( )

inlinestatic

Definition at line 78 of file vtkProcessModule.h.

◆ UpdateProcessType()

void vtkProcessModule::UpdateProcessType	(	ProcessTypes	newType,
		bool	dontKnowWhatImDoing = `true`
	)

This method has been added to support migration from one type to another but this method call if NOT RECOMMENDED.

-> We use it to handle the Animation saving at disconnection time on the server side. We create a new session and migrate the sever process to a batch process.

◆ Initialize()

static bool vtkProcessModule::Initialize	(	ProcessTypes	type,
		int &	argc,
		char **&	argv
	)

static

Initializes the process and the ProcessModule.

The function is to initialize MPI if applicable for the process and setup some environment e.g. DISPLAY. Initializes the ProcessModule. for the process and setup some environment e.g. DISPLAY.

◆ Finalize()

static bool vtkProcessModule::Finalize ( )

static

Finalizes and cleans up the process.

◆ RegisterSession()

vtkIdType vtkProcessModule::RegisterSession ( vtkSession * )

Registers a new session.

A new ID is assigned for the session and that ID is returned. The ID can be used in future to access this session. Fires vtkCommand::ConnectionCreatedEvent every time a session is registered. The event-data for this event is a vtkIdType whose value is the session id.

◆ UnRegisterSession() [1/2]

bool vtkProcessModule::UnRegisterSession ( vtkIdType sessionID )

Unregister a session given its ID.

This is the same ID that is returned when the session was registered. Returns true is the session was unregistered. Unregistering a session implies that the ProcessModule will no longer monitor communication on the sockets, if any, in the session. Fires vtkCommand::ConnectionClosedEvent every time a session is unregistered. The event-data for this event is a vtkIdType whose value is the session id.

◆ UnRegisterSession() [2/2]

bool vtkProcessModule::UnRegisterSession ( vtkSession * session )

Unregister a session given its ID.

This is the same ID that is returned when the session was registered. Returns true is the session was unregistered. Unregistering a session implies that the ProcessModule will no longer monitor communication on the sockets, if any, in the session. Fires vtkCommand::ConnectionClosedEvent every time a session is unregistered. The event-data for this event is a vtkIdType whose value is the session id.

◆ GetEventCallDataSessionId()

virtual vtkIdType vtkProcessModule::GetEventCallDataSessionId ( )

virtual

RegisterSession and UnRegisterSession fire events with SessionID in calldata.

To provide access to that in Python, we have this method. The value is valid only in vtkCommand::ConnectionCreatedEvent and vtkCommand::ConnectionClosedEvent callbacks and is set to 0 at other times.

◆ GetSession() [1/2]

vtkSession* vtkProcessModule::GetSession ( vtkIdType )

Returns the session associated with a given ID.

◆ GetSessionID()

vtkIdType vtkProcessModule::GetSessionID ( vtkSession * )

Returns the session id for the session, if any.

Return 0 is the session has not been registered with the process module.

◆ NewSessionIterator()

vtkSessionIterator* vtkProcessModule::NewSessionIterator ( )

Returns a new session iterator that can be used to iterate over the registered sessions.

◆ GetActiveSession()

vtkSession* vtkProcessModule::GetActiveSession ( )

Whenever any session is processing some message, it typically marks itself active with the process module.

The active session can be accessed using this method.

◆ GetSession() [2/2]

vtkSession* vtkProcessModule::GetSession ( )

This is a convenience method that either returns the active session, if present, otherwise the first session.

Don't use this for new API. This is provided for some old api.

◆ GetMultipleSessionsSupport()

virtual bool vtkProcessModule::GetMultipleSessionsSupport ( )

virtual

Return true, if multiple sessions can be used simultanuously.

We set the default to be FALSE.

◆ SetMultipleSessionsSupport()

virtual void vtkProcessModule::SetMultipleSessionsSupport ( bool )

virtual

Return true, if multiple sessions can be used simultanuously.

We set the default to be FALSE.

◆ MultipleSessionsSupportOn()

virtual void vtkProcessModule::MultipleSessionsSupportOn ( )

virtual

Return true, if multiple sessions can be used simultanuously.

We set the default to be FALSE.

◆ MultipleSessionsSupportOff()

virtual void vtkProcessModule::MultipleSessionsSupportOff ( )

virtual

Return true, if multiple sessions can be used simultanuously.

We set the default to be FALSE.

◆ GetProcessModule()

static vtkProcessModule* vtkProcessModule::GetProcessModule ( )

static

Provides access to the global ProcessModule.

This method can only be called after Initialize().

◆ GetOptions()

virtual vtkPVOptions* vtkProcessModule::GetOptions ( )

virtual

Set/Get the application command line options object.

Note that this has to be explicitly set. vtkProcessModule::Initialize() does not initialize the vtkPVOptions.

◆ SetOptions()

void vtkProcessModule::SetOptions ( vtkPVOptions * op )

Set/Get the application command line options object.

Note that this has to be explicitly set. vtkProcessModule::Initialize() does not initialize the vtkPVOptions.

◆ GetNetworkAccessManager()

virtual vtkNetworkAccessManager* vtkProcessModule::GetNetworkAccessManager ( )

virtual

Get/Set the network access manager.

vtkNetworkAccessManager encapsulates the setup of interprocess communication channels. By default a vtkTCPNetworkAccessManager is setup. If you want to change the network access manager, it should be done only when no sessions are present. Ideally, you want to do that during the initialization of the process itself.

◆ SetNetworkAccessManager()

void vtkProcessModule::SetNetworkAccessManager ( vtkNetworkAccessManager * )

Get/Set the network access manager.

vtkNetworkAccessManager encapsulates the setup of interprocess communication channels. By default a vtkTCPNetworkAccessManager is setup. If you want to change the network access manager, it should be done only when no sessions are present. Ideally, you want to do that during the initialization of the process itself.

◆ GetGlobalController()

vtkMultiProcessController* vtkProcessModule::GetGlobalController ( )

Provides access to the global MPI controller, if any.

Same can be obtained using vtkMultiProcessController::GetGlobalController();

◆ GetNumberOfLocalPartitions()

int vtkProcessModule::GetNumberOfLocalPartitions ( )

Returns the number of processes in this process group.

◆ GetPartitionId()

int vtkProcessModule::GetPartitionId ( )

Returns the local process id.

◆ IsMPIInitialized()

bool vtkProcessModule::IsMPIInitialized ( )

Return whether MPI is initialized in this process group.

◆ GetReportInterpreterErrors()

virtual bool vtkProcessModule::GetReportInterpreterErrors ( )

virtual

Set/Get whether to report errors from the Interpreter.

◆ SetReportInterpreterErrors()

virtual void vtkProcessModule::SetReportInterpreterErrors ( bool )

virtual

Set/Get whether to report errors from the Interpreter.

◆ ReportInterpreterErrorsOn()

virtual void vtkProcessModule::ReportInterpreterErrorsOn ( )

virtual

Set/Get whether to report errors from the Interpreter.

◆ ReportInterpreterErrorsOff()

virtual void vtkProcessModule::ReportInterpreterErrorsOff ( )

virtual

Set/Get whether to report errors from the Interpreter.

◆ GetSymmetricMPIMode()

virtual bool vtkProcessModule::GetSymmetricMPIMode ( )

virtual

Returns true if ParaView is to be run in symmetric mode.

Symmetric mode implies that satellites process same code as the root node. This is applicable only for PROCESS_BATCH.

◆ GetProgramPath()

const std::string& vtkProcessModule::GetProgramPath ( ) const

inline

The full path to the current executable that is running (or empty if unknown).

Definition at line 261 of file vtkProcessModule.h.

◆ GetSelfDir()

const std::string& vtkProcessModule::GetSelfDir ( ) const

inline

The directory containing the current executable (or empty if unknown).

Definition at line 265 of file vtkProcessModule.h.

◆ SetDefaultMinimumGhostLevelsToRequestForStructuredPipelines()

static void vtkProcessModule::SetDefaultMinimumGhostLevelsToRequestForStructuredPipelines ( int )

static

This is temporary approach to control the number of ghost-levels to request by default for data pipelines.

Currently, change in ghost level request causes the pipeline to re-execute which can be expensive. In an ideal world, additional ghost levels can be automatically provided by data-exchange between ranks. Until we do that, this is only mechanism available to override the number of ghost levels requested by default.

The default is 0 for structured pipelines, and 1 for unstructured pipelines. When not running in parallel, however, these ghost-level requests don't make sense and hence are generally ignored.

Note, this is expected to change in the future, so use this with caution.

◆ GetDefaultMinimumGhostLevelsToRequestForStructuredPipelines()

static int vtkProcessModule::GetDefaultMinimumGhostLevelsToRequestForStructuredPipelines ( )

static

This is temporary approach to control the number of ghost-levels to request by default for data pipelines.

Currently, change in ghost level request causes the pipeline to re-execute which can be expensive. In an ideal world, additional ghost levels can be automatically provided by data-exchange between ranks. Until we do that, this is only mechanism available to override the number of ghost levels requested by default.

The default is 0 for structured pipelines, and 1 for unstructured pipelines. When not running in parallel, however, these ghost-level requests don't make sense and hence are generally ignored.

Note, this is expected to change in the future, so use this with caution.

◆ SetDefaultMinimumGhostLevelsToRequestForUnstructuredPipelines()

static void vtkProcessModule::SetDefaultMinimumGhostLevelsToRequestForUnstructuredPipelines ( int )

static

This is temporary approach to control the number of ghost-levels to request by default for data pipelines.

Currently, change in ghost level request causes the pipeline to re-execute which can be expensive. In an ideal world, additional ghost levels can be automatically provided by data-exchange between ranks. Until we do that, this is only mechanism available to override the number of ghost levels requested by default.

The default is 0 for structured pipelines, and 1 for unstructured pipelines. When not running in parallel, however, these ghost-level requests don't make sense and hence are generally ignored.

Note, this is expected to change in the future, so use this with caution.

◆ GetDefaultMinimumGhostLevelsToRequestForUnstructuredPipelines()

static int vtkProcessModule::GetDefaultMinimumGhostLevelsToRequestForUnstructuredPipelines ( )

static

This is temporary approach to control the number of ghost-levels to request by default for data pipelines.

Currently, change in ghost level request causes the pipeline to re-execute which can be expensive. In an ideal world, additional ghost levels can be automatically provided by data-exchange between ranks. Until we do that, this is only mechanism available to override the number of ghost levels requested by default.

The default is 0 for structured pipelines, and 1 for unstructured pipelines. When not running in parallel, however, these ghost-level requests don't make sense and hence are generally ignored.

Note, this is expected to change in the future, so use this with caution.

◆ GetNumberOfGhostLevelsToRequest()

static int vtkProcessModule::GetNumberOfGhostLevelsToRequest ( vtkInformation * outInfo )

static

This returns number of ghost level to request based on characteristics of the pipelines.

◆ SetSymmetricMPIMode()

virtual void vtkProcessModule::SetSymmetricMPIMode ( bool )

protectedvirtual

◆ PushActiveSession()

void vtkProcessModule::PushActiveSession ( vtkSession * )

protected

Push/Pop the active session.

◆ PopActiveSession()

void vtkProcessModule::PopActiveSession ( vtkSession * )

protected

Push/Pop the active session.

◆ SetExecutablePath()

void vtkProcessModule::SetExecutablePath ( const std::string & path )

protected

Sets the executable path of the process so that ParaView can, e.g., set up paths for Python properly.

Friends And Related Function Documentation

◆ vtkSession

friend class vtkSession

friend

Marking vtkSession as friend since it needs access to PushActiveSession/PopActiveSession.

Definition at line 313 of file vtkProcessModule.h.

◆ vtkSessionIterator

friend class vtkSessionIterator

friend

Definition at line 335 of file vtkProcessModule.h.

Member Data Documentation

◆ NetworkAccessManager

vtkNetworkAccessManager* vtkProcessModule::NetworkAccessManager

protected

Definition at line 315 of file vtkProcessModule.h.

◆ Options

vtkPVOptions* vtkProcessModule::Options

protected

Definition at line 316 of file vtkProcessModule.h.

◆ MaxSessionId

vtkIdType vtkProcessModule::MaxSessionId

protected

Used to keep track of maximum session used.

Only used to ensure that no session id is ever repeated.

Definition at line 322 of file vtkProcessModule.h.

◆ Internals

vtkProcessModuleInternals* vtkProcessModule::Internals

protected

Definition at line 331 of file vtkProcessModule.h.

◆ ReportInterpreterErrors

bool vtkProcessModule::ReportInterpreterErrors

protected

Definition at line 337 of file vtkProcessModule.h.

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

/builds/gitlab-kitware-sciviz-ci/Remoting/Core/vtkProcessModule.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ ProcessTypes

◆ ServerFlags

Constructor & Destructor Documentation

◆ vtkProcessModule()

◆ ~vtkProcessModule()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ GetProcessType()

◆ GetProcessTypeAsInt()

◆ UpdateProcessType()

◆ Initialize()

◆ Finalize()

◆ RegisterSession()

◆ UnRegisterSession() [1/2]

◆ UnRegisterSession() [2/2]

◆ GetEventCallDataSessionId()

◆ GetSession() [1/2]

◆ GetSessionID()

◆ NewSessionIterator()

◆ GetActiveSession()

◆ GetSession() [2/2]

◆ GetMultipleSessionsSupport()

◆ SetMultipleSessionsSupport()

◆ MultipleSessionsSupportOn()

◆ MultipleSessionsSupportOff()

◆ GetProcessModule()

◆ GetOptions()

◆ SetOptions()

◆ GetNetworkAccessManager()

◆ SetNetworkAccessManager()

◆ GetGlobalController()

◆ GetNumberOfLocalPartitions()

◆ GetPartitionId()

◆ IsMPIInitialized()

◆ GetReportInterpreterErrors()

◆ SetReportInterpreterErrors()

◆ ReportInterpreterErrorsOn()

◆ ReportInterpreterErrorsOff()

◆ GetSymmetricMPIMode()

◆ GetProgramPath()

◆ GetSelfDir()

◆ SetDefaultMinimumGhostLevelsToRequestForStructuredPipelines()

◆ GetDefaultMinimumGhostLevelsToRequestForStructuredPipelines()

◆ SetDefaultMinimumGhostLevelsToRequestForUnstructuredPipelines()

◆ GetDefaultMinimumGhostLevelsToRequestForUnstructuredPipelines()

◆ GetNumberOfGhostLevelsToRequest()

◆ SetSymmetricMPIMode()

◆ PushActiveSession()

◆ PopActiveSession()

◆ SetExecutablePath()

Friends And Related Function Documentation

◆ vtkSession

◆ vtkSessionIterator

Member Data Documentation

◆ NetworkAccessManager

◆ Options

◆ MaxSessionId

◆ Internals

◆ ReportInterpreterErrors