vtkSMProxyDefinitionManager is a remote-object that represents the vtkSIProxyDefinitionManager instance on all the processes. More...

#include <vtkSMProxyDefinitionManager.h>

Inheritance diagram for vtkSMProxyDefinitionManager:

[legend]

Collaboration diagram for vtkSMProxyDefinitionManager:

[legend]

Public Types
enum	Events { ProxyDefinitionsUpdated = vtkSIProxyDefinitionManager::ProxyDefinitionsUpdated, CompoundProxyDefinitionsUpdated = vtkSIProxyDefinitionManager::CompoundProxyDefinitionsUpdated }

enum	{ ALL_DEFINITIONS = vtkSIProxyDefinitionManager::ALL_DEFINITIONS, CORE_DEFINITIONS = vtkSIProxyDefinitionManager::CORE_DEFINITIONS, CUSTOM_DEFINITIONS = vtkSIProxyDefinitionManager::CUSTOM_DEFINITIONS }

typedef vtkSMRemoteObject	Superclass

Public Types inherited from vtkSMRemoteObject
typedef vtkSMSessionObject	Superclass

Public Types inherited from vtkSMSessionObject
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	SynchronizeDefinitions ()
	Synchronizes the client-side definitions using the server-side definitions, if applicable. More...

void	SetSession (vtkSMSession *) override
	Overridden call SynchronizeDefinitions() when the session changes. More...

vtkPVXMLElement *	GetCollapsedProxyDefinition (const char group, const char name, const char *subProxyName, bool throwError)
	Returns the same thing as GetProxyDefinition in a flatten manner. More...

bool	HasDefinition (const char groupName, const char proxyName)
	Return true if the XML Definition was found. More...

void	SaveCustomProxyDefinitions (vtkPVXMLElement *root)
	Save registered custom proxy definitions. More...

void	LoadState (const vtkSMMessage msg, vtkSMProxyLocator locator) override
	This method is used to initialise the object to the given state If the definitionOnly Flag is set to True the proxy won't load the properties values and just setup the new proxy hierarchy with all subproxy globalID set. More...


vtkPVXMLElement *	GetProxyDefinition (const char group, const char name, bool throwError)
	Returns a registered proxy definition or return a nullptr otherwise. More...

vtkPVXMLElement *	GetProxyDefinition (const char group, const char name)
	Returns a registered proxy definition or return a nullptr otherwise. More...


VTK_NEWINSTANCE vtkPVProxyDefinitionIterator *	NewIterator ()
	Return a NEW instance of vtkPVProxyDefinitionIterator configured to get through all the definition available for the requested scope. More...

VTK_NEWINSTANCE vtkPVProxyDefinitionIterator *	NewIterator (int scope)
	Return a NEW instance of vtkPVProxyDefinitionIterator configured to get through all the definition available for the requested scope. More...


vtkPVProxyDefinitionIterator *	NewSingleGroupIterator (const char *groupName)
	Return a new configured iterator for traversing a set of proxy definition for only one GroupName. More...

vtkPVProxyDefinitionIterator *	NewSingleGroupIterator (const char *groupName, int scope)
	Return a new configured iterator for traversing a set of proxy definition for only one GroupName. More...


void	AddCustomProxyDefinition (const char group, const char name, vtkPVXMLElement *top)
	Add/Remove/Clear custom proxy definitions. More...

void	RemoveCustomProxyDefinition (const char group, const char name)
	Add/Remove/Clear custom proxy definitions. More...

void	ClearCustomProxyDefinitions ()
	Add/Remove/Clear custom proxy definitions. More...


void	LoadCustomProxyDefinitions (vtkPVXMLElement *root)
	Load custom proxy definitions and register them. More...

void	LoadCustomProxyDefinitionsFromString (const char *xmlContent)
	Load custom proxy definitions and register them. More...


bool	LoadConfigurationXML (vtkPVXMLElement *root)
	Loads server-manager configuration xml. More...

bool	LoadConfigurationXMLFromString (const char *xmlContent)
	Loads server-manager configuration xml. More...

Public Member Functions inherited from vtkSMRemoteObject
void	PrintSelf (ostream &os, vtkIndent indent) override

void	SetSession (vtkSMSession *) override
	Override the SetSession so if the object already have an ID we automatically register it to the associated session. More...

bool	HasGlobalID ()
	Allow the user to test if the RemoteObject has already a GlobalID without assigning a new one to it. More...

virtual const vtkSMMessage *	GetFullState ()
	This method return the full object state that can be used to create that object from scratch. More...

