manager for data-delivery. More...

#include <vtkPVDataDeliveryManager.h>

Inheritance diagram for vtkPVDataDeliveryManager:

[legend]

Collaboration diagram for vtkPVDataDeliveryManager:

[legend]

Classes
class	vtkInternals

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

int	GetSynchronizationMagicNumber ()
	Returned a hash number that can be used to verify that both client and server side are in synch representation wise for delivery. More...

vtkDataObject *	GetPiece (vtkPVDataRepresentation *repr, bool low_res, int port=0)
	Returns the local data object set by calling `SetPiece` (or from the cache). More...

vtkDataObject *	GetDeliveredPiece (vtkPVDataRepresentation *repr, bool low_res, int port=0)
	Returns the data object post-delivery. More...

void	ClearCache (vtkPVDataRepresentation *repr)
	Clear all cached data objects for the given representation. More...

unsigned long	GetVisibleDataSize (bool low_res)
	Returns the size for all visible geometry. More...

bool	NeedsDelivery (vtkMTimeType timestamp, std::vector< unsigned int > &keys_to_deliver, bool use_lod)
	Internal method used to determine the list of representations that need their geometry delivered. More...

void	Deliver (int use_low_res, unsigned int size, unsigned int *keys)
	Triggers delivery for the geometries of indicated representations. More...

virtual int	GetDeliveredDataKey (bool low_res) const
	Views that support changing of which ranks do the rendering at runtime based on things like data sizes, etc. More...


void	SetView (vtkPVView *)
	Get/Set the render-view. More...

vtkPVView *	GetView () const
	Get/Set the render-view. More...


void	RegisterRepresentation (vtkPVDataRepresentation *repr)
	View uses these methods to register a representation with the storage. More...

void	UnRegisterRepresentation (vtkPVDataRepresentation *)
	View uses these methods to register a representation with the storage. More...

vtkPVDataRepresentation *	GetRepresentation (unsigned int)
	View uses these methods to register a representation with the storage. More...


void	SetPiece (vtkPVDataRepresentation repr, vtkDataObject data, bool low_res, unsigned long trueSize=0, int port=0)
	Representations (indirectly via vtkPVRenderView::SetPiece()) call this method to register the geometry type they are rendering. More...


bool	HasPiece (vtkPVDataRepresentation *repr, bool low_res=false, int port=0)


vtkAlgorithmOutput *	GetProducer (vtkPVDataRepresentation *, bool low_res, int port=0)
	Provides access to the producer port for the geometry of a registered representation. More...


vtkInformation *	GetPieceInformation (vtkPVDataRepresentation *repr, bool low_res, int port=0)
	Set/Get meta-data container for the specific piece. More...


int	GetNumberOfPorts (vtkPVDataRepresentation *repr)
	Returns number of known port for the representation. More...

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 int	IsTypeOf (const char *type)

static vtkPVDataDeliveryManager *	SafeDownCast (vtkObject *o)

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 Member Functions
	vtkPVDataDeliveryManager ()

	~vtkPVDataDeliveryManager () override

double	GetCacheKey (vtkPVDataRepresentation *repr) const

virtual void	MoveData (vtkPVDataRepresentation *repr, bool low_res, int port)=0
	This method is called to request that the subclass do appropriate transfer for the indicated representation. More...

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
vtkInternals *	Internals

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

manager for data-delivery.

ParaView's multi-configuration / multi-process modes pose a challenge for views. At runtime, the current configuration will determine which processes have what parts of data and which processes are expected to "render" that data. While views and their representations may add certain qualifiers to this statement, generally speaking, all views have to support taking the data from the data-processing nodes and delivering it to the rendering nodes. This is where vtkPVDataDeliveryManager comes in play. It helps views (viz. vtkPVView subclasses) move the data.

Definition at line 35 of file vtkPVDataDeliveryManager.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkPVDataDeliveryManager::Superclass

