ParaView
|
extends vtkSession to add API for ParaView sessions. More...
#include <vtkPVSession.h>
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 |
![]() | |
typedef vtkObject | Superclass |
Public Member Functions | |
virtual const char * | GetClassName () |
virtual int | IsA (const char *type) |
void | PrintSelf (ostream &os, vtkIndent indent) |
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... | |
![]() | |
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 vtkPVSession * | SafeDownCast (vtkObject *o) |
![]() | |
static int | IsTypeOf (const char *type) |
static vtkSession * | SafeDownCast (vtkObject *o) |
Protected Types | |
enum | { EXCEPTION_EVENT_TAG = 31416 } |
Protected Member Functions | |
vtkPVSession () | |
~vtkPVSession () | |
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... | |
![]() | |
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... | |
Protected Attributes | |
vtkPVProgressHandler * | ProgressHandler |
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 35 of file vtkPVSession.h.
typedef vtkSession vtkPVSession::Superclass |
Definition at line 38 of file vtkPVSession.h.
Enumerator | |
---|---|
NONE | |
DATA_SERVER | |
DATA_SERVER_ROOT | |
RENDER_SERVER | |
RENDER_SERVER_ROOT | |
SERVERS | |
CLIENT | |
CLIENT_AND_SERVERS |
Definition at line 41 of file vtkPVSession.h.
|
protected |
Enumerator | |
---|---|
EXCEPTION_EVENT_TAG |
Definition at line 124 of file vtkPVSession.h.
|
protected |
|
protected |
|
virtual |
Reimplemented from vtkSession.
Reimplemented in vtkPVSessionBase, vtkSMSession, vtkSMSessionClient, and vtkPVSessionServer.
|
static |
|
virtual |
Reimplemented from vtkSession.
Reimplemented in vtkPVSessionBase, vtkSMSession, vtkSMSessionClient, and vtkPVSessionServer.
|
static |
void vtkPVSession::PrintSelf | ( | ostream & | os, |
vtkIndent | indent | ||
) |
|
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.
|
inline |
Convenience method that returns true if the current session is serving the indicated role on this process.
Definition at line 64 of file vtkPVSession.h.
|
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 NULL.
Reimplemented in vtkSMSessionClient, and vtkPVSessionServer.
|
inlinevirtual |
This is socket connection, if any to communicate between the data-server and render-server nodes.
Reimplemented in vtkPVSessionBase.
Definition at line 80 of file vtkPVSession.h.
|
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 informations 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.
|
virtual |
Allow anyone to know easily if the current session is involved in collaboration or not.
This is mostly true for the Client side.
|
virtual |
Provides access to the progress handler.
void vtkPVSession::PrepareProgress | ( | ) |
Should be called to begin/end receiving progresses on this session.
void vtkPVSession::CleanupPendingProgress | ( | ) |
Should be called to begin/end receiving progresses on this session.
bool vtkPVSession::GetPendingProgress | ( | ) |
Returns true if the session is within a PrepareProgress() and CleanupPendingProgress() block.
|
protectedvirtual |
Callback when any vtkMultiProcessController subclass fires a WrongTagEvent.
Return true if the event was handle localy.
Reimplemented in vtkSMSessionClient.
|
protectedvirtual |
Virtual methods subclasses can override.
Reimplemented in vtkPVSessionBase.
|
protectedvirtual |
Virtual methods subclasses can override.
Reimplemented in vtkPVSessionBase.
|
protected |
Definition at line 143 of file vtkPVSession.h.