virtual void	EnableLocalPushOnly ()
	Allow to switch off any push of state change to the server for that particular object. More...

virtual void	DisableLocalPushOnly ()
	Enable the given remote object to communicate its state normally to the server location. More...

virtual bool	IsLocalPushOnly ()
	Let the session be aware that even if the Location is client only, the message should not be send to the server for a general broadcast. More...

virtual void	SetLocation (vtkTypeUInt32)
	Get/Set the location where the underlying VTK-objects are created. More...

virtual vtkTypeUInt32	GetLocation ()
	Get/Set the location where the underlying VTK-objects are created. More...

virtual vtkTypeUInt32	GetGlobalID ()
	Get the global unique id for this object. More...

const char *	GetGlobalIDAsString ()
	Get the global unique id for this object. More...

virtual void	PrototypeOn ()
	Allow user to set the remote object to be discard for Undo/Redo action. More...

virtual void	PrototypeOff ()
	Allow user to set the remote object to be discard for Undo/Redo action. More...

bool	IsPrototype ()
	Allow user to set the remote object to be discard for Undo/Redo action. More...

virtual void	SetPrototype (bool)
	Allow user to set the remote object to be discard for Undo/Redo action. More...

Public Member Functions inherited from vtkSMSessionObject
void	PrintSelf (ostream &os, vtkIndent indent) override

virtual vtkSMSessionProxyManager *	GetSessionProxyManager ()
	Return the corresponding ProxyManager if any. More...

virtual vtkSMSession *	GetSession ()
	Get/Set the session on wihch this object exists. 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 vtkSMProxyDefinitionManager *	New ()

static int	IsTypeOf (const char *type)

static vtkSMProxyDefinitionManager *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkSMRemoteObject
static int	IsTypeOf (const char *type)

static vtkSMRemoteObject *	SafeDownCast (vtkObject *o)

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

static int	IsTypeOf (const char *type)

static vtkSMSessionObject *	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
	vtkSMProxyDefinitionManager ()

	~vtkSMProxyDefinitionManager () override

Protected Member Functions inherited from vtkSMRemoteObject
	vtkSMRemoteObject ()
	Default constructor. More...

	~vtkSMRemoteObject () override
	Destructor. More...

void	PushState (vtkSMMessage *msg)
	Subclasses can call this method to send a message to its state object on the server processes specified. More...

bool	PullState (vtkSMMessage *msg)
	Subclasses can call this method to pull the state from the state-object on the server processes specified. More...

void	SetGlobalID (vtkTypeUInt32 guid)
	Set the GlobalUniqueId. More...

vtkTypeUInt32	GetFilteredLocation ()

Protected Member Functions inherited from vtkSMSessionObject
	vtkSMSessionObject ()

	~vtkSMSessionObject () 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 &)

Protected Attributes
vtkEventForwarderCommand *	Forwarder

vtkWeakPointer< vtkSIProxyDefinitionManager >	ProxyDefinitionManager

Protected Attributes inherited from vtkSMRemoteObject
vtkTypeUInt32	GlobalID

vtkTypeUInt32	Location

bool	Prototype

bool	ClientOnlyLocationFlag

Protected Attributes inherited from vtkSMSessionObject
vtkWeakPointer< vtkSMSession >	Session
	Identifies the session id to which this object is related. More...

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

vtkSMProxyDefinitionManager is a remote-object that represents the vtkSIProxyDefinitionManager instance on all the processes.

ParaView clients should use API on this class to add/update xml definitions to ensure that the xmls are processed/updated correctly on all the processes.

Definition at line 24 of file vtkSMProxyDefinitionManager.h.

Member Typedef Documentation

◆ Superclass

typedef vtkSMRemoteObject vtkSMProxyDefinitionManager::Superclass

Definition at line 28 of file vtkSMProxyDefinitionManager.h.

Member Enumeration Documentation

◆ Events

enum vtkSMProxyDefinitionManager::Events

Enumerator
ProxyDefinitionsUpdated
CompoundProxyDefinitionsUpdated

Definition at line 47 of file vtkSMProxyDefinitionManager.h.

◆ anonymous enum

anonymous enum

Enumerator
ALL_DEFINITIONS
CORE_DEFINITIONS
CUSTOM_DEFINITIONS

Definition at line 53 of file vtkSMProxyDefinitionManager.h.

Constructor & Destructor Documentation

◆ vtkSMProxyDefinitionManager()

vtkSMProxyDefinitionManager::vtkSMProxyDefinitionManager ( )

