ParaView
Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends
vtkSession Class Reference

#include <vtkSession.h>

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

List of all members.

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual bool GetIsAlive ()=0

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkSessionSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkSession ()
 ~vtkSession ()
virtual void Activate ()
virtual void DeActivate ()

Friends

class vtkSMRenderViewProxy
class vtkPVServerSideAnimationPlayer

Detailed Description

vtkSession defines a session i.e. a conversation, if you will. It can be between different processes or same process. What types of conversations are possible i.e what protocols are supported, is defined by the subclasses.

Definition at line 27 of file vtkSession.h.


Constructor & Destructor Documentation

vtkSession::vtkSession ( ) [protected]
vtkSession::~vtkSession ( ) [protected]

Member Function Documentation

virtual const char* vtkSession::GetClassName ( ) [virtual]
static int vtkSession::IsTypeOf ( const char *  type) [static]
virtual int vtkSession::IsA ( const char *  type) [virtual]
static vtkSession* vtkSession::SafeDownCast ( vtkObject o) [static]
void vtkSession::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]
virtual bool vtkSession::GetIsAlive ( ) [pure virtual]

Returns true is this session is active/alive/valid.

Implemented in vtkSMSession, vtkPVSessionServer, and vtkSMSessionClient.

virtual void vtkSession::Activate ( ) [protected, virtual]

Subclasses must call this to mark the session active. This sets the active session pointer held by the vtkProcessModule, making it easier for filters etc. that need information about the active session to access it.

virtual void vtkSession::DeActivate ( ) [protected, virtual]

Subclasses must call this to mark the session inactive. This sets the active session pointer held by the vtkProcessModule, making it easier for filters etc. that need information about the active session to access it.


Friends And Related Function Documentation

friend class vtkSMRenderViewProxy [friend]

Definition at line 42 of file vtkSession.h.

friend class vtkPVServerSideAnimationPlayer [friend]

Definition at line 44 of file vtkSession.h.


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