extends vtkSession to add API for ParaView sessions. More...

#include <vtkPVSession.h>

Inheritance diagram for vtkPVSession:

[legend]

Collaboration diagram for vtkPVSession:

[legend]

Public Types
enum	ServerFlags { NONE = 0, 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 }

typedef vtkSession	Superclass

Public Types inherited from vtkSession
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

virtual ServerFlags	GetProcessRoles ()
	Returns a ServerFlags indicate the nature of the current processes. More...

bool	HasProcessRole (vtkTypeUInt32 flag)
	Convenience method that returns true if the current session is serving the indicated role on this process. More...

virtual vtkMultiProcessController *	GetController (ServerFlags processType)
	Returns the controller used to communicate with the process. More...

virtual vtkMPIMToNSocketConnection *	GetMPIMToNSocketConnection ()
	This is socket connection, if any to communicate between the data-server and render-server nodes. More...

virtual vtkPVServerInformation *	GetServerInformation ()=0
	vtkPVServerInformation is an information-object that provides information about the server processes. More...

virtual bool	IsMultiClients ()
	Allow anyone to know easily if the current session is involved in collaboration or not. More...

bool	GetPendingProgress ()
	Returns true if the session is within a PrepareProgress() and CleanupPendingProgress() block. More...


virtual vtkPVProgressHandler *	GetProgressHandler ()
	Provides access to the progress handler. More...


void	PrepareProgress ()
	Should be called to begin/end receiving progresses on this session. More...

void	CleanupPendingProgress ()
	Should be called to begin/end receiving progresses on this session. More...

Public Member Functions inherited from vtkSession
void	PrintSelf (ostream &os, vtkIndent indent) override

virtual bool	GetIsAlive ()=0
	Returns true is this session is active/alive/valid. 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 vtkPVSession *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkSession
static int	IsTypeOf (const char *type)

static vtkSession *	SafeDownCast (vtkObject *o)

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 Types
enum	{ EXCEPTION_EVENT_TAG = 31416 }

Protected Member Functions
	vtkPVSession ()

	~vtkPVSession () override

virtual bool	OnWrongTagEvent (vtkObject caller, unsigned long eventid, void calldata)
	Callback when any vtkMultiProcessController subclass fires a WrongTagEvent. More...


virtual void	PrepareProgressInternal ()
	Virtual methods subclasses can override. More...

virtual void	CleanupPendingProgressInternal ()
	Virtual methods subclasses can override. More...

Protected Member Functions inherited from vtkSession
	vtkSession ()

	~vtkSession () override

virtual void	Activate ()
	Subclasses must call this to mark the session active. More...

virtual void	DeActivate ()
	Subclasses must call this to mark the session inactive. 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
vtkPVProgressHandler *	ProgressHandler

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

extends vtkSession to add API for ParaView sessions.

vtkPVSession adds APIs to vtkSession for ParaView-specific sessions, namely those that are used to communicate between data-server,render-server and client. This is an abstract class.

Definition at line 23 of file vtkPVSession.h.

Member Typedef Documentation

◆ Superclass

typedef vtkSession vtkPVSession::Superclass

Definition at line 26 of file vtkPVSession.h.

Member Enumeration Documentation

◆ ServerFlags

enum vtkPVSession::ServerFlags

Enumerator
NONE
DATA_SERVER
DATA_SERVER_ROOT
RENDER_SERVER
RENDER_SERVER_ROOT
SERVERS
CLIENT
CLIENT_AND_SERVERS

Definition at line 29 of file vtkPVSession.h.

◆ anonymous enum

anonymous enum

protected

Enumerator
EXCEPTION_EVENT_TAG

Definition at line 112 of file vtkPVSession.h.

Constructor & Destructor Documentation

◆ vtkPVSession()

vtkPVSession::vtkPVSession ( )

protected

◆ ~vtkPVSession()

vtkPVSession::~vtkPVSession ( )

overrideprotected

Member Function Documentation

◆ GetClassName()

virtual const char* vtkPVSession::GetClassName ( )

virtual

Reimplemented from vtkSession.

Reimplemented in vtkPVSessionBase, vtkSMSession, vtkSMSessionClient, and vtkPVSessionServer.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkSession.

Reimplemented in vtkPVSessionBase, vtkSMSession, vtkSMSessionClient, and vtkPVSessionServer.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

Reimplemented in vtkPVSessionBase, vtkSMSession, vtkSMSessionClient, and vtkPVSessionServer.