protected

◆ ~vtkSMProxyDefinitionManager()

vtkSMProxyDefinitionManager::~vtkSMProxyDefinitionManager ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkSMProxyDefinitionManager* vtkSMProxyDefinitionManager::New ( )

static

◆ GetClassName()

virtual const char* vtkSMProxyDefinitionManager::GetClassName ( )

virtual

Reimplemented from vtkSMRemoteObject.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkSMRemoteObject.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkSMObject.

◆ SynchronizeDefinitions()

void vtkSMProxyDefinitionManager::SynchronizeDefinitions ( )

Synchronizes the client-side definitions using the server-side definitions, if applicable.

Call this method after any code that could result in changing of the XML definitions on the server e.g. loading of plugins.

◆ SetSession()

void vtkSMProxyDefinitionManager::SetSession ( vtkSMSession * )

overridevirtual

Overridden call SynchronizeDefinitions() when the session changes.

Also ensures that the internal references to vtkSIProxyDefinitionManager are updated correctly.

Reimplemented from vtkSMSessionObject.

◆ GetProxyDefinition() [1/2]

vtkPVXMLElement* vtkSMProxyDefinitionManager::GetProxyDefinition	(	const char *	group,
		const char *	name,
		bool	throwError
	)

inline

Returns a registered proxy definition or return a nullptr otherwise.

Moreover, error can be throw if the definition was not found if the flag throwError is true.

Definition at line 70 of file vtkSMProxyDefinitionManager.h.

◆ GetProxyDefinition() [2/2]

vtkPVXMLElement* vtkSMProxyDefinitionManager::GetProxyDefinition	(	const char *	group,
		const char *	name
	)

inline

Returns a registered proxy definition or return a nullptr otherwise.

Moreover, error can be throw if the definition was not found if the flag throwError is true.

Definition at line 76 of file vtkSMProxyDefinitionManager.h.

◆ GetCollapsedProxyDefinition()

vtkPVXMLElement* vtkSMProxyDefinitionManager::GetCollapsedProxyDefinition	(	const char *	group,
		const char *	name,
		const char *	subProxyName,
		bool	throwError
	)

inline

Returns the same thing as GetProxyDefinition in a flatten manner.

By flatten, we mean that the class hierarchy has been walked and merged into a single vtkPVXMLElement definition.

Definition at line 89 of file vtkSMProxyDefinitionManager.h.

◆ HasDefinition()

bool vtkSMProxyDefinitionManager::HasDefinition	(	const char *	groupName,
		const char *	proxyName
	)

inline

Return true if the XML Definition was found.

Definition at line 100 of file vtkSMProxyDefinitionManager.h.

◆ SaveCustomProxyDefinitions()

void vtkSMProxyDefinitionManager::SaveCustomProxyDefinitions ( vtkPVXMLElement * root )

inline

Save registered custom proxy definitions.

The caller must release the reference to the returned vtkPVXMLElement.

Definition at line 111 of file vtkSMProxyDefinitionManager.h.

◆ NewIterator() [1/2]

VTK_NEWINSTANCE vtkPVProxyDefinitionIterator* vtkSMProxyDefinitionManager::NewIterator ( )

inline

Return a NEW instance of vtkPVProxyDefinitionIterator configured to get through all the definition available for the requested scope.

Possible scope defined as enum inside vtkSIProxyDefinitionManager: ALL_DEFINITIONS=0 / CORE_DEFINITIONS=1 / CUSTOM_DEFINITIONS=2 Some extra restriction can be set directly on the iterator itself by setting a set of GroupName...

Definition at line 129 of file vtkSMProxyDefinitionManager.h.

◆ NewIterator() [2/2]

VTK_NEWINSTANCE vtkPVProxyDefinitionIterator* vtkSMProxyDefinitionManager::NewIterator ( int scope )

inline

Return a NEW instance of vtkPVProxyDefinitionIterator configured to get through all the definition available for the requested scope.

Possible scope defined as enum inside vtkSIProxyDefinitionManager: ALL_DEFINITIONS=0 / CORE_DEFINITIONS=1 / CUSTOM_DEFINITIONS=2 Some extra restriction can be set directly on the iterator itself by setting a set of GroupName...

Definition at line 134 of file vtkSMProxyDefinitionManager.h.

◆ NewSingleGroupIterator() [1/2]

vtkPVProxyDefinitionIterator* vtkSMProxyDefinitionManager::NewSingleGroupIterator ( const char * groupName )

inline

Return a new configured iterator for traversing a set of proxy definition for only one GroupName.

