pqLiveSourceItem Class Reference

This component is used by pqLiveSourceManager to interact with the underlying proxy of the LiveSource. More...

#include <pqLiveSourceItem.h>

Inherits QObject.

Signals
void	refreshSource ()
	Triggered when the internal refresh timer timeout. More...
void	onInformationUpdated ()
	Triggered when the proxy information are updated. More...
void	stateChanged (bool isPaused)
	Triggered when the live source is paused / resumed. More...

Public Member Functions
	pqLiveSourceItem (pqPipelineSource *src, vtkPVXMLElement *liveHints, QObject *parent=nullptr)
	~pqLiveSourceItem () override
void	update (double time)
	Calls GetNeedsUpdate on the associated vtkAlgorithm proxy. More...
bool	isPaused ()
	Returns true if is currently paused. More...
double *	getTimestampRange ()
	If the LiveSource is an EmulatedTimeAlgorithm, return the first and last proxy timestamp, else return nullptr. More...
bool	isEmulatedTimeAlgorithm ()
	Return true is the LiveSource XML tag has a emulated_time attribute to true. More...
vtkTypeUInt32	getSourceId ()
	Get underlying proxy global ID. More...
void	pause ()
	Pause / Resume live updates for this source. More...
void	resume ()
	Pause / Resume live updates for this source. More...

Detailed Description

This component is used by pqLiveSourceManager to interact with the underlying proxy of the LiveSource.

Each pqLiveSourceItem have a pqTimer that periodically emit the refreshSource signal, which is monitored by pqLiveSourceManager. Upon receiving this signal, it triggers the update function, which in turn invokes GetNeedsUpdate on the proxy.

If the LiveSource is an emulated time algorithm (with the emulated_time XML attribute), the pqLiveSourceManager will call the update function with a synchronized "real" time among all live sources.

See also

pqLiveSourceManager pqLiveSourceBehavior vtkEmulatedTimeAlgorithm

Definition at line 32 of file pqLiveSourceItem.h.

Constructor & Destructor Documentation

pqLiveSourceItem()

pqLiveSourceItem::pqLiveSourceItem	(	pqPipelineSource *	src,
		vtkPVXMLElement *	liveHints,
		QObject *	parent = nullptr
	)

~pqLiveSourceItem()

pqLiveSourceItem::~pqLiveSourceItem ( )

override

Member Function Documentation

update()

void pqLiveSourceItem::update

(

double

time

)

Calls GetNeedsUpdate on the associated vtkAlgorithm proxy.

If the LiveSource is a EmulatedTimeAlgorithm send time as a parameter.

pause()

void pqLiveSourceItem::pause

(

)

Pause / Resume live updates for this source.

resume()

void pqLiveSourceItem::resume

(

)

Pause / Resume live updates for this source.

isPaused()

bool pqLiveSourceItem::isPaused

(

)

Returns true if is currently paused.

getTimestampRange()

double* pqLiveSourceItem::getTimestampRange

(

)

If the LiveSource is an EmulatedTimeAlgorithm, return the first and last proxy timestamp, else return nullptr.

isEmulatedTimeAlgorithm()

bool pqLiveSourceItem::isEmulatedTimeAlgorithm

(

)

Return true is the LiveSource XML tag has a emulated_time attribute to true.

getSourceId()

vtkTypeUInt32 pqLiveSourceItem::getSourceId

(

)

Get underlying proxy global ID.

refreshSource

void pqLiveSourceItem::refreshSource ( )

signal

Triggered when the internal refresh timer timeout.

onInformationUpdated

void pqLiveSourceItem::onInformationUpdated ( )

signal

Triggered when the proxy information are updated.

(Its time range could have been updated as well)

stateChanged

void pqLiveSourceItem::stateChanged ( bool  isPaused )

signal

Triggered when the live source is paused / resumed.

---

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

• /builds/gitlab-kitware-sciviz-ci/Qt/Components/pqLiveSourceItem.h