ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | List of all members
vtkSession Class Referenceabstract

vtkSession defines a session i.e. More...

#include <vtkSession.h>

Inheritance diagram for vtkSession:
Inheritance graph
[legend]

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual bool GetIsAlive ()=0
 Returns true is this session is active/alive/valid. More...
 

Static Public Member Functions

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

Protected Member Functions

 vtkSession ()
 
 ~vtkSession ()
 
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...
 

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 29 of file vtkSession.h.

Member Typedef Documentation

§ Superclass

typedef vtkObject vtkSession::Superclass

Definition at line 32 of file vtkSession.h.

Constructor & Destructor Documentation

§ vtkSession()

vtkSession::vtkSession ( )
protected

§ ~vtkSession()

vtkSession::~vtkSession ( )
protected

Member Function Documentation

§ GetClassName()

virtual const char* vtkSession::GetClassName ( )
virtual

§ IsTypeOf()

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

§ IsA()

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

§ SafeDownCast()

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

§ PrintSelf()

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

§ GetIsAlive()

virtual bool vtkSession::GetIsAlive ( )
pure virtual

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

Implemented in vtkSMSession, vtkPVSessionServer, and vtkSMSessionClient.

§ Activate()

virtual void vtkSession::Activate ( )
protectedvirtual

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.

§ DeActivate()

virtual void vtkSession::DeActivate ( )
protectedvirtual

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

§ vtkSMRenderViewProxy

friend class vtkSMRenderViewProxy
friend

Definition at line 45 of file vtkSession.h.

§ vtkPVServerSideAnimationPlayer

friend class vtkPVServerSideAnimationPlayer
friend

Definition at line 47 of file vtkSession.h.


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