Possible scope defined as enum inside vtkSIProxyDefinitionManager: ALL_DEFINITIONS=0 / CORE_DEFINITIONS=1 / CUSTOM_DEFINITIONS=2

Definition at line 148 of file vtkSMProxyDefinitionManager.h.

◆ NewSingleGroupIterator() [2/2]

vtkPVProxyDefinitionIterator* vtkSMProxyDefinitionManager::NewSingleGroupIterator	(	const char *	groupName,
		int	scope
	)

inline

Return a new configured iterator for traversing a set of proxy definition for only one GroupName.

Possible scope defined as enum inside vtkSIProxyDefinitionManager: ALL_DEFINITIONS=0 / CORE_DEFINITIONS=1 / CUSTOM_DEFINITIONS=2

Definition at line 154 of file vtkSMProxyDefinitionManager.h.

◆ AddCustomProxyDefinition()

void vtkSMProxyDefinitionManager::AddCustomProxyDefinition	(	const char *	group,
		const char *	name,
		vtkPVXMLElement *	top
	)

Add/Remove/Clear custom proxy definitions.

◆ RemoveCustomProxyDefinition()

void vtkSMProxyDefinitionManager::RemoveCustomProxyDefinition	(	const char *	group,
		const char *	name
	)

Add/Remove/Clear custom proxy definitions.

◆ ClearCustomProxyDefinitions()

void vtkSMProxyDefinitionManager::ClearCustomProxyDefinitions ( )

Add/Remove/Clear custom proxy definitions.

◆ LoadCustomProxyDefinitions()

void vtkSMProxyDefinitionManager::LoadCustomProxyDefinitions ( vtkPVXMLElement * root )

Load custom proxy definitions and register them.

◆ LoadCustomProxyDefinitionsFromString()

void vtkSMProxyDefinitionManager::LoadCustomProxyDefinitionsFromString ( const char * xmlContent )

Load custom proxy definitions and register them.

◆ LoadConfigurationXML()

bool vtkSMProxyDefinitionManager::LoadConfigurationXML ( vtkPVXMLElement * root )

Loads server-manager configuration xml.

◆ LoadConfigurationXMLFromString()

bool vtkSMProxyDefinitionManager::LoadConfigurationXMLFromString ( const char * xmlContent )

Loads server-manager configuration xml.

◆ LoadState()

void vtkSMProxyDefinitionManager::LoadState	(	const vtkSMMessage *	msg,
		vtkSMProxyLocator *	locator
	)

overridevirtual

This method is used to initialise the object to the given state If the definitionOnly Flag is set to True the proxy won't load the properties values and just setup the new proxy hierarchy with all subproxy globalID set.

This allow to split the load process in 2 step to prevent invalid state when property refere to a sub-proxy that does not exist yet.

Reimplemented from vtkSMRemoteObject.

Member Data Documentation

◆ Forwarder

vtkEventForwarderCommand* vtkSMProxyDefinitionManager::Forwarder

protected

Definition at line 204 of file vtkSMProxyDefinitionManager.h.

◆ ProxyDefinitionManager

vtkWeakPointer<vtkSIProxyDefinitionManager> vtkSMProxyDefinitionManager::ProxyDefinitionManager

protected

Definition at line 205 of file vtkSMProxyDefinitionManager.h.

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

/builds/gitlab-kitware-sciviz-ci/Remoting/ServerManager/vtkSMProxyDefinitionManager.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ Events

◆ anonymous enum

Constructor & Destructor Documentation

◆ vtkSMProxyDefinitionManager()

◆ ~vtkSMProxyDefinitionManager()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ SynchronizeDefinitions()

◆ SetSession()

◆ GetProxyDefinition() [1/2]

◆ GetProxyDefinition() [2/2]

◆ GetCollapsedProxyDefinition()

◆ HasDefinition()

◆ SaveCustomProxyDefinitions()

◆ NewIterator() [1/2]

◆ NewIterator() [2/2]

◆ NewSingleGroupIterator() [1/2]

◆ NewSingleGroupIterator() [2/2]

◆ AddCustomProxyDefinition()

◆ RemoveCustomProxyDefinition()

◆ ClearCustomProxyDefinitions()

◆ LoadCustomProxyDefinitions()

◆ LoadCustomProxyDefinitionsFromString()

◆ LoadConfigurationXML()

◆ LoadConfigurationXMLFromString()

◆ LoadState()

Member Data Documentation

◆ Forwarder

◆ ProxyDefinitionManager