link for live-coprocessing. More...

#include <vtkLiveInsituLink.h>

Inheritance diagram for vtkLiveInsituLink:

Collaboration diagram for vtkLiveInsituLink:

[legend]

Public Types
enum	NotificationTags { CONNECTED = 1200, NEXT_TIMESTEP_AVAILABLE = 1201, DISCONNECTED = 1202 }

typedef vtkSMObject	Superclass

Public Types inherited from vtkSMObject
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

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 *proc0NodesController)

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...

Public Member Functions inherited from vtkSMObject
void	PrintSelf (ostream &os, vtkIndent indent) override

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 vtkLiveInsituLink *	New ()

static int	IsTypeOf (const char *type)

static vtkLiveInsituLink *	SafeDownCast (vtkObject *o)

static bool	FilterXMLState (vtkPVXMLElement *xmlState)
	This method will remove references to proxy that shouldn't be shared with ParaView Return true if something has been removed. More...

Static Public Member Functions inherited from vtkSMObject
static vtkSMObject *	New ()

static int	IsTypeOf (const char *type)

static vtkSMObject *	SafeDownCast (vtkObject *o)

static std::string	CreatePrettyLabel (const std::string &name)
	Return a well-formated label using provided name by adding spaces between lower cases and upper cases: More...

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 Types
enum	RMITags { UPDATE_RMI_TAG = 8800, POSTPROCESS_RMI_TAG = 8801, INITIALIZE_CONNECTION = 8802, DROP_CAT2PV_CONNECTION = 8803, LIVE_CHANGED = 8804 }

Protected Member Functions
	vtkLiveInsituLink ()

	~vtkLiveInsituLink () override

void	InitializeLive ()
	Called by Initialize() to initialize on a ParaView Live process. More...

bool	InitializeInsitu ()
	Called by Initialize() to initialize on a Insitu process. More...

void	OnConnectionCreatedEvent ()
	Callback on Visualization process when a simulation connects to it. More...

void	OnConnectionClosedEvent (vtkObject , unsigned long eventid, void calldata)
	Callback on Visualization process when a connection dies during vtkNetworkAccessManager::ProcessEvents(). More...

Protected Member Functions inherited from vtkSMObject
	vtkSMObject ()

	~vtkSMObject () override

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
char *	Hostname

int	InsituPort

int	ProcessType

unsigned int	ProxyId

bool	InsituXMLStateChanged

bool	ExtractsChanged

int	SimulationPaused

char *	InsituXMLState

vtkWeakPointer< vtkPVSessionBase >	LiveSession

vtkSmartPointer< vtkMultiProcessController >	Proc0NodesController
	The controller that communicates between the INSITU and the LIVE process 0 nodes. More...

vtkSmartPointer< vtkExtractsDeliveryHelper >	ExtractsDeliveryHelper

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

enum	{ LIVE = 0, INSITU = 1 }
	Set/Get the link type i.e. More...

virtual void	SetProcessType (int)
	Set/Get the link type i.e. More...

virtual int	GetProcessType ()
	Set/Get the link type i.e. More...

Detailed Description

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 42 of file vtkLiveInsituLink.h.

Member Typedef Documentation

◆ Superclass

typedef vtkSMObject vtkLiveInsituLink::Superclass

Definition at line 46 of file vtkLiveInsituLink.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Set/Get the link type i.e.

whether the current process is the visualization process or the insitu process.

Enumerator
LIVE
INSITU

Definition at line 71 of file vtkLiveInsituLink.h.

◆ NotificationTags

enum vtkLiveInsituLink::NotificationTags

Enumerator
CONNECTED
NEXT_TIMESTEP_AVAILABLE
DISCONNECTED

Definition at line 161 of file vtkLiveInsituLink.h.

◆ RMITags

enum vtkLiveInsituLink::RMITags

protected

Enumerator
UPDATE_RMI_TAG
POSTPROCESS_RMI_TAG
INITIALIZE_CONNECTION
DROP_CAT2PV_CONNECTION
LIVE_CHANGED

Definition at line 189 of file vtkLiveInsituLink.h.

Constructor & Destructor Documentation

◆ vtkLiveInsituLink()

vtkLiveInsituLink::vtkLiveInsituLink ( )

protected

◆ ~vtkLiveInsituLink()

vtkLiveInsituLink::~vtkLiveInsituLink ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkLiveInsituLink* vtkLiveInsituLink::New ( )

static

◆ GetClassName()

virtual const char* vtkLiveInsituLink::GetClassName ( )

virtual

Reimplemented from vtkSMObject.

