#include <vtkSMSession.h>

Inheritance diagram for vtkSMSession:

Collaboration diagram for vtkSMSession:

Public Types
enum	RenderingMode { RENDERING_NOT_AVAILABLE = 0x00, RENDERING_UNIFIED = 0x01, RENDERING_SPLIT = 0x02 }
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual vtkSMCollaborationManager *	GetCollaborationManager ()
virtual const char *	GetURI ()
virtual int	GetNumberOfProcesses (vtkTypeUInt32 servers)
virtual vtkSMProxyLocator *	GetProxyLocator ()
virtual unsigned int	GetRenderClientMode ()
virtual bool	GetIsAlive ()
virtual ServerFlags	GetProcessRoles ()
virtual void	PreDisconnection ()

virtual vtkSMSessionProxyManager *	GetSessionProxyManager ()

virtual vtkSMStateLocator *	GetStateLocator ()

virtual void	PushState (vtkSMMessage *msg)

virtual bool	GetIsAutoMPI ()
Static Public Member Functions
static vtkSMSession *	New ()
static vtkSMSession *	New (vtkPVSessionBase *otherSession)
static int	IsTypeOf (const char *type)
static vtkSMSession *	SafeDownCast (vtkObject *o)
static vtkIdType	ConnectToSelf ()
static vtkIdType	ConnectToRemote (const char *hostname, int port)

static vtkIdType	ReverseConnectToRemote (int port)
static vtkIdType	ReverseConnectToRemote (int port, bool(*callback)())

static vtkIdType	ConnectToRemote (const char dshost, int dsport, const char rshost, int rsport)

static vtkIdType	ReverseConnectToRemote (int dsport, int rsport)
static vtkIdType	ReverseConnectToRemote (int dsport, int rsport, bool(*callback)())
Protected Member Functions
	vtkSMSession (bool initialize_during_constructor=true, vtkPVSessionCore *preExistingSessionCore=NULL)
	~vtkSMSession ()
virtual void	Initialize ()
void	UpdateStateHistory (vtkSMMessage *msg)
Static Protected Member Functions
static vtkIdType	ConnectToRemote (const char *hostname, int port, bool allowRemoteRendering)
Protected Attributes
vtkSMSessionProxyManager *	SessionProxyManager
vtkSMStateLocator *	StateLocator
vtkSMProxyLocator *	ProxyLocator
bool	IsAutoMPI

Detailed Description

vtkSMSession is the default ParaView session. This class can be used as the session for non-client-server configurations eg. builtin mode or batch.

Definition at line 33 of file vtkSMSession.h.

Member Enumeration Documentation

enum vtkSMSession::RenderingMode

Enumerator:

RENDERING_NOT_AVAILABLE
RENDERING_UNIFIED
RENDERING_SPLIT

Definition at line 77 of file vtkSMSession.h.

Constructor & Destructor Documentation

vtkSMSession::vtkSMSession	(	bool	initialize_during_constructor = `true`,
		vtkPVSessionCore *	preExistingSessionCore = `NULL`
	)		`[protected]`

vtkSMSession::~vtkSMSession ( ) [protected]

Member Function Documentation

static vtkSMSession* vtkSMSession::New ( ) [static]

Reimplemented from vtkObject.

Reimplemented in vtkSMSessionClient.

static vtkSMSession* vtkSMSession::New ( vtkPVSessionBase * otherSession ) [static]

virtual const char* vtkSMSession::GetClassName ( ) [virtual]

Reimplemented from vtkPVSessionBase.

Reimplemented in vtkSMSessionClient.

static int vtkSMSession::IsTypeOf ( const char * type ) [static]

Reimplemented from vtkPVSessionBase.

Reimplemented in vtkSMSessionClient.

virtual int vtkSMSession::IsA ( const char * type ) [virtual]

Reimplemented from vtkPVSessionBase.

Reimplemented in vtkSMSessionClient.

static vtkSMSession* vtkSMSession::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkPVSessionBase.

Reimplemented in vtkSMSessionClient.

void vtkSMSession::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)		`[virtual]`

Reimplemented from vtkPVSessionBase.

Reimplemented in vtkSMSessionClient.

virtual vtkSMCollaborationManager* vtkSMSession::GetCollaborationManager ( ) [inline, virtual]

Return the instance of vtkSMCollaborationManager that will be lazy created at the first call. By default we return NULL

Reimplemented in vtkSMSessionClient.

Definition at line 47 of file vtkSMSession.h.

virtual const char* vtkSMSession::GetURI ( ) [inline, virtual]

Return the URL that define where the session is connected to. URI has enough information to know the type of connection, server hosts and ports.

Reimplemented in vtkSMSessionClient.

Definition at line 56 of file vtkSMSession.h.

virtual vtkSMSessionProxyManager* vtkSMSession::GetSessionProxyManager ( ) [virtual]

Returns the vtkSMSessionProxyManager associated with this session.

virtual int vtkSMSession::GetNumberOfProcesses ( vtkTypeUInt32 servers ) [virtual]

Returns the number of processes on the given server/s. If more than 1 server is identified, than it returns the maximum number of processes e.g. is servers = DATA_SERVER | RENDER_SERVER and there are 3 data-server nodes and 2 render-server nodes, then this method will return 3. Implementation provided simply returns the number of local processes.

Reimplemented in vtkSMSessionClient.

virtual vtkSMProxyLocator* vtkSMSession::GetProxyLocator ( ) [virtual]

virtual unsigned int vtkSMSession::GetRenderClientMode ( ) [virtual]

Convenient method to determine if the rendering is done in a pvrenderer or not. For built-in or pvserver you will get RENDERING_UNIFIED and for a setting with a pvrenderer you will get RENDERING_SPLIT. If the session is something else it should reply RENDERING_NOT_AVAILABLE.

virtual vtkSMStateLocator* vtkSMSession::GetStateLocator ( ) [virtual]

Provide an access to the session state locator that can provide the last state of a given remote object that have been pushed. That locator will be filled by RemoteObject state only if the UndoStackBuilder in vtkSMProxyManager is non-null.

virtual bool vtkSMSession::GetIsAlive ( ) [inline, virtual]

Builtin session is always alive.

Implements vtkSession.

Reimplemented in vtkSMSessionClient.

Definition at line 108 of file vtkSMSession.h.

virtual ServerFlags vtkSMSession::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. The implementation provided by this class returns vtkPVSession::CLIENT_AND_SERVERS suitable for builtin-mode.

Reimplemented from vtkPVSessionBase.

Reimplemented in vtkSMSessionClient.

virtual void vtkSMSession::PushState ( vtkSMMessage * msg ) [virtual]

Push the state message. Overridden to ensure that the information in the undo-redo state manager is updated.

Reimplemented from vtkPVSessionBase.

Reimplemented in vtkSMSessionClient.

virtual void vtkSMSession::PreDisconnection ( ) [inline, virtual]

Reimplemented in vtkSMSessionClient.

Definition at line 130 of file vtkSMSession.h.

static vtkIdType vtkSMSession::ConnectToSelf ( ) [static]

These are static helper methods that help create standard ParaView sessions. They register the session with the process module and return the session id. Returns 0 on failure. This overload is used to create a built-in session.

static vtkIdType vtkSMSession::ConnectToRemote	(	const char *	hostname,
		int	port
	)		`[static]`

These are static helper methods that help create standard ParaView sessions. They register the session with the process module and return the session id. Returns 0 on failure. This overload is used to create a client-server session on client.

static vtkIdType vtkSMSession::ReverseConnectToRemote ( int port ) [inline, static]

Same as ConnectToRemote() except that it waits for a reverse connection. This is a blocking call. One can optionally provide a callback that can be called periodically while this call is blocked. The callback should return true, if the connection should continue waiting, else return false to abort the wait.

Definition at line 154 of file vtkSMSession.h.

static vtkIdType vtkSMSession::ReverseConnectToRemote	(	int	port,
		bool(*)()	callback
	)		`[static]`

Same as ConnectToRemote() except that it waits for a reverse connection. This is a blocking call. One can optionally provide a callback that can be called periodically while this call is blocked. The callback should return true, if the connection should continue waiting, else return false to abort the wait.

static vtkIdType vtkSMSession::ConnectToRemote	(	const char *	dshost,
		int	dsport,
		const char *	rshost,
		int	rsport
	)		`[static]`

These are static helper methods that help create standard ParaView sessions. They register the session with the process module and return the session id. Returns 0 on failure. This overload is used to create a client-dataserver-renderserver session on client.

static vtkIdType vtkSMSession::ReverseConnectToRemote	(	int	dsport,
		int	rsport
	)		`[inline, static]`

Same as ConnectToRemote() except that it waits for a reverse connection. This is a blocking call. One can optionally provide a callback that can be called periodically while this call is blocked. The callback should return true, if the connection should continue waiting, else return false to abort the wait.

Definition at line 174 of file vtkSMSession.h.

static vtkIdType vtkSMSession::ReverseConnectToRemote	(	int	dsport,
		int	rsport,
		bool(*)()	callback
	)		`[static]`

Same as ConnectToRemote() except that it waits for a reverse connection. This is a blocking call. One can optionally provide a callback that can be called periodically while this call is blocked. The callback should return true, if the connection should continue waiting, else return false to abort the wait.

virtual bool vtkSMSession::GetIsAutoMPI ( ) [virtual]

This flag if set indicates that the current session module has automatically started "pvservers" as MPI processes as default pipeline.

static vtkIdType vtkSMSession::ConnectToRemote	(	const char *	hostname,
		int	port,
		bool	allowRemoteRendering
	)		`[static, protected]`

virtual void vtkSMSession::Initialize ( ) [protected, virtual]

Initialize various internal classes after the session has been setup correctly.

Reimplemented in vtkSMSessionClient.

void vtkSMSession::UpdateStateHistory ( vtkSMMessage * msg ) [protected]

This method has been externalized so classes that heritate from vtkSMSession and override PushState could easily keep track of the StateHistory and maintain the UndoRedo mecanisme.