vtkSMLiveInsituLinkProxy.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
2 // SPDX-License-Identifier: BSD-3-Clause
15 #ifndef vtkSMLiveInsituLinkProxy_h
16 #define vtkSMLiveInsituLinkProxy_h
17 
18 #include "vtkRemotingLiveModule.h" //needed for exports
19 #include "vtkSMProxy.h"
20 #include "vtkSmartPointer.h" // needed for vtkSmartPointer.
21 #include "vtkWeakPointer.h" // needed for vtkWeakPointer.
22 
24 
25 class VTKREMOTINGLIVE_EXPORT vtkSMLiveInsituLinkProxy : public vtkSMProxy
26 {
27 public:
28  static vtkSMLiveInsituLinkProxy* New();
30  void PrintSelf(ostream& os, vtkIndent indent) override;
31 
33 
37  vtkSMSessionProxyManager* GetInsituProxyManager();
38  void SetInsituProxyManager(vtkSMSessionProxyManager*);
40 
41  bool HasExtract(const char* reg_group, const char* reg_name, int port_number);
42 
44  vtkSMProxy* CreateExtract(const char* reg_group, const char* reg_name, int port_number);
45  void RemoveExtract(vtkSMProxy*);
48 
52  void LiveChanged();
53  vtkIdType GetTimeStep() { return this->TimeStep; }
55 
59  void LoadState(const vtkSMMessage* msg, vtkSMProxyLocator* locator) override;
60 
66  void PushUpdatedStates();
67 
68 protected:
70  ~vtkSMLiveInsituLinkProxy() override;
71 
72  // overridden to ensure that we communicate the globalid for this proxy so
73  // that the server-side can send messages to this proxy.
74  void CreateVTKObjects() override;
75 
76  void MarkStateDirty();
77 
81  void PushUpdatedState();
82 
83  void InsituConnected(const char* initialial_state);
84  void NextTimestepAvailable(vtkIdType timeStep);
85 
88 
89  bool StateDirty;
91 
92 private:
94  void operator=(const vtkSMLiveInsituLinkProxy&) = delete;
95 
96  class vtkInternals;
97  vtkInternals* Internals;
98 };
99 
100 #endif
vtkSMSessionProxyManager
Definition: vtkSMSessionProxyManager.h:135
vtkSMProxy::New
static vtkSMProxy * New()
vtkSMProxy::CreateVTKObjects
virtual void CreateVTKObjects()
Given a class name (by setting VTKClassName) and server ids (by setting ServerIDs),...
vtkIdType
int vtkIdType
vtkSMProxy::Internals
vtkSMProxyInternals * Internals
Definition: vtkSMProxy.h:1002
vtkSMLiveInsituLinkProxy
Performs additional operation on the Live client.
Definition: vtkSMLiveInsituLinkProxy.h:25
vtkSMLiveInsituLinkProxy::InsituProxyManager
vtkSmartPointer< vtkSMSessionProxyManager > InsituProxyManager
Definition: vtkSMLiveInsituLinkProxy.h:86
vtkSmartPointer< vtkSMSessionProxyManager >
vtkSMProxy::LoadState
void LoadState(const vtkSMMessage *msg, vtkSMProxyLocator *locator) override
This method is used to initialise the object to the given state If the definitionOnly Flag is set to ...
vtkSMProxy
proxy for a VTK object(s) on a server
Definition: vtkSMProxy.h:140
vtkSMLiveInsituLinkProxy::CatalystSessionCore
vtkWeakPointer< vtkPVCatalystSessionCore > CatalystSessionCore
Definition: vtkSMLiveInsituLinkProxy.h:87
vtkSMProxy::operator=
void operator=(const vtkSMProxy &)=delete
vtkIndent
vtkSMMessage
vtkSmartPointer.h
vtkWeakPointer.h
vtkSMLiveInsituLinkProxy::StateDirty
bool StateDirty
Definition: vtkSMLiveInsituLinkProxy.h:89
vtkSMProxy.h
vtkSMLiveInsituLinkProxy::TimeStep
vtkIdType TimeStep
Definition: vtkSMLiveInsituLinkProxy.h:90
vtkSMProxy::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
vtkSMProxyLocator
is used to locate proxies referred to in state xmls while loading state files.
Definition: vtkSMProxyLocator.h:24
vtkSMLiveInsituLinkProxy::GetTimeStep
vtkIdType GetTimeStep()
Wakes up Insitu side if simulation is paused.
Definition: vtkSMLiveInsituLinkProxy.h:53
vtkWeakPointer< vtkPVCatalystSessionCore >
vtkPVCatalystSessionCore
Definition: vtkPVCatalystSessionCore.h:22