Singleton that provides access to Insitu objects. More...

#include <pqLiveInsituManager.h>

Inherits QObject.

Signals
void	connectionInitiated (pqServer *displaySession)

void	timeUpdated ()

void	breakpointAdded (pqServer *insituSession)

void	breakpointRemoved (pqServer *insituSession)

void	breakpointHit (pqServer *insituSession)

Public Member Functions
vtkSMLiveInsituLinkProxy *	linkProxy ()

pqServer *	selectedInsituServer ()
	Returns current Catalyst server. More...

bool	isDisplayServer (pqServer *server)
	Is this the server where Catalyst displays its extracts. More...

pqLiveInsituVisualizationManager *	managerFromDisplay (pqServer *displaySession)
	Returns the catalyst visualization manager associated with 'displaySession' or 'insituSession'. More...

pqLiveInsituVisualizationManager *	connect (pqServer *displaySession, int portNumber=-1)
	Creates the manager and accept connections from Catalyst. More...

double	breakpointTime () const

double	breakpointTimeStep () const

void	setBreakpoint (double time)

void	setBreakpoint (vtkIdType timeStep)

void	removeBreakpoint ()

bool	hasBreakpoint () const

double	time () const

vtkIdType	timeStep () const

void	waitTimestep (vtkIdType timeStep)

void	waitBreakpointHit ()

void	closeConnection ()
	Close the catalyst server and remove it from the internal storage to make sure that we can connect to another catalyst server if it's needed. More...

Static Public Member Functions
static pqLiveInsituManager *	instance ()

static vtkSMLiveInsituLinkProxy *	linkProxy (pqServer *insituSession)
	Returns the link proxy to Catalyst or nullptr if not connected or if not a catalyst server. More...

static bool	isInsituServer (pqServer *server)

static bool	isInsitu (pqProxy *pipelineSource)

static bool	isWriterParametersProxy (vtkSMProxy *proxy)

static pqPipelineSource *	pipelineSource (pqServer *insituSession)

static void	time (pqPipelineSource source, double time, vtkIdType *timeStep)

static pqLiveInsituVisualizationManager *	managerFromInsitu (pqServer *insituSession)

Static Public Attributes
static double	INVALID_TIME

static vtkIdType	INVALID_TIME_STEP

Protected Slots
void	onCatalystDisconnected ()
	called when Catalyst disconnects. More...

void	onBreakpointHit (pqServer *insituSession)

void	onSourceAdded (pqPipelineSource *source)

void	onDataUpdated (pqPipelineSource *source)

Protected Member Functions
	pqLiveInsituManager ()

bool	isTimeBreakpointHit () const

bool	isTimeStepBreakpointHit () const

Protected Attributes
double	BreakpointTime

double	Time

vtkIdType	BreakpointTimeStep

vtkIdType	TimeStep

Detailed Description

Singleton that provides access to Insitu objects.

Some of these objects are pqServer, pqLiveInsituVisualizationManager, vtkSMLiveInsituLinkProxy.

Definition at line 27 of file pqLiveInsituManager.h.

Constructor & Destructor Documentation

◆ pqLiveInsituManager()

pqLiveInsituManager::pqLiveInsituManager ( )

protected

Member Function Documentation

◆ instance()

static pqLiveInsituManager* pqLiveInsituManager::instance ( )

static

◆ linkProxy() [1/2]

static vtkSMLiveInsituLinkProxy* pqLiveInsituManager::linkProxy ( pqServer * insituSession )

static

Returns the link proxy to Catalyst or nullptr if not connected or if not a catalyst server.

◆ linkProxy() [2/2]

vtkSMLiveInsituLinkProxy* pqLiveInsituManager::linkProxy ( )

inline

Definition at line 41 of file pqLiveInsituManager.h.

◆ isInsituServer()

static bool pqLiveInsituManager::isInsituServer ( pqServer * server )

static

◆ isInsitu()

static bool pqLiveInsituManager::isInsitu ( pqProxy * pipelineSource )

static

◆ isWriterParametersProxy()

static bool pqLiveInsituManager::isWriterParametersProxy ( vtkSMProxy * proxy )

static

◆ pipelineSource()

static pqPipelineSource* pqLiveInsituManager::pipelineSource ( pqServer * insituSession )

static

◆ time() [1/2]

static void pqLiveInsituManager::time	(	pqPipelineSource *	source,
		double *	time,
		vtkIdType *	timeStep
	)

static

◆ connectionInitiated

void pqLiveInsituManager::connectionInitiated ( pqServer * displaySession )

signal

◆ timeUpdated

void pqLiveInsituManager::timeUpdated ( )

signal

◆ breakpointAdded

void pqLiveInsituManager::breakpointAdded ( pqServer * insituSession )

signal

◆ breakpointRemoved

void pqLiveInsituManager::breakpointRemoved ( pqServer * insituSession )

signal

◆ breakpointHit

void pqLiveInsituManager::breakpointHit ( pqServer * insituSession )

signal

◆ selectedInsituServer()

pqServer* pqLiveInsituManager::selectedInsituServer ( )

Returns current Catalyst server.

The current Catalyst server is either selected or its displaySession is selected. If no server is selected we choose the first Catalyst server we find. We return nullptr if the client is not connected to Catalyst.

◆ isDisplayServer()

bool pqLiveInsituManager::isDisplayServer ( pqServer * server )

Is this the server where Catalyst displays its extracts.

