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 } |
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| virtual ServerFlags | GetProcessRoles () |
| virtual vtkMultiProcessController * | GetController (ServerFlags processType) |
| virtual vtkPVServerInformation * | GetServerInformation ()=0 |
| virtual bool | IsMultiClients () |
| bool | GetPendingProgress () |
| virtual vtkMPIMToNSocketConnection * | GetMPIMToNSocketConnection () |
| virtual vtkPVProgressHandler * | GetProgressHandler () |
| void | PrepareProgress () |
| void | CleanupPendingProgress () |
Static Public Member Functions | |
| static int | IsTypeOf (const char *type) |
| static vtkPVSession * | 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) |
| virtual void | PrepareProgressInternal () |
| virtual void | CleanupPendingProgressInternal () |
Protected Attributes | |
| vtkPVProgressHandler * | ProgressHandler |
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 33 of file vtkPVSession.h.
Member Enumeration Documentation
- Enumerator:
NONE DATA_SERVER DATA_SERVER_ROOT RENDER_SERVER RENDER_SERVER_ROOT SERVERS CLIENT CLIENT_AND_SERVERS
Definition at line 39 of file vtkPVSession.h.
anonymous enum [protected] |
Definition at line 101 of file vtkPVSession.h.
Constructor & Destructor Documentation
| vtkPVSession::vtkPVSession | ( | ) | [protected] |
| vtkPVSession::~vtkPVSession | ( | ) | [protected] |
Member Function Documentation
| virtual const char* vtkPVSession::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkSession.
Reimplemented in vtkPVSessionBase, vtkSMSession, vtkSMSessionClient, and vtkPVSessionServer.
| static int vtkPVSession::IsTypeOf | ( | const char * | type | ) | [static] |
Reimplemented from vtkSession.
Reimplemented in vtkPVSessionBase, vtkSMSession, vtkSMSessionClient, and vtkPVSessionServer.
| virtual int vtkPVSession::IsA | ( | const char * | type | ) | [virtual] |
Reimplemented from vtkSession.
Reimplemented in vtkPVSessionBase, vtkSMSession, vtkSMSessionClient, and vtkPVSessionServer.
| static vtkPVSession* vtkPVSession::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkSession.
Reimplemented in vtkPVSessionBase, vtkSMSession, vtkSMSessionClient, and vtkPVSessionServer.
| void vtkPVSession::PrintSelf | ( | ostream & | os, |
| vtkIndent | indent | ||
| ) | [virtual] |
Reimplemented from vtkSession.
Reimplemented in vtkPVSessionBase, vtkSMSession, vtkSMSessionClient, and vtkPVSessionServer.
| 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.
| 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 NULL.
Reimplemented in vtkSMSessionClient, and vtkPVSessionServer.
| virtual vtkMPIMToNSocketConnection* vtkPVSession::GetMPIMToNSocketConnection | ( | ) | [inline, virtual] |
This is socket connection, if any to communicate between the data-server and render-server nodes.
Reimplemented in vtkPVSessionBase.
Definition at line 64 of file vtkPVSession.h.
| 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 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 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.
| virtual vtkPVProgressHandler* vtkPVSession::GetProgressHandler | ( | ) | [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.
| virtual bool vtkPVSession::OnWrongTagEvent | ( | vtkObject * | caller, |
| unsigned long | eventid, | ||
| void * | calldata | ||
| ) | [protected, virtual] |
Callback when any vtkMultiProcessController subclass fires a WrongTagEvent. Return true if the event was handle localy.
Reimplemented in vtkSMSessionClient.
| virtual void vtkPVSession::PrepareProgressInternal | ( | ) | [protected, virtual] |
Virtual methods subclasses can override.
Reimplemented in vtkPVSessionBase.
| virtual void vtkPVSession::CleanupPendingProgressInternal | ( | ) | [protected, virtual] |
Virtual methods subclasses can override.
Reimplemented in vtkPVSessionBase.
Member Data Documentation
vtkPVProgressHandler* vtkPVSession::ProgressHandler [protected] |
Definition at line 119 of file vtkPVSession.h.
The documentation for this class was generated from the following file:
- dox/ParaViewCore/ClientServerCore/vtkPVSession.h