◆ IsTypeOf()

static int vtkLiveInsituLink::IsTypeOf ( const char * type )

static

◆ IsA()

virtual int vtkLiveInsituLink::IsA ( const char * type )

virtual

Reimplemented from vtkSMObject.

◆ SafeDownCast()

static vtkLiveInsituLink* vtkLiveInsituLink::SafeDownCast ( vtkObject * o )

static

◆ PrintSelf()

void vtkLiveInsituLink::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

Reimplemented from vtkObject.

◆ 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

Set the host name.

◆ GetHostname()

virtual char* vtkLiveInsituLink::GetHostname ( )

virtual

Set the host name.

◆ 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 ( void )

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 104 of file vtkLiveInsituLink.h.

◆ Initialize() [2/2]

bool vtkLiveInsituLink::Initialize ( vtkSMSessionProxyManager * )

◆ 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 * proc0NodesController )

◆ 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

Callback on Visualization process when a connection dies during vtkNetworkAccessManager::ProcessEvents().

Member Data Documentation

◆ Hostname

char* vtkLiveInsituLink::Hostname

protected

Definition at line 224 of file vtkLiveInsituLink.h.

◆ InsituPort

int vtkLiveInsituLink::InsituPort

protected

Definition at line 225 of file vtkLiveInsituLink.h.

◆ ProcessType

int vtkLiveInsituLink::ProcessType

protected

Definition at line 226 of file vtkLiveInsituLink.h.

◆ ProxyId

unsigned int vtkLiveInsituLink::ProxyId

protected

Definition at line 227 of file vtkLiveInsituLink.h.

◆ InsituXMLStateChanged

bool vtkLiveInsituLink::InsituXMLStateChanged

protected

Definition at line 229 of file vtkLiveInsituLink.h.

◆ ExtractsChanged

bool vtkLiveInsituLink::ExtractsChanged

protected

Definition at line 230 of file vtkLiveInsituLink.h.

◆ SimulationPaused

int vtkLiveInsituLink::SimulationPaused

protected

Definition at line 231 of file vtkLiveInsituLink.h.

◆ InsituXMLState

char* vtkLiveInsituLink::InsituXMLState

protected

Definition at line 233 of file vtkLiveInsituLink.h.

◆ LiveSession

vtkWeakPointer<vtkPVSessionBase> vtkLiveInsituLink::LiveSession

protected

Definition at line 234 of file vtkLiveInsituLink.h.

◆ Proc0NodesController

vtkSmartPointer<vtkMultiProcessController> vtkLiveInsituLink::Proc0NodesController

protected

The controller that communicates between the INSITU and the LIVE process 0 nodes.

Definition at line 239 of file vtkLiveInsituLink.h.

◆ ExtractsDeliveryHelper

vtkSmartPointer<vtkExtractsDeliveryHelper> vtkLiveInsituLink::ExtractsDeliveryHelper

protected

Definition at line 240 of file vtkLiveInsituLink.h.

The documentation for this class was generated from the following file:

/builds/gitlab-kitware-sciviz-ci/Remoting/Live/vtkLiveInsituLink.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ anonymous enum

◆ NotificationTags

◆ RMITags

Constructor & Destructor Documentation

◆ vtkLiveInsituLink()

◆ ~vtkLiveInsituLink()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ SetInsituPort()

◆ GetInsituPort()

◆ SetHostname()

◆ GetHostname()

◆ SetProcessType()

◆ GetProcessType()

◆ SetProxyId()

◆ GetProxyId()

◆ GetSimulationPaused()

◆ SetSimulationPaused()

◆ Initialize() [1/2]

◆ Initialize() [2/2]

◆ InsituUpdate()

◆ InsituPostProcess()

◆ WaitForLiveChange()

◆ OnLiveChanged()

◆ RegisterExtract()

◆ UnRegisterExtract()

◆ OnInsituUpdate()

◆ OnInsituPostProcess()

◆ LiveChanged()

◆ UpdateInsituXMLState()

◆ FilterXMLState()

◆ InsituConnect()

◆ DropLiveInsituConnection()

◆ InitializeLive()

◆ InitializeInsitu()

◆ OnConnectionCreatedEvent()

◆ OnConnectionClosedEvent()

Member Data Documentation

◆ Hostname

◆ InsituPort

◆ ProcessType

◆ ProxyId

◆ InsituXMLStateChanged

◆ ExtractsChanged

◆ SimulationPaused

◆ InsituXMLState

◆ LiveSession

◆ Proc0NodesController

◆ ExtractsDeliveryHelper