◆ GetProcessRoles()

virtual ServerFlags vtkPVSession::GetProcessRoles ( )

virtual

Returns a ServerFlags indicate the nature of the current processes.

e.g. if the current processes acts as a data-server and a render-server, it returns DATA_SERVER | RENDER_SERVER.

Reimplemented in vtkSMSession, vtkSMSessionClient, and vtkPVSessionBase.

◆ HasProcessRole()

bool vtkPVSession::HasProcessRole ( vtkTypeUInt32 flag )

inline

Convenience method that returns true if the current session is serving the indicated role on this process.

Definition at line 52 of file vtkPVSession.h.

◆ GetController()

virtual vtkMultiProcessController* vtkPVSession::GetController ( ServerFlags processType )

virtual

Returns the controller used to communicate with the process.

Value must be DATA_SERVER_ROOT or RENDER_SERVER_ROOT or CLIENT. Default implementation returns nullptr.

Reimplemented in vtkSMSessionClient, and vtkPVSessionServer.

◆ GetMPIMToNSocketConnection()

virtual vtkMPIMToNSocketConnection* vtkPVSession::GetMPIMToNSocketConnection ( )

inlinevirtual

This is socket connection, if any to communicate between the data-server and render-server nodes.

Reimplemented in vtkPVSessionBase.

Definition at line 68 of file vtkPVSession.h.

◆ GetServerInformation()

virtual vtkPVServerInformation* vtkPVSession::GetServerInformation ( )

pure virtual

vtkPVServerInformation is an information-object that provides information about the server processes.

These include server-side capabilities as well as server-side command line arguments e.g. tile-display parameters. Use this method to obtain the server-side information. NOTE: For now, we are not bothering to provide separate information from data-server and render-server (as was the case earlier). We can easily add API for the same if needed.

Implemented in vtkSMSessionClient, and vtkPVSessionBase.

◆ IsMultiClients()

virtual bool vtkPVSession::IsMultiClients ( )

virtual

Allow anyone to know easily if the current session is involved in collaboration or not.

This is mostly true for the Client side.

◆ GetProgressHandler()

virtual vtkPVProgressHandler* vtkPVSession::GetProgressHandler ( )

virtual

Provides access to the progress handler.

◆ PrepareProgress()

void vtkPVSession::PrepareProgress ( )

Should be called to begin/end receiving progresses on this session.

◆ CleanupPendingProgress()

void vtkPVSession::CleanupPendingProgress ( )

Should be called to begin/end receiving progresses on this session.

◆ GetPendingProgress()

bool vtkPVSession::GetPendingProgress ( )

Returns true if the session is within a PrepareProgress() and CleanupPendingProgress() block.

◆ OnWrongTagEvent()

virtual bool vtkPVSession::OnWrongTagEvent	(	vtkObject *	caller,
		unsigned long	eventid,
		void *	calldata
	)

protectedvirtual

Callback when any vtkMultiProcessController subclass fires a WrongTagEvent.

Return true if the event was handle localy.

Reimplemented in vtkSMSessionClient.

◆ PrepareProgressInternal()

virtual void vtkPVSession::PrepareProgressInternal ( )

protectedvirtual

Virtual methods subclasses can override.

Reimplemented in vtkPVSessionBase, and vtkSMSessionClient.

◆ CleanupPendingProgressInternal()

virtual void vtkPVSession::CleanupPendingProgressInternal ( )

protectedvirtual

Virtual methods subclasses can override.

Reimplemented in vtkPVSessionBase, and vtkSMSessionClient.

Member Data Documentation

◆ ProgressHandler

vtkPVProgressHandler* vtkPVSession::ProgressHandler

protected

Definition at line 131 of file vtkPVSession.h.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ ServerFlags

◆ anonymous enum

Constructor & Destructor Documentation

◆ vtkPVSession()

◆ ~vtkPVSession()

Member Function Documentation

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ GetProcessRoles()

◆ HasProcessRole()

◆ GetController()

◆ GetMPIMToNSocketConnection()

◆ GetServerInformation()

◆ IsMultiClients()

◆ GetProgressHandler()

◆ PrepareProgress()

◆ CleanupPendingProgress()

◆ GetPendingProgress()

◆ OnWrongTagEvent()

◆ PrepareProgressInternal()

◆ CleanupPendingProgressInternal()

Member Data Documentation

◆ ProgressHandler