miscellaneous collection of proxy-manager utilities More...

#include <vtkSMProxyManagerUtilities.h>

Inheritance diagram for vtkSMProxyManagerUtilities:

Collaboration diagram for vtkSMProxyManagerUtilities:

[legend]

Public Types
typedef vtkSMObject	Superclass

Public Types inherited from vtkSMObject
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override


void	SetProxyManager (vtkSMSessionProxyManager *pxm)
	Get/Set the proxy manager to use. More...

virtual vtkSMSessionProxyManager *	GetProxyManager ()
	Get/Set the proxy manager to use. More...


std::set< vtkSMProxy * >	GetProxiesWithAnnotations (const std::map< std::string, std::string > &annotations, bool match_all)
	Returns a collection of proxies that have the specified annotations. More...

std::set< vtkSMProxy * >	GetProxiesWithAllAnnotations (const std::map< std::string, std::string > &annotations)
	Returns a collection of proxies that have the specified annotations. More...

std::set< vtkSMProxy * >	GetProxiesWithAnyAnnotations (const std::map< std::string, std::string > &annotations)
	Returns a collection of proxies that have the specified annotations. More...


std::set< vtkSMProxy * >	CollectHelpersAndRelatedProxies (const std::set< vtkSMProxy *> &proxies)
	Given a set of proxies, scans for all "dependent" proxies and returns a set that includes the proxies together with all the dependent proxies. 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 vtkSMProxyManagerUtilities *	New ()

static int	IsTypeOf (const char *type)

static vtkSMProxyManagerUtilities *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkSMObject
static vtkSMObject *	New ()

static int	IsTypeOf (const char *type)

static vtkSMObject *	SafeDownCast (vtkObject *o)

static std::string	CreatePrettyLabel (const std::string &name)
	Return a well-formated label using provided name by adding spaces between lower cases and upper cases: 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
	vtkSMProxyManagerUtilities ()

	~vtkSMProxyManagerUtilities () override

Protected Member Functions inherited from vtkSMObject
	vtkSMObject ()

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

miscellaneous collection of proxy-manager utilities

vtkSMProxyManagerUtilities provides collection of APIs useful with dealing with proxies registered with the proxy manager.

See also: vtkSMSessionProxyManager

Definition at line 27 of file vtkSMProxyManagerUtilities.h.

Member Typedef Documentation

◆ Superclass

typedef vtkSMObject vtkSMProxyManagerUtilities::Superclass

Definition at line 31 of file vtkSMProxyManagerUtilities.h.

Constructor & Destructor Documentation

◆ vtkSMProxyManagerUtilities()

vtkSMProxyManagerUtilities::vtkSMProxyManagerUtilities ( )

protected

◆ ~vtkSMProxyManagerUtilities()

vtkSMProxyManagerUtilities::~vtkSMProxyManagerUtilities ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkSMProxyManagerUtilities* vtkSMProxyManagerUtilities::New ( )

static

◆ GetClassName()

virtual const char* vtkSMProxyManagerUtilities::GetClassName ( )

virtual

Reimplemented from vtkSMObject.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkSMObject.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkSMObject.

◆ SetProxyManager()

void vtkSMProxyManagerUtilities::SetProxyManager ( vtkSMSessionProxyManager * pxm )

Get/Set the proxy manager to use.

◆ GetProxyManager()

virtual vtkSMSessionProxyManager* vtkSMProxyManagerUtilities::GetProxyManager ( )

virtual

Get/Set the proxy manager to use.

◆ GetProxiesWithAnnotations()

std::set<vtkSMProxy*> vtkSMProxyManagerUtilities::GetProxiesWithAnnotations	(	const std::map< std::string, std::string > &	annotations,
		bool	match_all
	)

Returns a collection of proxies that have the specified annotations.

If multiple annotations are specified, the match_all flag it used to determine if all the annotations are to be matched or match with any of the annotations is sufficient. Alternatively, use GetProxiesWithAllAnnotations or GetProxiesWithAnyAnnotations.

◆ GetProxiesWithAllAnnotations()

std::set<vtkSMProxy*> vtkSMProxyManagerUtilities::GetProxiesWithAllAnnotations ( const std::map< std::string, std::string > & annotations )

inline

Returns a collection of proxies that have the specified annotations.

If multiple annotations are specified, the match_all flag it used to determine if all the annotations are to be matched or match with any of the annotations is sufficient. Alternatively, use GetProxiesWithAllAnnotations or GetProxiesWithAnyAnnotations.

Definition at line 54 of file vtkSMProxyManagerUtilities.h.

◆ GetProxiesWithAnyAnnotations()

std::set<vtkSMProxy*> vtkSMProxyManagerUtilities::GetProxiesWithAnyAnnotations ( const std::map< std::string, std::string > & annotations )

inline

Returns a collection of proxies that have the specified annotations.

If multiple annotations are specified, the match_all flag it used to determine if all the annotations are to be matched or match with any of the annotations is sufficient. Alternatively, use GetProxiesWithAllAnnotations or GetProxiesWithAnyAnnotations.

Definition at line 59 of file vtkSMProxyManagerUtilities.h.

◆ CollectHelpersAndRelatedProxies()

std::set<vtkSMProxy*> vtkSMProxyManagerUtilities::CollectHelpersAndRelatedProxies ( const std::set< vtkSMProxy *> & proxies )

Given a set of proxies, scans for all "dependent" proxies and returns a set that includes the proxies together with all the dependent proxies.

These proxies are proxies that are used as helper proxies or proxies set on proxy properties.

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

/builds/gitlab-kitware-sciviz-ci/Remoting/ServerManager/vtkSMProxyManagerUtilities.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

◆ vtkSMProxyManagerUtilities()

◆ ~vtkSMProxyManagerUtilities()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ SetProxyManager()

◆ GetProxyManager()

◆ GetProxiesWithAnnotations()

◆ GetProxiesWithAllAnnotations()

◆ GetProxiesWithAnyAnnotations()

◆ CollectHelpersAndRelatedProxies()