Definition at line 38 of file vtkPVDataDeliveryManager.h.

Constructor & Destructor Documentation

◆ vtkPVDataDeliveryManager()

vtkPVDataDeliveryManager::vtkPVDataDeliveryManager ( )

protected

◆ ~vtkPVDataDeliveryManager()

vtkPVDataDeliveryManager::~vtkPVDataDeliveryManager ( )

overrideprotected

Member Function Documentation

◆ GetClassName()

virtual const char* vtkPVDataDeliveryManager::GetClassName ( )

virtual

Reimplemented in vtkPVRenderViewDataDeliveryManager, and vtkPVContextViewDataDeliveryManager.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkObjectBase.

Reimplemented in vtkPVRenderViewDataDeliveryManager, and vtkPVContextViewDataDeliveryManager.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

Reimplemented in vtkPVRenderViewDataDeliveryManager.

◆ SetView()

void vtkPVDataDeliveryManager::SetView ( vtkPVView * )

Get/Set the render-view.

The view is not reference counted.

◆ GetView()

vtkPVView* vtkPVDataDeliveryManager::GetView ( ) const

Get/Set the render-view.

The view is not reference counted.

◆ GetSynchronizationMagicNumber()

int vtkPVDataDeliveryManager::GetSynchronizationMagicNumber ( )

Returned a hash number that can be used to verify that both client and server side are in synch representation wise for delivery.

◆ RegisterRepresentation()

void vtkPVDataDeliveryManager::RegisterRepresentation ( vtkPVDataRepresentation * repr )

View uses these methods to register a representation with the storage.

This makes it possible for representations to communicate with the storage directly using a self pointer, while enables views on different processes to communicate information about representations using their unique ids.

◆ UnRegisterRepresentation()

void vtkPVDataDeliveryManager::UnRegisterRepresentation ( vtkPVDataRepresentation * )

View uses these methods to register a representation with the storage.

This makes it possible for representations to communicate with the storage directly using a self pointer, while enables views on different processes to communicate information about representations using their unique ids.

◆ GetRepresentation()

vtkPVDataRepresentation* vtkPVDataDeliveryManager::GetRepresentation ( unsigned int )

View uses these methods to register a representation with the storage.

This makes it possible for representations to communicate with the storage directly using a self pointer, while enables views on different processes to communicate information about representations using their unique ids.

◆ SetPiece()

void vtkPVDataDeliveryManager::SetPiece	(	vtkPVDataRepresentation *	repr,
		vtkDataObject *	data,
		bool	low_res,
		unsigned long	trueSize = `0`,
		int	port = `0`
	)

Representations (indirectly via vtkPVRenderView::SetPiece()) call this method to register the geometry type they are rendering.

Every representation that requires delivering of any geometry must register with the vtkPVDataDeliveryManager and never manage the delivery on its own.

◆ HasPiece()

bool vtkPVDataDeliveryManager::HasPiece	(	vtkPVDataRepresentation *	repr,
		bool	low_res = `false`,
		int	port = `0`
	)

◆ GetPiece()

vtkDataObject* vtkPVDataDeliveryManager::GetPiece	(	vtkPVDataRepresentation *	repr,
		bool	low_res,
		int	port = `0`
	)

Returns the local data object set by calling SetPiece (or from the cache).

This is the data object pre-delivery.

◆ GetDeliveredPiece()

vtkDataObject* vtkPVDataDeliveryManager::GetDeliveredPiece	(	vtkPVDataRepresentation *	repr,
		bool	low_res,
		int	port = `0`
	)

Returns the data object post-delivery.

◆ ClearCache()

void vtkPVDataDeliveryManager::ClearCache ( vtkPVDataRepresentation * repr )

Clear all cached data objects for the given representation.

◆ GetProducer()

vtkAlgorithmOutput* vtkPVDataDeliveryManager::GetProducer	(	vtkPVDataRepresentation *	,
		bool	low_res,
		int	port = `0`
	)

