link for live-coprocessing.
More...
#include <vtkLiveInsituLink.h>
|
virtual const char * | GetClassName () |
|
virtual int | IsA (const char *type) |
|
void | PrintSelf (ostream &os, vtkIndent indent) |
|
bool | Initialize () |
| Initializes the link. More...
|
|
bool | Initialize (vtkSMSessionProxyManager *) |
|
void | InsituUpdate (double time, vtkIdType timeStep) |
| Every time Insitu is ready to communicate with ParaView visualization engine call this method. More...
|
|
void | InsituPostProcess (double time, vtkIdType timeStep) |
| Every time Insitu is ready to push extracts to ParaView visualization engine, call this method. More...
|
|
void | RegisterExtract (vtkTrivialProducer *producer, const char *groupname, const char *proxyname, int portnumber) |
|
void | UnRegisterExtract (vtkTrivialProducer *producer) |
|
void | OnInsituUpdate (double time, vtkIdType timeStep) |
|
void | OnInsituPostProcess (double time, vtkIdType timeStep) |
|
void | LiveChanged () |
| Signal a change on the ParaView Live side and transmit it to the Insitu side. More...
|
|
void | UpdateInsituXMLState (const char *txt) |
|
void | InsituConnect (vtkMultiProcessController *controller) |
|
void | DropLiveInsituConnection () |
| Called to drop the connection between Insitu and ParaView Live. More...
|
|
|
virtual void | SetInsituPort (int) |
| Set the port number. More...
|
|
virtual int | GetInsituPort () |
| Set the port number. More...
|
|
|
virtual void | SetHostname (const char *) |
| Set the host name. More...
|
|
virtual char * | GetHostname () |
| Set the host name. More...
|
|
|
virtual void | SetProxyId (unsigned int) |
| When instantiated on the ParaView visualization server side using a vtkSMProxy, ProxyId is used to identify the proxy corresponding to this instance. More...
|
|
virtual unsigned int | GetProxyId () |
| When instantiated on the ParaView visualization server side using a vtkSMProxy, ProxyId is used to identify the proxy corresponding to this instance. More...
|
|
|
virtual int | GetSimulationPaused () |
| 'SimulationPaused' is set/reset on Paraview Live and sent to Insitu every time step. More...
|
|
void | SetSimulationPaused (int paused) |
| 'SimulationPaused' is set/reset on Paraview Live and sent to Insitu every time step. More...
|
|
|
int | WaitForLiveChange () |
| is called on the catalyst side. More...
|
|
void | OnLiveChanged () |
| Description: Called on INSITU side when LIVE has changed. More...
|
|
void | PrintSelf (ostream &os, vtkIndent indent) |
|
link for live-coprocessing.
vtkLiveInsituLink manages the communication link between Insitu and Live visualization servers. vtkLiveInsituLink is created on both ends of the live-insitu channel i.e. in Insitu code (by instantiating vtkLiveInsituLink directly) and in the Live ParaView application (by using a proxy that instantiates the vtkLiveInsituLink).
Definition at line 54 of file vtkLiveInsituLink.h.
◆ Superclass
◆ anonymous enum
Set/Get the link type i.e.
whether the current process is the visualization process or the insitu process.
Definition at line 83 of file vtkLiveInsituLink.h.
◆ NotificationTags
◆ RMITags
Enumerator |
---|
UPDATE_RMI_TAG | |
POSTPROCESS_RMI_TAG | |
INITIALIZE_CONNECTION | |
DROP_CAT2PV_CONNECTION | |
LIVE_CHANGED | |
Definition at line 201 of file vtkLiveInsituLink.h.
◆ vtkLiveInsituLink()
vtkLiveInsituLink::vtkLiveInsituLink |
( |
| ) |
|
|
protected |
◆ ~vtkLiveInsituLink()
vtkLiveInsituLink::~vtkLiveInsituLink |
( |
| ) |
|
|
protected |
◆ New()
◆ GetClassName()
virtual const char* vtkLiveInsituLink::GetClassName |
( |
| ) |
|
|
virtual |
◆ IsTypeOf()
static int vtkLiveInsituLink::IsTypeOf |
( |
const char * |
type | ) |
|
|
static |
◆ IsA()
virtual int vtkLiveInsituLink::IsA |
( |
const char * |
type | ) |
|
|
virtual |
◆ SafeDownCast()
◆ PrintSelf()
void vtkLiveInsituLink::PrintSelf |
( |
ostream & |
os, |
|
|
vtkIndent |
indent |
|
) |
| |
◆ SetInsituPort()
virtual void vtkLiveInsituLink::SetInsituPort |
( |
int |
| ) |
|
|
virtual |
Set the port number.
This is the port on which the root data-server node will open a server-socket to accept connections from VTK InSitu Library.
◆ GetInsituPort()
virtual int vtkLiveInsituLink::GetInsituPort |
( |
| ) |
|
|
virtual |
Set the port number.
This is the port on which the root data-server node will open a server-socket to accept connections from VTK InSitu Library.
◆ SetHostname()
virtual void vtkLiveInsituLink::SetHostname |
( |
const char * |
| ) |
|
|
virtual |
◆ GetHostname()
virtual char* vtkLiveInsituLink::GetHostname |
( |
| ) |
|
|
virtual |
◆ SetProcessType()
virtual void vtkLiveInsituLink::SetProcessType |
( |
int |
| ) |
|
|
virtual |
Set/Get the link type i.e.
whether the current process is the visualization process or the insitu process.
◆ GetProcessType()
virtual int vtkLiveInsituLink::GetProcessType |
( |
| ) |
|
|
virtual |
Set/Get the link type i.e.
whether the current process is the visualization process or the insitu process.
◆ SetProxyId()
virtual void vtkLiveInsituLink::SetProxyId |
( |
unsigned |
int | ) |
|
|
virtual |
When instantiated on the ParaView visualization server side using a vtkSMProxy, ProxyId is used to identify the proxy corresponding to this instance.
That helps us construct notification messages that the visualization server can send to the client.
◆ GetProxyId()
virtual unsigned int vtkLiveInsituLink::GetProxyId |
( |
| ) |
|
|
virtual |
When instantiated on the ParaView visualization server side using a vtkSMProxy, ProxyId is used to identify the proxy corresponding to this instance.
That helps us construct notification messages that the visualization server can send to the client.
◆ GetSimulationPaused()
virtual int vtkLiveInsituLink::GetSimulationPaused |
( |
| ) |
|
|
virtual |
'SimulationPaused' is set/reset on Paraview Live and sent to Insitu every time step.
◆ SetSimulationPaused()
void vtkLiveInsituLink::SetSimulationPaused |
( |
int |
paused | ) |
|
'SimulationPaused' is set/reset on Paraview Live and sent to Insitu every time step.
◆ Initialize() [1/2]
bool vtkLiveInsituLink::Initialize |
( |
| ) |
|
|
inline |
Initializes the link.
For in situ this returns true it there is a connection and false otherwise. For live it always returns true.
Definition at line 116 of file vtkLiveInsituLink.h.
◆ Initialize() [2/2]
◆ InsituUpdate()
void vtkLiveInsituLink::InsituUpdate |
( |
double |
time, |
|
|
vtkIdType |
timeStep |
|
) |
| |
Every time Insitu is ready to communicate with ParaView visualization engine call this method.
The goal of this call is too get the latest updates from ParaView including changes to state for the co-processing pipeline or changes in what extract the visualization engine is expecting. This method's primary goal is to obtain information from ParaView vis engine. If no active connection to ParaView visualization engine exists, this will make an attempt to connect to ParaView.
◆ InsituPostProcess()
void vtkLiveInsituLink::InsituPostProcess |
( |
double |
time, |
|
|
vtkIdType |
timeStep |
|
) |
| |
Every time Insitu is ready to push extracts to ParaView visualization engine, call this method.
If no active ParaView visualization engine connection exists (or the connection dies), then this method does nothing (besides some bookkeeping). Otherwise, this will push any extracts requested to the ParaView visualization engine.
◆ WaitForLiveChange()
int vtkLiveInsituLink::WaitForLiveChange |
( |
| ) |
|
is called on the catalyst side.
Insitu stops until the pipeline is edited, an extract is added or removed or the user continues the simulation. Returns != 0 if the visualization side disconnected, 0 otherwise
◆ OnLiveChanged()
void vtkLiveInsituLink::OnLiveChanged |
( |
| ) |
|
Description: Called on INSITU side when LIVE has changed.
◆ RegisterExtract()
void vtkLiveInsituLink::RegisterExtract |
( |
vtkTrivialProducer * |
producer, |
|
|
const char * |
groupname, |
|
|
const char * |
proxyname, |
|
|
int |
portnumber |
|
) |
| |
◆ UnRegisterExtract()
void vtkLiveInsituLink::UnRegisterExtract |
( |
vtkTrivialProducer * |
producer | ) |
|
◆ OnInsituUpdate()
void vtkLiveInsituLink::OnInsituUpdate |
( |
double |
time, |
|
|
vtkIdType |
timeStep |
|
) |
| |
◆ OnInsituPostProcess()
void vtkLiveInsituLink::OnInsituPostProcess |
( |
double |
time, |
|
|
vtkIdType |
timeStep |
|
) |
| |
◆ LiveChanged()
void vtkLiveInsituLink::LiveChanged |
( |
| ) |
|
Signal a change on the ParaView Live side and transmit it to the Insitu side.
This is called when the state or extracts are changed or when the simulation is continued.
◆ UpdateInsituXMLState()
void vtkLiveInsituLink::UpdateInsituXMLState |
( |
const char * |
txt | ) |
|
◆ FilterXMLState()
static bool vtkLiveInsituLink::FilterXMLState |
( |
vtkPVXMLElement * |
xmlState | ) |
|
|
static |
This method will remove references to proxy that shouldn't be shared with ParaView Return true if something has been removed.
◆ InsituConnect()
void vtkLiveInsituLink::InsituConnect |
( |
vtkMultiProcessController * |
controller | ) |
|
◆ DropLiveInsituConnection()
void vtkLiveInsituLink::DropLiveInsituConnection |
( |
| ) |
|
Called to drop the connection between Insitu and ParaView Live.
◆ InitializeLive()
void vtkLiveInsituLink::InitializeLive |
( |
| ) |
|
|
protected |
Called by Initialize() to initialize on a ParaView Live process.
◆ InitializeInsitu()
bool vtkLiveInsituLink::InitializeInsitu |
( |
| ) |
|
|
protected |
Called by Initialize() to initialize on a Insitu process.
Returns true if a connection is made.
◆ OnConnectionCreatedEvent()
void vtkLiveInsituLink::OnConnectionCreatedEvent |
( |
| ) |
|
|
protected |
Callback on Visualization process when a simulation connects to it.
◆ OnConnectionClosedEvent()
void vtkLiveInsituLink::OnConnectionClosedEvent |
( |
vtkObject * |
, |
|
|
unsigned long |
eventid, |
|
|
void * |
calldata |
|
) |
| |
|
protected |
◆ Hostname
char* vtkLiveInsituLink::Hostname |
|
protected |
◆ InsituPort
int vtkLiveInsituLink::InsituPort |
|
protected |
◆ ProcessType
int vtkLiveInsituLink::ProcessType |
|
protected |
◆ ProxyId
unsigned int vtkLiveInsituLink::ProxyId |
|
protected |
◆ InsituXMLStateChanged
bool vtkLiveInsituLink::InsituXMLStateChanged |
|
protected |
◆ ExtractsChanged
bool vtkLiveInsituLink::ExtractsChanged |
|
protected |
◆ SimulationPaused
int vtkLiveInsituLink::SimulationPaused |
|
protected |
◆ InsituXMLState
char* vtkLiveInsituLink::InsituXMLState |
|
protected |
◆ LiveSession
◆ Controller
vtkSmartPointer<vtkMultiProcessController> vtkLiveInsituLink::Controller |
|
protected |
◆ ExtractsDeliveryHelper
The documentation for this class was generated from the following file: