vtkPVDataMover Class Reference

helper to move data between ParaView processes. More...

#include <vtkPVDataMover.h>

Inheritance diagram for vtkPVDataMover:

Collaboration diagram for vtkPVDataMover:

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
bool	Execute ()
	Once the helper has been setup, use this method to fetch the data. More...
void	SetProducer (vtkAlgorithm *producer)
	Get/Set the data-producer to fetch data from. More...
virtual vtkAlgorithm *	GetProducer ()
	Get/Set the data-producer to fetch data from. More...
virtual void	SetPortNumber (int)
	Get/Set the output-port number to use to fetch data. More...
virtual int	GetPortNumber ()
	Get/Set the output-port number to use to fetch data. More...
virtual void	SetGatherOnAllRanks (bool)
	In symmetric batch mode, set this to true to indicate that the data must be cloned on all ranks. More...
virtual bool	GetGatherOnAllRanks ()
	In symmetric batch mode, set this to true to indicate that the data must be cloned on all ranks. More...
virtual void	SetSkipEmptyDataSets (bool)
	When set to true (default is false), skips moving empty datasets. More...
virtual bool	GetSkipEmptyDataSets ()
	When set to true (default is false), skips moving empty datasets. More...
virtual void	SkipEmptyDataSetsOn ()
	When set to true (default is false), skips moving empty datasets. More...
virtual void	SkipEmptyDataSetsOff ()
	When set to true (default is false), skips moving empty datasets. More...
void	AddSourceRank (int rank)
	API to select source ranks. More...
void	ClearAllSourceRanks ()
	API to select source ranks. More...
void	SetSourceRanks (const std::vector< int > &ranks)
	API to select source ranks. More...
const std::vector< int > &	GetSourceRanks () const
	API to select source ranks. More...
unsigned int	GetNumberOfDataSets () const
int	GetDataSetRank (unsigned int index) const
vtkDataObject *	GetDataSetAtIndex (unsigned int index) const
vtkDataObject *	GetDataSetFromRank (int rank) const
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 vtkPVDataMover *	New ()
static int	IsTypeOf (const char *type)
static vtkPVDataMover *	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
	vtkPVDataMover ()
	~vtkPVDataMover () 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 &)

Additional Inherited Members
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Detailed Description

helper to move data between ParaView processes.

vtkPVDataMover is used to transfer data between ParView processes without any transformations. This is primarily used by simple.FetchData to transfer data to the client.

Definition at line 24 of file vtkPVDataMover.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkPVDataMover::Superclass

Definition at line 28 of file vtkPVDataMover.h.

Constructor & Destructor Documentation

vtkPVDataMover()

vtkPVDataMover::vtkPVDataMover ( )

protected

~vtkPVDataMover()

vtkPVDataMover::~vtkPVDataMover ( )

overrideprotected

Member Function Documentation

New()

static vtkPVDataMover* vtkPVDataMover::New ( )

static

GetClassName()

virtual const char* vtkPVDataMover::GetClassName ( )

virtual

IsTypeOf()

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

static

IsA()

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

virtual

Reimplemented from vtkObjectBase.

SafeDownCast()

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

static

PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

SetProducer()

void vtkPVDataMover::SetProducer

(

vtkAlgorithm *

producer

)

Get/Set the data-producer to fetch data from.

GetProducer()

virtual vtkAlgorithm* vtkPVDataMover::GetProducer ( )

virtual

Get/Set the data-producer to fetch data from.

SetPortNumber()

virtual void vtkPVDataMover::SetPortNumber ( int  )

virtual

Get/Set the output-port number to use to fetch data.

Defaults to 0.

GetPortNumber()

virtual int vtkPVDataMover::GetPortNumber ( )

virtual

Get/Set the output-port number to use to fetch data.

Defaults to 0.

SetGatherOnAllRanks()

virtual void vtkPVDataMover::SetGatherOnAllRanks ( bool  )

virtual

In symmetric batch mode, set this to true to indicate that the data must be cloned on all ranks.

Otherwise, the data is only generated on the root node. Defaults to false.

This has no effect in non-symmetric MPI mode and is simply ignored.

GetGatherOnAllRanks()

virtual bool vtkPVDataMover::GetGatherOnAllRanks ( )

virtual

In symmetric batch mode, set this to true to indicate that the data must be cloned on all ranks.

Otherwise, the data is only generated on the root node. Defaults to false.

This has no effect in non-symmetric MPI mode and is simply ignored.

SetSkipEmptyDataSets()

virtual void vtkPVDataMover::SetSkipEmptyDataSets ( bool  )

virtual

When set to true (default is false), skips moving empty datasets.

A dataset is treated as empty if it has no cells, points, etc. i.e. vtkDataObject::GetNumberOfElements for all types returns 0.

GetSkipEmptyDataSets()

virtual bool vtkPVDataMover::GetSkipEmptyDataSets ( )

virtual

When set to true (default is false), skips moving empty datasets.

A dataset is treated as empty if it has no cells, points, etc. i.e. vtkDataObject::GetNumberOfElements for all types returns 0.

SkipEmptyDataSetsOn()

virtual void vtkPVDataMover::SkipEmptyDataSetsOn ( )

virtual

When set to true (default is false), skips moving empty datasets.

A dataset is treated as empty if it has no cells, points, etc. i.e. vtkDataObject::GetNumberOfElements for all types returns 0.

SkipEmptyDataSetsOff()

virtual void vtkPVDataMover::SkipEmptyDataSetsOff ( )

virtual

When set to true (default is false), skips moving empty datasets.

A dataset is treated as empty if it has no cells, points, etc. i.e. vtkDataObject::GetNumberOfElements for all types returns 0.

AddSourceRank()

void vtkPVDataMover::AddSourceRank

(

int

rank

)

API to select source ranks.

This allows users to limit fetching data from only certain ranks as listed. If none are provided, default, data from all ranks is fetched. Otherwise, data only from the ranks listed is fetched.

ClearAllSourceRanks()

void vtkPVDataMover::ClearAllSourceRanks

(

)

API to select source ranks.

This allows users to limit fetching data from only certain ranks as listed. If none are provided, default, data from all ranks is fetched. Otherwise, data only from the ranks listed is fetched.

SetSourceRanks()

void vtkPVDataMover::SetSourceRanks

(

const std::vector< int > &

ranks

)

API to select source ranks.

This allows users to limit fetching data from only certain ranks as listed. If none are provided, default, data from all ranks is fetched. Otherwise, data only from the ranks listed is fetched.

GetSourceRanks()

const std::vector<int>& vtkPVDataMover::GetSourceRanks ( ) const

inline

API to select source ranks.

This allows users to limit fetching data from only certain ranks as listed. If none are provided, default, data from all ranks is fetched. Otherwise, data only from the ranks listed is fetched.

Definition at line 81 of file vtkPVDataMover.h.

Execute()

bool vtkPVDataMover::Execute

(

)

Once the helper has been setup, use this method to fetch the data.

GetNumberOfDataSets()

unsigned int vtkPVDataMover::GetNumberOfDataSets

(

)

const

GetDataSetRank()

int vtkPVDataMover::GetDataSetRank

(

unsigned int

index

)

const

GetDataSetAtIndex()

vtkDataObject* vtkPVDataMover::GetDataSetAtIndex

(

unsigned int

index

)

const

GetDataSetFromRank()

vtkDataObject* vtkPVDataMover::GetDataSetFromRank

(

int

rank

)

const

---

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

• /builds/gitlab-kitware-sciviz-ci/Remoting/ServerManager/vtkPVDataMover.h