collection of assorted helper routines dealing with communication. More...

#include <vtkMultiProcessControllerHelper.h>

Inheritance diagram for vtkMultiProcessControllerHelper:

Collaboration diagram for vtkMultiProcessControllerHelper:

[legend]

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

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

static int	IsTypeOf (const char *type)

static vtkMultiProcessControllerHelper *	SafeDownCast (vtkObject *o)

static int	ReduceToAll (vtkMultiProcessController controller, vtkMultiProcessStream &data, void(operation)(vtkMultiProcessStream &A, vtkMultiProcessStream &B), int tag)
	Reduce the stream to all processes calling the (*operation) for reduction. More...

static vtkDataObject *	MergePieces (vtkDataObject **pieces, unsigned int num_pieces)
	Utility method to merge pieces received from several processes. More...

static bool	MergePieces (std::vector< vtkSmartPointer< vtkDataObject >> &pieces, vtkDataObject *result)
	Overload where the merged pieces are combined into result. 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 Member Functions
	vtkMultiProcessControllerHelper ()

	~vtkMultiProcessControllerHelper () 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

collection of assorted helper routines dealing with communication.

vtkMultiProcessControllerHelper is collection of assorted helper routines dealing with communication.

Definition at line 25 of file vtkMultiProcessControllerHelper.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkMultiProcessControllerHelper::Superclass

Definition at line 29 of file vtkMultiProcessControllerHelper.h.

Constructor & Destructor Documentation

◆ vtkMultiProcessControllerHelper()

vtkMultiProcessControllerHelper::vtkMultiProcessControllerHelper ( )

protected

◆ ~vtkMultiProcessControllerHelper()

vtkMultiProcessControllerHelper::~vtkMultiProcessControllerHelper ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkMultiProcessControllerHelper* vtkMultiProcessControllerHelper::New ( )

static

◆ GetClassName()

virtual const char* vtkMultiProcessControllerHelper::GetClassName ( )

virtual

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

◆ ReduceToAll()

static int vtkMultiProcessControllerHelper::ReduceToAll	(	vtkMultiProcessController *	controller,
		vtkMultiProcessStream &	data,
		void(*)(vtkMultiProcessStream &A, vtkMultiProcessStream &B)	operation,
		int	tag
	)

static

Reduce the stream to all processes calling the (*operation) for reduction.

The operation is assumed to be commutative.

◆ MergePieces() [1/2]

static vtkDataObject* vtkMultiProcessControllerHelper::MergePieces	(	vtkDataObject **	pieces,
		unsigned int	num_pieces
	)

static

Utility method to merge pieces received from several processes.

It does not handle all data types, and hence not meant for non-paraview specific use. Returns a new instance of data object containing the merged result on success, else returns nullptr. The caller is expected to release the memory from the returned data-object.

◆ MergePieces() [2/2]

static bool vtkMultiProcessControllerHelper::MergePieces	(	std::vector< vtkSmartPointer< vtkDataObject >> &	pieces,
		vtkDataObject *	result
	)

static

Overload where the merged pieces are combined into result.

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

/builds/gitlab-kitware-sciviz-ci/VTKExtensions/Core/vtkMultiProcessControllerHelper.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkMultiProcessControllerHelper()

◆ ~vtkMultiProcessControllerHelper()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ ReduceToAll()

◆ MergePieces() [1/2]

◆ MergePieces() [2/2]