Abstract class used to provide the main implementation of the ParaView session methods for the following classes: vtkSMSession, vtkSMSessionClient, vtkSMSessionServer. More...
#include <vtkPVSessionBase.h>


Public Types | |
| enum | EventIds { RegisterRemoteObjectEvent = 1234, UnRegisterRemoteObjectEvent = 4321, ProcessingRemoteEnd = 2143, ConnectionLost = 6789 } |
| typedef vtkPVSession | Superclass |
Public Types inherited from vtkPVSession | |
| 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 |
Public Types inherited from vtkSession | |
| typedef vtkObject | Superclass |
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| void | PrintSelf (ostream &os, vtkIndent indent) override |
| ServerFlags | GetProcessRoles () override |
| Returns a ServerFlags indicate the nature of the current processes. More... | |
| vtkPVServerInformation * | GetServerInformation () override |
| vtkPVServerInformation is an information-object that provides information about the server processes. More... | |
| vtkMPIMToNSocketConnection * | GetMPIMToNSocketConnection () override |
| This is socket connection, if any to communicate between the data-server and render-server nodes. More... | |
| virtual void | PushState (vtkSMMessage *msg) |
| Push the state message. More... | |
| virtual void | PullState (vtkSMMessage *msg) |
| Pull the state message. More... | |
| virtual void | ExecuteStream (vtkTypeUInt32 location, const vtkClientServerStream &stream, bool ignore_errors=false) |
| Execute a command on the given processes. More... | |
| virtual const vtkClientServerStream & | GetLastResult (vtkTypeUInt32 location) |
| Returns the response of the ExecuteStream() call from the location. More... | |
| virtual bool | GatherInformation (vtkTypeUInt32 location, vtkPVInformation *information, vtkTypeUInt32 globalid) |
Gather information about an object referred by the globalid. More... | |
| virtual void | NotifyAllClients (const vtkSMMessage *)=0 |
| Sends the message to all clients. More... | |
| virtual void | NotifyOtherClients (const vtkSMMessage *)=0 |
| Sends the message to all but the active client-session. More... | |
| vtkSIProxyDefinitionManager * | GetProxyDefinitionManager () |
| Get the ProxyDefinitionManager. More... | |
| vtkSIObject * | GetSIObject (vtkTypeUInt32 globalid) |
| Returns a vtkSIObject or subclass given its global id, if any. More... | |
| virtual void | UnRegisterSIObject (vtkSMMessage *msg) |
| Unregister server side object. More... | |
| virtual void | RegisterSIObject (vtkSMMessage *msg) |
| Register server side object. More... | |
| vtkObject * | GetRemoteObject (vtkTypeUInt32 globalid) |
| Return a vtkSMRemoteObject given its global id if any otherwise return nullptr;. More... | |
| virtual void | GetAllRemoteObjects (vtkCollection *collection) |
| Allow the user to fill its vtkCollection with all RemoteObject This could be useful when you want to hold a reference to them to prevent any deletion across several method call. More... | |
| virtual vtkTypeUInt32 | GetNextGlobalUniqueIdentifier () |
| Provides the next available identifier. More... | |
| virtual vtkTypeUInt32 | GetNextChunkGlobalUniqueIdentifier (vtkTypeUInt32 chunkSize) |
| Return the first Id of the requested chunk. More... | |
| virtual bool | IsProcessingRemoteNotification () |
| This property is used to discard ignore_synchronization proxy property when we load protobuf states. More... | |
| virtual void | UseSessionCoreOf (vtkPVSessionBase *other) |
| Update internal session core in order to use the one used in another session. More... | |
| virtual vtkPVSessionCore * | GetSessionCore () |
| Provides access to the session core. More... | |
Public Member Functions inherited from vtkPVSession | |
| 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 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... | |
Public Member Functions inherited from vtkSession | |
| virtual bool | GetIsAlive ()=0 |
| Returns true is this session is active/alive/valid. More... | |
Public Member Functions inherited from vtkObject | |
| vtkBaseTypeMacro (vtkObject, vtkObjectBase) | |
| virtual void | DebugOn () |
| virtual void | DebugOff () |
| bool | GetDebug () |
| void | SetDebug (bool debugFlag) |
| virtual void | Modified () |
| virtual vtkMTimeType | GetMTime () |
| void | RemoveObserver (unsigned long tag) |
| void | RemoveObservers (unsigned long event) |
| void | RemoveObservers (const char *event) |
| void | RemoveAllObservers () |
| int | HasObserver (unsigned long event) |
| int | HasObserver (const char *event) |
| int | InvokeEvent (unsigned long event) |
| int | InvokeEvent (const char *event) |
| unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
| unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
| vtkCommand * | GetCommand (unsigned long tag) |
| void | RemoveObserver (vtkCommand *) |
| void | RemoveObservers (unsigned long event, vtkCommand *) |
| void | RemoveObservers (const char *event, vtkCommand *) |
| int | HasObserver (unsigned long event, vtkCommand *) |
| int | HasObserver (const char *event, vtkCommand *) |
| unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f) |
| unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
| unsigned long | AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
| int | InvokeEvent (unsigned long event, void *callData) |
| int | InvokeEvent (const char *event, void *callData) |
| unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
| unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
| vtkCommand * | GetCommand (unsigned long tag) |
| void | RemoveObserver (vtkCommand *) |
| void | RemoveObservers (unsigned long event, vtkCommand *) |
| void | RemoveObservers (const char *event, vtkCommand *) |
| int | HasObserver (unsigned long event, vtkCommand *) |
| int | HasObserver (const char *event, vtkCommand *) |
| unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f) |
| unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
| unsigned long | AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
| int | InvokeEvent (unsigned long event, void *callData) |
| int | InvokeEvent (const char *event, void *callData) |
Public Member Functions inherited from vtkObjectBase | |
| const char * | GetClassName () const |
| virtual void | Delete () |
| virtual void | FastDelete () |
| void | Print (ostream &os) |
| virtual void | Register (vtkObjectBase *o) |
| virtual void | UnRegister (vtkObjectBase *o) |
| void | SetReferenceCount (int) |
| virtual void | PrintHeader (ostream &os, vtkIndent indent) |
| virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
| int | GetReferenceCount () |
| void | PrintRevisions (ostream &) |
| virtual void | PrintHeader (ostream &os, vtkIndent indent) |
| virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
| int | GetReferenceCount () |
| void | PrintRevisions (ostream &) |
Static Public Member Functions | |
| static int | IsTypeOf (const char *type) |
| static vtkPVSessionBase * | SafeDownCast (vtkObject *o) |
Static Public Member Functions inherited from vtkPVSession | |
| static int | IsTypeOf (const char *type) |
| static vtkPVSession * | SafeDownCast (vtkObject *o) |
Static Public Member Functions inherited from vtkSession | |
| static int | IsTypeOf (const char *type) |
| static vtkSession * | SafeDownCast (vtkObject *o) |
Static Public Member Functions inherited from vtkObject | |
| static vtkObject * | New () |
| static void | BreakOnError () |
| static void | SetGlobalWarningDisplay (int val) |
| static void | GlobalWarningDisplayOn () |
| static void | GlobalWarningDisplayOff () |
| static int | GetGlobalWarningDisplay () |
| static void | SetGlobalWarningDisplay (int val) |
| static void | GlobalWarningDisplayOn () |
| static void | GlobalWarningDisplayOff () |
| static int | GetGlobalWarningDisplay () |
Static Public Member Functions inherited from vtkObjectBase | |
| static vtkTypeBool | IsTypeOf (const char *name) |
| static vtkObjectBase * | New () |
| static vtkObjectBase * | New () |
Protected Member Functions | |
| vtkPVSessionBase () | |
| vtkPVSessionBase (vtkPVSessionCore *coreToUse) | |
| ~vtkPVSessionBase () override | |
| void | RegisterRemoteObject (vtkTypeUInt32 globalid, vtkTypeUInt32 location, vtkObject *obj) |
| Register a remote object. More... | |
| void | UnRegisterRemoteObject (vtkTypeUInt32 globalid, vtkTypeUInt32 location) |
| Unregister a remote object. More... | |
| vtkPVSessionCore * | GetSessionCore () const |
| Method used to migrate from one Session type to another by keeping the same vtkPVSessionCore. More... | |
| void | SetSessionCore (vtkPVSessionCore *) |
| Method used to migrate from one Session type to another by keeping the same vtkPVSessionCore. More... | |
| void | PrepareProgressInternal () override |
| Should be called to begin/end receiving progresses on this session. More... | |
| void | CleanupPendingProgressInternal () override |
| Should be called to begin/end receiving progresses on this session. More... | |
Protected Member Functions inherited from vtkPVSession | |
| vtkPVSession () | |
| ~vtkPVSession () override | |
| virtual bool | OnWrongTagEvent (vtkObject *caller, unsigned long eventid, void *calldata) |
| Callback when any vtkMultiProcessController subclass fires a WrongTagEvent. More... | |
Protected Member Functions inherited from vtkSession | |
| vtkSession () | |
| ~vtkSession () override | |
| 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 Member Functions inherited from vtkObject | |
| vtkObject () | |
| virtual | ~vtkObject () |
| void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE |
| void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE |
| void | InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL) |
| void | InternalReleaseFocus () |
| void | InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL) |
| void | InternalReleaseFocus () |
Protected Member Functions inherited from vtkObjectBase | |
| vtkObjectBase () | |
| virtual | ~vtkObjectBase () |
| virtual void | CollectRevisions (ostream &) |
| virtual void | ReportReferences (vtkGarbageCollector *) |
| vtkObjectBase (const vtkObjectBase &) | |
| void | operator= (const vtkObjectBase &) |
Protected Attributes | |
| vtkPVSessionCore * | SessionCore |
Protected Attributes inherited from vtkPVSession | |
| vtkPVProgressHandler * | ProgressHandler |
Protected Attributes inherited from vtkObject | |
| bool | Debug |
| vtkTimeStamp | MTime |
| vtkSubjectHelper * | SubjectHelper |
Protected Attributes inherited from vtkObjectBase | |
| vtkAtomicInt32 | ReferenceCount |
| vtkWeakPointerBase ** | WeakPointers |
Friends | |
| class | vtkSMRemoteObject |
| class | vtkSMSessionProxyManager |
| class | vtkSMLiveInsituLinkProxy |
| bool | ProcessingRemoteNotification |
| Methods used to monitor if we are currently processing a server notification Only vtkSMSessionClient use the flag to disable ignore_synchronization properties from being updated. More... | |
| virtual bool | StartProcessingRemoteNotification () |
| Methods used to monitor if we are currently processing a server notification Only vtkSMSessionClient use the flag to disable ignore_synchronization properties from being updated. More... | |
| virtual void | StopProcessingRemoteNotification (bool previousValue) |
| Methods used to monitor if we are currently processing a server notification Only vtkSMSessionClient use the flag to disable ignore_synchronization properties from being updated. More... | |
Additional Inherited Members | |
Protected Types inherited from vtkPVSession | |
| enum | { EXCEPTION_EVENT_TAG = 31416 } |
Abstract class used to provide the main implementation of the ParaView session methods for the following classes: vtkSMSession, vtkSMSessionClient, vtkSMSessionServer.
Definition at line 27 of file vtkPVSessionBase.h.
Definition at line 30 of file vtkPVSessionBase.h.
| Enumerator | |
|---|---|
| RegisterRemoteObjectEvent | |
| UnRegisterRemoteObjectEvent | |
| ProcessingRemoteEnd | |
| ConnectionLost | |
Definition at line 33 of file vtkPVSessionBase.h.
|
protected |
|
protected |
|
overrideprotected |
|
virtual |
Reimplemented from vtkPVSession.
Reimplemented in vtkSMSession, vtkSMSessionClient, and vtkPVSessionServer.
Reimplemented from vtkPVSession.
Reimplemented in vtkSMSession, vtkSMSessionClient, and vtkPVSessionServer.
|
static |
|
overridevirtual |
Reimplemented from vtkPVSession.
Reimplemented in vtkSMSession, vtkSMSessionClient, and vtkPVSessionServer.
|
overridevirtual |
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 is suitable for server processes such as pvserver, pvdataserver (both root and satellites).
Reimplemented from vtkPVSession.
Reimplemented in vtkSMSession, and vtkSMSessionClient.
|
overridevirtual |
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. Overridden to provide support for non-remote-server case. We simply read the local process information and return it.
Implements vtkPVSession.
Reimplemented in vtkSMSessionClient.
|
overridevirtual |
This is socket connection, if any to communicate between the data-server and render-server nodes.
Forwarded for vtkPVSessionCore.
Reimplemented from vtkPVSession.
|
virtual |
Push the state message.
Reimplemented in vtkSMSession, and vtkSMSessionClient.
|
virtual |
Pull the state message.
Reimplemented in vtkSMSessionClient.
|
virtual |
Execute a command on the given processes.
Use GetLastResult() to obtain the last result after the command stream is evaluated. Once can set ignore_errors to true, to ignore any interpreting errors.
Reimplemented in vtkSMSessionClient.
|
virtual |
Returns the response of the ExecuteStream() call from the location.
Note if location refers to multiple processes, then the reply is only fetched from the "closest" process.
Reimplemented in vtkSMSessionClient.
|
virtual |
Gather information about an object referred by the globalid.
location identifies the processes to gather the information from.
Reimplemented in vtkSMSessionClient.
|
pure virtual |
Sends the message to all clients.
Implemented in vtkSMSession, and vtkPVSessionServer.
|
pure virtual |
Sends the message to all but the active client-session.
Implemented in vtkSMSession, and vtkPVSessionServer.
|
virtual |
Provides access to the session core.
| vtkSIProxyDefinitionManager* vtkPVSessionBase::GetProxyDefinitionManager | ( | ) |
Get the ProxyDefinitionManager.
| vtkSIObject* vtkPVSessionBase::GetSIObject | ( | vtkTypeUInt32 | globalid | ) |
Returns a vtkSIObject or subclass given its global id, if any.
|
virtual |
|
virtual |
| vtkObject* vtkPVSessionBase::GetRemoteObject | ( | vtkTypeUInt32 | globalid | ) |
Return a vtkSMRemoteObject given its global id if any otherwise return nullptr;.
|
virtual |
Allow the user to fill its vtkCollection with all RemoteObject This could be useful when you want to hold a reference to them to prevent any deletion across several method call.
|
virtual |
Provides the next available identifier.
This implementation works locally. without any code distribution. To support the distributed architecture the vtkSMSessionClient override those method to call them on the DATA_SERVER vtkPVSessionBase instance.
Reimplemented in vtkSMSessionClient.
|
virtual |
Return the first Id of the requested chunk.
1 = ReverveNextIdChunk(10); | Reserved ids [1,2,3,4,5,6,7,8,9,10] 11 = ReverveNextIdChunk(10);| Reserved ids [11,12,13,14,15,16,17,18,19,20] b = a + 10;
Reimplemented in vtkSMSessionClient.
|
virtual |
This property is used to discard ignore_synchronization proxy property when we load protobuf states.
Therefore, if we load any camera state while that property is true, this won't affect the proxy/property state at all. It will simply remain the same.
|
virtual |
Update internal session core in order to use the one used in another session.
|
protected |
Method used to migrate from one Session type to another by keeping the same vtkPVSessionCore.
|
protected |
Method used to migrate from one Session type to another by keeping the same vtkPVSessionCore.
|
overrideprotectedvirtual |
Should be called to begin/end receiving progresses on this session.
Overridden to relay to the server(s).
Reimplemented from vtkPVSession.
Reimplemented in vtkSMSessionClient.
|
overrideprotectedvirtual |
Should be called to begin/end receiving progresses on this session.
Overridden to relay to the server(s).
Reimplemented from vtkPVSession.
Reimplemented in vtkSMSessionClient.
|
protectedvirtual |
Methods used to monitor if we are currently processing a server notification Only vtkSMSessionClient use the flag to disable ignore_synchronization properties from being updated.
|
protectedvirtual |
Methods used to monitor if we are currently processing a server notification Only vtkSMSessionClient use the flag to disable ignore_synchronization properties from being updated.
|
protected |
Register a remote object.
|
protected |
Unregister a remote object.
|
friend |
Definition at line 225 of file vtkPVSessionBase.h.
|
friend |
Definition at line 226 of file vtkPVSessionBase.h.
|
friend |
Definition at line 227 of file vtkPVSessionBase.h.
|
protected |
Methods used to monitor if we are currently processing a server notification Only vtkSMSessionClient use the flag to disable ignore_synchronization properties from being updated.
Definition at line 237 of file vtkPVSessionBase.h.
|
protected |
Definition at line 250 of file vtkPVSessionBase.h.
1.8.13 on Sat Dec 6 2025