◆ managerFromDisplay()

pqLiveInsituVisualizationManager* pqLiveInsituManager::managerFromDisplay ( pqServer * displaySession )

Returns the catalyst visualization manager associated with 'displaySession' or 'insituSession'.

◆ managerFromInsitu()

static pqLiveInsituVisualizationManager* pqLiveInsituManager::managerFromInsitu ( pqServer * insituSession )

static

◆ connect()

pqLiveInsituVisualizationManager* pqLiveInsituManager::connect	(	pqServer *	displaySession,
		int	portNumber = `-1`
	)

Creates the manager and accept connections from Catalyst.

Can pass in a requested portNumber.

◆ breakpointTime()

double pqLiveInsituManager::breakpointTime ( ) const

inline

Definition at line 82 of file pqLiveInsituManager.h.

◆ breakpointTimeStep()

double pqLiveInsituManager::breakpointTimeStep ( ) const

inline

Definition at line 83 of file pqLiveInsituManager.h.

◆ setBreakpoint() [1/2]

void pqLiveInsituManager::setBreakpoint ( double time )

◆ setBreakpoint() [2/2]

void pqLiveInsituManager::setBreakpoint ( vtkIdType timeStep )

◆ removeBreakpoint()

void pqLiveInsituManager::removeBreakpoint ( )

◆ hasBreakpoint()

bool pqLiveInsituManager::hasBreakpoint ( ) const

inline

Definition at line 87 of file pqLiveInsituManager.h.

◆ time() [2/2]

double pqLiveInsituManager::time ( ) const

inline

Definition at line 93 of file pqLiveInsituManager.h.

◆ timeStep()

vtkIdType pqLiveInsituManager::timeStep ( ) const

inline

Definition at line 94 of file pqLiveInsituManager.h.

◆ waitTimestep()

void pqLiveInsituManager::waitTimestep ( vtkIdType timeStep )

◆ waitBreakpointHit()

void pqLiveInsituManager::waitBreakpointHit ( )

◆ closeConnection()

void pqLiveInsituManager::closeConnection ( )

Close the catalyst server and remove it from the internal storage to make sure that we can connect to another catalyst server if it's needed.

◆ onCatalystDisconnected

void pqLiveInsituManager::onCatalystDisconnected ( )

protectedslot

called when Catalyst disconnects.

We clean up the Catalyst connection.

◆ onBreakpointHit

void pqLiveInsituManager::onBreakpointHit ( pqServer * insituSession )

protectedslot

◆ onSourceAdded

void pqLiveInsituManager::onSourceAdded ( pqPipelineSource * source )

protectedslot

◆ onDataUpdated

void pqLiveInsituManager::onDataUpdated ( pqPipelineSource * source )

protectedslot

◆ isTimeBreakpointHit()

bool pqLiveInsituManager::isTimeBreakpointHit ( ) const

protected

◆ isTimeStepBreakpointHit()

bool pqLiveInsituManager::isTimeStepBreakpointHit ( ) const

protected

Member Data Documentation

◆ INVALID_TIME

double pqLiveInsituManager::INVALID_TIME

static

Definition at line 32 of file pqLiveInsituManager.h.

◆ INVALID_TIME_STEP

vtkIdType pqLiveInsituManager::INVALID_TIME_STEP

static

Definition at line 33 of file pqLiveInsituManager.h.

◆ BreakpointTime

double pqLiveInsituManager::BreakpointTime

protected

Definition at line 118 of file pqLiveInsituManager.h.

◆ Time

double pqLiveInsituManager::Time

protected

Definition at line 119 of file pqLiveInsituManager.h.

◆ BreakpointTimeStep

vtkIdType pqLiveInsituManager::BreakpointTimeStep

protected

Definition at line 120 of file pqLiveInsituManager.h.

◆ TimeStep

vtkIdType pqLiveInsituManager::TimeStep

protected

Definition at line 121 of file pqLiveInsituManager.h.

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

/builds/gitlab-kitware-sciviz-ci/Qt/Components/pqLiveInsituManager.h

Signals

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Slots

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ pqLiveInsituManager()

Member Function Documentation

◆ instance()

◆ linkProxy() [1/2]

◆ linkProxy() [2/2]

◆ isInsituServer()

◆ isInsitu()

◆ isWriterParametersProxy()

◆ pipelineSource()

◆ time() [1/2]

◆ connectionInitiated

◆ timeUpdated

◆ breakpointAdded

◆ breakpointRemoved

◆ breakpointHit

◆ selectedInsituServer()

◆ isDisplayServer()

◆ managerFromDisplay()

◆ managerFromInsitu()

◆ connect()

◆ breakpointTime()

◆ breakpointTimeStep()

◆ setBreakpoint() [1/2]

◆ setBreakpoint() [2/2]

◆ removeBreakpoint()

◆ hasBreakpoint()

◆ time() [2/2]

◆ timeStep()

◆ waitTimestep()

◆ waitBreakpointHit()

◆ closeConnection()

◆ onCatalystDisconnected

◆ onBreakpointHit

◆ onSourceAdded

◆ onDataUpdated

◆ isTimeBreakpointHit()

◆ isTimeStepBreakpointHit()

Member Data Documentation

◆ INVALID_TIME

◆ INVALID_TIME_STEP

◆ BreakpointTime

◆ Time

◆ BreakpointTimeStep

◆ TimeStep