Provides access to the producer port for the geometry of a registered representation.

Representations use these methods (indirectly via vtkPVRenderView::GetPieceProducer() and GetPieceProducerLOD()) to obtain the geometry producer for the geometry to be rendered.

◆ GetPieceInformation()

vtkInformation* vtkPVDataDeliveryManager::GetPieceInformation	(	vtkPVDataRepresentation *	repr,
		bool	low_res,
		int	port = `0`
	)

Set/Get meta-data container for the specific piece.

Views can use it to store arbitrary metadata for each piece.

◆ GetNumberOfPorts()

int vtkPVDataDeliveryManager::GetNumberOfPorts ( vtkPVDataRepresentation * repr )

Returns number of known port for the representation.

◆ GetVisibleDataSize()

unsigned long vtkPVDataDeliveryManager::GetVisibleDataSize ( bool low_res )

Returns the size for all visible geometry.

If low_res is true, and low-res data is not available for a particular representation, then it's high-res data size will be used assuming that the representation is going to render the high-res geometry for low-res rendering as well.

◆ NeedsDelivery()

bool vtkPVDataDeliveryManager::NeedsDelivery	(	vtkMTimeType	timestamp,
		std::vector< unsigned int > &	keys_to_deliver,
		bool	use_lod
	)

Internal method used to determine the list of representations that need their geometry delivered.

This is done on the "client" side, with the client decide what geometries it needs and then requests those from the server-sides using Deliver().

◆ Deliver()

void vtkPVDataDeliveryManager::Deliver	(	int	use_low_res,
		unsigned int	size,
		unsigned int *	keys
	)

Triggers delivery for the geometries of indicated representations.

◆ GetDeliveredDataKey()

virtual int vtkPVDataDeliveryManager::GetDeliveredDataKey ( bool low_res ) const

inlinevirtual

Views that support changing of which ranks do the rendering at runtime based on things like data sizes, etc.

may override this method to provide a unique key for each different mode. This makes it possible to keep delivered data object for each mode separate and thus avoid transfers if the mode is changed on the fly.

Default implementation simply returns 0.

Reimplemented in vtkPVRenderViewDataDeliveryManager.

Definition at line 154 of file vtkPVDataDeliveryManager.h.

◆ GetCacheKey()

double vtkPVDataDeliveryManager::GetCacheKey ( vtkPVDataRepresentation * repr ) const

protected

◆ MoveData()

virtual void vtkPVDataDeliveryManager::MoveData	(	vtkPVDataRepresentation *	repr,
		bool	low_res,
		int	port
	)

protectedpure virtual

This method is called to request that the subclass do appropriate transfer for the indicated representation.

Implemented in vtkPVRenderViewDataDeliveryManager, and vtkPVContextViewDataDeliveryManager.

Member Data Documentation

◆ Internals

vtkInternals* vtkPVDataDeliveryManager::Internals

protected

Definition at line 172 of file vtkPVDataDeliveryManager.h.

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

/builds/gitlab-kitware-sciviz-ci/Remoting/Views/vtkPVDataDeliveryManager.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkPVDataDeliveryManager()

◆ ~vtkPVDataDeliveryManager()

Member Function Documentation

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ SetView()

◆ GetView()

◆ GetSynchronizationMagicNumber()

◆ RegisterRepresentation()

◆ UnRegisterRepresentation()

◆ GetRepresentation()

◆ SetPiece()

◆ HasPiece()

◆ GetPiece()

◆ GetDeliveredPiece()

◆ ClearCache()

◆ GetProducer()

◆ GetPieceInformation()

◆ GetNumberOfPorts()

◆ GetVisibleDataSize()

◆ NeedsDelivery()

◆ Deliver()

◆ GetDeliveredDataKey()

◆ GetCacheKey()

◆ MoveData()

Member Data Documentation

◆ Internals