proxy for a VTK source on a server More...

#include <vtkSMSourceProxy.h>

Inheritance diagram for vtkSMSourceProxy:

[legend]

Collaboration diagram for vtkSMSourceProxy:

[legend]

Public Types
enum	ProcessSupportType { SINGLE_PROCESS, MULTIPLE_PROCESSES, BOTH }

typedef vtkSMProxy	Superclass

Public Types inherited from vtkSMProxy
enum	ResetPropertiesMode { DEFAULT = 0, ONLY_XML = 1, ONLY_DOMAIN = 2 }

enum	{ COPY_PROXY_PROPERTY_VALUES_BY_REFERENCE = 0, COPY_PROXY_PROPERTY_VALUES_BY_CLONING }
	Flags used for the proxyPropertyCopyFlag argument to the Copy method. More...

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	UpdatePipelineInformation () override
	Calls UpdateInformation() on all sources. More...

virtual void	UpdatePipeline ()
	Calls Update() on all sources. More...

virtual void	UpdatePipeline (double time)
	Calls Update() on all sources with the given time request. More...

virtual unsigned int	GetNumberOfOutputPorts ()
	Return the number of output ports. More...

virtual vtkSMOutputPort *	GetOutputPort (unsigned int idx)
	Return an output port. More...

virtual vtkSMOutputPort *	GetOutputPort (const char *portname)
	Return an output port, given the name for the port. More...

virtual unsigned int	GetOutputPortIndex (const char *portname)
	Returns the port index, given the name of an output port. More...

virtual const char *	GetOutputPortName (unsigned int index)
	Returns the output port name given its index. More...

virtual void	CreateOutputPorts ()
	Creates the output port proxies for this filter. More...

vtkPVDataInformation *	GetSubsetDataInformation (unsigned int outputIdx, unsigned int compositeIndex)
	A `GetSubsetDataInformation` overload that uses composite index. More...

virtual void	CreateSelectionProxies ()
	Creates extract selection proxies for each output port if not already created. More...

void	SetSelectionInput (unsigned int portIndex, vtkSMSourceProxy *input, unsigned int outputPort)
	Set/Get the selection input. More...

void	CleanSelectionInputs (unsigned int portIndex)
	Clean all selection inputs for the given port. More...

vtkSMSourceProxy *	GetSelectionOutput (unsigned int portIndex)
	Returns the source proxy which provides the selected data from the given output port. More...

unsigned int	GetNumberOfAlgorithmOutputPorts ()
	Returns the number of output ports provided by the algorithm. More...

virtual unsigned int	GetNumberOfAlgorithmRequiredInputPorts ()
	Returns the number of non-optional input ports required by the algorithm. More...

vtkTypeUInt32	GetGlobalID () override
	Overridden to reserve additional IDs for use by "ExtractSelection" proxies. More...

void	MarkDirty (vtkSMProxy *modifiedProxy) override
	Marks the selection proxies dirty as well as chain to superclass. More...


virtual int	GetOutputPortsCreated ()
	Returns if the output port proxies have been created. More...


vtkSMDocumentation *	GetOutputPortDocumentation (unsigned int index)
	It is possible to provide some documentation for each output port in the configuration xml. More...

vtkSMDocumentation *	GetOutputPortDocumentation (const char *portname)
	It is possible to provide some documentation for each output port in the configuration xml. More...


vtkPVDataInformation *	GetDataInformation ()
	DataInformation is used by the source proxy to obtain information on the output(s) from the server. More...

vtkPVDataInformation *	GetDataInformation (unsigned int outputIdx)
	DataInformation is used by the source proxy to obtain information on the output(s) from the server. More...


vtkPVDataInformation *	GetSubsetDataInformation (unsigned int outputIdx, const char selector, const char assemblyName=nullptr)
	For composite datasets, `GetDataInformation` returns summary data information for all blocks combined. More...


vtkPVDataInformation *	GetRankDataInformation (int rank)
	Get rank-specific data information. More...

vtkPVDataInformation *	GetRankDataInformation (unsigned int outputIdx, int rank)
	Get rank-specific data information. More...


vtkSMSourceProxy *	GetSelectionInput (unsigned int portIndex)
	API to query selection input set using SetSelectionInput. More...

unsigned int	GetSelectionInputPort (unsigned int portIndex)
	API to query selection input set using SetSelectionInput. More...


virtual int	GetProcessSupport ()
	This returns information about whether the VTK algorithm supports multiple processes or not. More...


virtual bool	GetMPIRequired ()
	This returns information about whether the VTK algorithm explicitly needs MPI to be initialized. More...

Public Member Functions inherited from vtkSMProxy
void	SetAnnotation (const char key, const char value)

const char *	GetAnnotation (const char *key)
	Retrieve an annotation with a given key. More...

void	RemoveAnnotation (const char *key)
	Remove a given annotation based on its key to the proxy. More...

void	RemoveAllAnnotations ()
	Remove all proxy annotations. More...

bool	HasAnnotation (const char *key)
	Return true if a given annotation exists. More...

int	GetNumberOfAnnotations ()
	Return the number of available annotations. More...

const char *	GetAnnotationKeyAt (int index)
	Return the nth key of the available annotations. More...

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

virtual vtkSMProperty *	GetProperty (const char *name)
	Return the property with the given name. More...

virtual vtkSMProperty *	GetProperty (const char *name, int selfOnly)
	Return a property of the given name from self or one of the sub-proxies. More...

const char *	GetPropertyName (vtkSMProperty *prop)
	Given a property pointer, returns the name that was used to add it to the proxy. More...

virtual void	UpdateVTKObjects ()
	Update the VTK object on the server by pushing the values of all modified properties (un-modified properties are ignored). More...

virtual void	RecreateVTKObjects ()
	Recreate the VTK object for this proxy. More...

void	InvokeCommand (const char *name)
	Convenience method equivalent to UpdateProperty(name, 1). More...

virtual vtkSMPropertyIterator *	NewPropertyIterator ()
	Returns a new (initialized) iterator of the properties. More...

unsigned int	GetNumberOfConsumers ()
	Returns the number of consumers. More...

vtkSMProxy *	GetConsumerProxy (unsigned int idx)
	Returns the consumer of given index. More...

vtkSMProperty *	GetConsumerProperty (unsigned int idx)
	Returns the corresponding property of the consumer of given index. More...

unsigned int	GetNumberOfProducers ()
	Returns the number of proxies this proxy depends on (uses or is connected to through the pipeline). More...

vtkSMProxy *	GetProducerProxy (unsigned int idx)
	Returns a proxy this proxy depends on, given index. More...

vtkSMProperty *	GetProducerProperty (unsigned int idx)
	Returns the property holding a producer proxy given an index. More...

virtual void	UpdatePropertyInformation ()
	Updates all property information by calling UpdateInformation() and populating the values. More...

virtual void	UpdatePropertyInformation (vtkSMProperty *prop)
	Similar to UpdatePropertyInformation() but updates only the given property. More...

virtual void	MarkAllPropertiesAsModified ()
	Marks all properties as modified. More...

virtual void	ResetPropertiesToXMLDefaults ()
	Use this method to set all properties on this proxy to their default values. More...

virtual void	ResetPropertiesToDomainDefaults ()
	Use this method to set all properties on this proxy to their default domains. More...

virtual void	ResetPropertiesToDefault (ResetPropertiesMode mode=DEFAULT)
	Use this method to set all properties on this proxy to their default domain or values. More...

virtual void	MarkModified (vtkSMProxy *modifiedProxy)
	Calls MarkDirty() and invokes ModifiedEvent. More...

bool	IsDeprecated ()
	Returns true if the proxy has a deprecation tag. More...

void	InitializeAndCopyFromProxy (vtkSMProxy *source)
	Given a source proxy, makes this proxy point to the same server-side object (with a new id). More...

vtkObjectBase *	GetClientSideObject ()
	Returns the client side object associated with the VTKObjectID (if any). More...

virtual vtkPVXMLElement *	SaveXMLState (vtkPVXMLElement *root)
	Saves the state of the proxy. More...

virtual vtkPVXMLElement *	SaveXMLState (vtkPVXMLElement root, vtkSMPropertyIterator iter)
	The iterator is use to filter the property available on the given proxy. More...

virtual int	LoadXMLState (vtkPVXMLElement element, vtkSMProxyLocator locator)
	Loads the proxy state from the XML element. More...

void	UpdateSelfAndAllInputs ()
	This method call UpdateVTKObjects on the current pipeline by starting at the sources. More...

bool	GetIsSubProxy ()
	A proxy instance can be a sub-proxy for some other proxy. More...

vtkSMProxy *	GetParentProxy ()
	If this instance is a sub-proxy, this method will return the proxy of which this instance is an immediate sub-proxy. More...

vtkSMProxy *	GetTrueParentProxy ()
	Call GetParentProxy() recursively till a proxy that is not a subproxy of any other proxy is found. More...

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

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

const vtkSMMessage *	GetFullState () override
	This method return the full object state that can be used to create that object from scratch. 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...

vtkSMPropertyGroup *	GetPropertyGroup (size_t index) const
	Returns the property group at `index` for the proxy. More...

size_t	GetNumberOfPropertyGroups () const
	Returns the number of property groups that the proxy contains. More...

const char *	GetLogNameOrDefault ()
	A helper that makes up an default name if none is provided. More...

bool	GetPropertiesModified ()

virtual std::vector< std::string >	GetPropertiesWithDifferentValues (vtkSMProxy *otherProxy)
	Return the property names that have values different from the otherProxy argument. More...

bool	UpdateProperty (const char *name)
	Update the value of one property (pushed to the server) if it is modified. More...

bool	UpdateProperty (const char *name, int force)
	Update the value of one property (pushed to the server) if it is modified. More...

virtual char *	GetVTKClassName ()
	Returns the type of object managed by the proxy. More...

virtual void	SetVTKClassName (const char *)
	the type of object created by the proxy. More...

virtual char *	GetXMLName ()
	Assigned by the XML parser. More...

virtual char *	GetXMLGroup ()
	Assigned by the XML parser. More...

virtual char *	GetXMLLabel ()
	Assigned by the XML parser. More...

void	Copy (vtkSMProxy *src)
	Copies values of all the properties and sub-proxies from src. More...

void	Copy (vtkSMProxy src, const char exceptionClass)
	Copies values of all the properties and sub-proxies from src. More...

virtual void	Copy (vtkSMProxy src, const char exceptionClass, int proxyPropertyCopyFlag)
	Copies values of all the properties and sub-proxies from src. More...

virtual vtkSMDocumentation *	GetDocumentation ()
	Returns the documentation for this proxy. More...

virtual vtkPVXMLElement *	GetHints ()
	The server manager configuration XML may define `<Hints/>` element for a proxy. More...

virtual int	GetObjectsCreated ()
	Returns if the VTK objects for this proxy have been created. More...

bool	GatherInformation (vtkPVInformation *information)
	Gathers information about this proxy. More...

bool	GatherInformation (vtkPVInformation *information, vtkTypeUInt32 location)
	Gathers information about this proxy. More...

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

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

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

void	SetLogName (const char *name)
	Log name is a name for this proxy that will be used when logging status messages. More...

virtual char *	GetLogName ()
	Log name is a name for this proxy that will be used when logging status messages. More...

Public Member Functions inherited from vtkSMRemoteObject
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 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 vtkTypeUInt32	GetLocation ()
	Get/Set the location where the underlying VTK-objects are created. More...

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

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

Public Member Functions inherited from vtkSMSessionObject
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 vtkSMSourceProxy *	New ()

static int	IsTypeOf (const char *type)

static vtkSMSourceProxy *	SafeDownCast (vtkObject *o)

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

static int	IsTypeOf (const char *type)

static vtkSMProxy *	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
	vtkSMSourceProxy ()

	~vtkSMSourceProxy () override

virtual void	InvalidateDataInformation ()
	Mark the data information as invalid. More...

void	CreateVTKObjects () override
	Call superclass' and then assigns a new executive (vtkCompositeDataPipeline) More...

virtual void	SetExecutiveName (const char *)

int	ReadXMLAttributes (vtkSMSessionProxyManager pm, vtkPVXMLElement element) override
	Read attributes from an XML element. More...

void	PostUpdateData (bool) override
	Overwritten from superclass to invoke. More...

void	SetLogNameInternal (const char *name, bool propagate_to_subproxies, bool propagate_to_proxylistdomains) override
	Overridden to pass the logname to the internal ExtractSelection proxies. More...


void	SetOutputPort (unsigned int index, const char name, vtkSMOutputPort port, vtkSMDocumentation *doc)
	Method to set an output port at the given index. More...

void	RemoveAllOutputPorts ()
	Method to set an output port at the given index. More...

void	SetExtractSelectionProxy (unsigned int index, vtkSMSourceProxy *proxy)
	Method to set an output port at the given index. More...

void	RemoveAllExtractSelectionProxies ()
	Method to set an output port at the given index. More...

Protected Member Functions inherited from vtkSMProxy
	vtkSMProxy ()

	~vtkSMProxy () override

void	ExecuteStream (const vtkClientServerStream &msg, bool ignore_errors=false, vtkTypeUInt32 location=0)
	Invoke that takes a vtkClientServerStream as the argument. More...

virtual void	UpdateAndPushAnnotationState ()

virtual void	AddProperty (const char name, vtkSMProperty prop)
	Add a property with the given key (name). More...

virtual void	MarkConsumersAsDirty (vtkSMProxy *modifiedProxy)
	Calls `MarkDirtyFromProducer` on all consumers. More...

virtual void	MarkDirtyFromProducer (vtkSMProxy modifiedProxy, vtkSMProxy producer, vtkSMProperty *property)
	`MarkConsumersAsDirty` calls this method on each consumer, instead of directly calling `MarkDirty` on the consumer. More...

void	MarkInputsAsDirty ()
	This method is called by vtkSMRepresentationProxy whenever the time request for the pipeline may have potentially changed. More...

void	RemoveAllObservers ()
	Cleanup code. More...

virtual void	SetPropertyModifiedFlag (const char *name, int flag)
	Note on property modified flags: The modified flag of each property associated with a proxy is stored in the proxy object instead of in the property itself. More...

void	AddSubProxy (const char name, vtkSMProxy proxy, int overrideOK=0)
	Add a sub-proxy. More...

void	RemoveSubProxy (const char *name)
	Remove a sub-proxy. More...

vtkSMProxy *	GetSubProxy (const char *name)
	Returns a sub-proxy. More...

vtkSMProxy *	GetSubProxy (unsigned int index)
	Returns a sub-proxy. More...

const char *	GetSubProxyName (unsigned int index)
	Returns the name used to store sub-proxy. More...

const char *	GetSubProxyName (vtkSMProxy *)
	Returns the name used to store sub-proxy. More...

unsigned int	GetNumberOfSubProxies ()
	Returns the number of sub-proxies. More...

virtual void	AddConsumer (vtkSMProperty property, vtkSMProxy proxy)
	Called by a proxy property, this adds the property,proxy pair to the list of consumers. More...

virtual void	RemoveConsumer (vtkSMProperty property, vtkSMProxy proxy)
	Remove the property,proxy pair from the list of consumers. More...

virtual void	RemoveAllConsumers ()
	Remove all consumers. More...

void	AddProducer (vtkSMProperty property, vtkSMProxy proxy)
	Called by an proxy/input property to add property, proxy pair to the list of producers. More...

void	RemoveProducer (vtkSMProperty property, vtkSMProxy proxy)
	Remove the property,proxy pair from the list of producers. More...

void	PostUpdateDataSelfOnly (bool using_cache)
	This is called by `PostUpdateData` to only update state for this proxy without iterative over producers. More...

bool	WarnIfDeprecated ()
	If a proxy is deprecated, prints a warning. More...

bool	LoadPluginIfEnsured ()
	If a proxy need to ensure a plugin is loaded, make sure it is. More...

void	LinkProperty (vtkSMProperty inputProperty, vtkSMProperty outputProperty)
	Links properties such that when inputProperty's checked or unchecked values are changed, the outputProperty's corresponding values are also changed. More...

vtkSMPropertyGroup *	NewPropertyGroup (vtkPVXMLElement *propElement)
	Parses the XML to create a new property group. More...

void	AppendPropertyGroup (vtkSMPropertyGroup *group)
	Adds a property groups. More...

void	ExposeSubProxyProperty (const char subproxy_name, const char property_name, const char *exposed_name, int overrideOK=0)
	Expose a subproxy property from the base proxy. More...

virtual void	ExecuteSubProxyEvent (vtkSMProxy o, unsigned long event, void data)
	Handle events fired by subproxies. More...

virtual int	CreateSubProxiesAndProperties (vtkSMSessionProxyManager pm, vtkPVXMLElement element)

virtual void	UpdatePropertyInformationInternal (vtkSMProperty *prop=nullptr)
	Called to update the property information on the property. More...

void	RebuildStateForProperties ()
	vtkSMProxy tracks state of properties on this proxy in an internal State object. More...

bool	ArePropertiesModified ()
	Indicates if any properties are modified. More...

void	SetHints (vtkPVXMLElement *hints)

void	SetDeprecated (vtkPVXMLElement *deprecated)

void	SetEnsurePluginLoaded (vtkPVXMLElement *ensurePluginLoaded)
	Set the "EnsurePluginLoaded" XML element that is used in LoadPluginIfEnsured. More...

void	SetXMLElement (vtkPVXMLElement *element)

	vtkSMProxy (const vtkSMProxy &)=delete

void	operator= (const vtkSMProxy &)=delete

virtual const vtkClientServerStream &	GetLastResult ()
	Get the last result. More...

virtual const vtkClientServerStream &	GetLastResult (vtkTypeUInt32 location)
	Get the last result. More...

virtual void	SetXMLName (const char *)
	Assigned by the XML parser. More...

virtual void	SetXMLGroup (const char *)
	Assigned by the XML parser. More...

virtual void	SetXMLLabel (const char *)
	Assigned by the XML parser. More...

virtual void	SetXMLSubProxyName (const char *)
	Assigned by the XML parser. More...

vtkSMProperty *	NewProperty (const char *name)
	Creates a new property and initializes it by calling ReadXMLAttributes() with the right XML element. More...

vtkSMProperty *	NewProperty (const char name, vtkPVXMLElement propElement)
	Creates a new property and initializes it by calling ReadXMLAttributes() with the right XML element. More...

void	SetupExposedProperties (const char subproxy_name, vtkPVXMLElement element)
	Read attributes from an XML element. More...

void	SetupSharedProperties (vtkSMProxy subproxy, vtkPVXMLElement element)
	Read attributes from an XML element. More...

virtual void	SetSIClassName (const char *)
	SIClassName identifies the classname for the helper on the server side. More...

virtual char *	GetSIClassName ()
	SIClassName identifies the classname for the helper on the server side. More...

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
int	OutputPortsCreated

int	ProcessSupport

bool	MPIRequired

char *	ExecutiveName

bool	DisableSelectionProxies

bool	SelectionProxiesCreated

Protected Attributes inherited from vtkSMProxy
bool	NeedsUpdate

char *	VTKClassName

char *	XMLGroup

char *	XMLName

char *	XMLLabel

char *	XMLSubProxyName

int	ObjectsCreated

int	DoNotUpdateImmediately

int	DoNotModifyProperty

int	InUpdateVTKObjects
	Avoids calls to UpdateVTKObjects in UpdateVTKObjects. More...

bool	PropertiesModified
	Flag used to help speed up UpdateVTKObjects and ArePropertiesModified calls. More...

vtkPVXMLElement *	XMLElement

vtkSMDocumentation *	Documentation

vtkPVXMLElement *	Hints = nullptr

vtkPVXMLElement *	Deprecated = nullptr

vtkPVXMLElement *	EnsurePluginLoaded = nullptr

vtkSMMessage *	State

int	InMarkModified

vtkWeakPointer< vtkSMProxy >	ParentProxy

vtkSMProxyInternals *	Internals

vtkSMProxyObserver *	SubProxyObserver

char *	SIClassName
	SIClassName identifies the classname for the helper on the server side. More...

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

Friends
class	vtkSMInputProperty

class	vtkSMOutputPort

Detailed Description

proxy for a VTK source on a server

vtkSMSourceProxy manages VTK source(s) that are created on a server using the proxy pattern. In addition to functionality provided by vtkSMProxy, vtkSMSourceProxy provides method to connect and update sources. Each source proxy has one or more output ports (vtkSMOutputPort). Each port represents one output of one filter. These are created automatically (when CreateOutputPorts() is called) by the source. Each vtkSMSourceProxy creates a property called DataInformation. This property is a composite property that provides information about the output(s) of the VTK sources (obtained from the server)

See also: vtkSMProxy vtkSMOutputPort vtkSMInputProperty

Definition at line 37 of file vtkSMSourceProxy.h.

Member Typedef Documentation

◆ Superclass

typedef vtkSMProxy vtkSMSourceProxy::Superclass

Definition at line 41 of file vtkSMSourceProxy.h.

Member Enumeration Documentation

◆ ProcessSupportType

enum vtkSMSourceProxy::ProcessSupportType

Enumerator
SINGLE_PROCESS
MULTIPLE_PROCESSES
BOTH

Definition at line 239 of file vtkSMSourceProxy.h.

Constructor & Destructor Documentation

◆ vtkSMSourceProxy()

vtkSMSourceProxy::vtkSMSourceProxy ( )

protected

◆ ~vtkSMSourceProxy()

vtkSMSourceProxy::~vtkSMSourceProxy ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkSMSourceProxy* vtkSMSourceProxy::New ( )

static

◆ GetClassName()

virtual const char* vtkSMSourceProxy::GetClassName ( )

virtual

Reimplemented from vtkSMProxy.

Reimplemented in vtkSMMultiplexerSourceProxy, vtkSMRepresentationProxy, vtkSMPVRepresentationProxy, vtkSMPVMoleculeRepresentationProxy, vtkSMCompoundSourceProxy, vtkSMSelfGeneratingSourceProxy, vtkSMDataSourceProxy, vtkSMMultiServerSourceProxy, vtkSMWriterProxy, vtkSMPWriterProxy, vtkSMPSWriterProxy, vtkSMEnsembleDataReaderProxy, vtkSMChartRepresentationProxy, and vtkSMSpreadSheetRepresentationProxy.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkSMProxy.

Reimplemented in vtkSMMultiplexerSourceProxy, vtkSMRepresentationProxy, vtkSMPVRepresentationProxy, vtkSMPVMoleculeRepresentationProxy, vtkSMCompoundSourceProxy, vtkSMSelfGeneratingSourceProxy, vtkSMDataSourceProxy, vtkSMMultiServerSourceProxy, vtkSMWriterProxy, vtkSMPWriterProxy, vtkSMPSWriterProxy, vtkSMEnsembleDataReaderProxy, vtkSMChartRepresentationProxy, and vtkSMSpreadSheetRepresentationProxy.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkSMProxy.

Reimplemented in vtkSMRepresentationProxy, vtkSMPVRepresentationProxy, vtkSMPVMoleculeRepresentationProxy, vtkSMWriterProxy, vtkSMChartRepresentationProxy, and vtkSMSpreadSheetRepresentationProxy.

◆ UpdatePipelineInformation()

void vtkSMSourceProxy::UpdatePipelineInformation ( )

overridevirtual

Calls UpdateInformation() on all sources.

Reimplemented from vtkSMProxy.

◆ UpdatePipeline() [1/2]

virtual void vtkSMSourceProxy::UpdatePipeline ( )

virtual

Calls Update() on all sources.

It also creates output ports if they are not already created.

Reimplemented in vtkSMRepresentationProxy, and vtkSMWriterProxy.

◆ UpdatePipeline() [2/2]

virtual void vtkSMSourceProxy::UpdatePipeline ( double time )

virtual

Calls Update() on all sources with the given time request.

It also creates output ports if they are not already created.

Reimplemented in vtkSMRepresentationProxy, and vtkSMWriterProxy.

◆ GetOutputPortsCreated()

virtual int vtkSMSourceProxy::GetOutputPortsCreated ( )

virtual

Returns if the output port proxies have been created.

◆ GetNumberOfOutputPorts()

virtual unsigned int vtkSMSourceProxy::GetNumberOfOutputPorts ( )

virtual

Return the number of output ports.

◆ GetOutputPort() [1/2]

virtual vtkSMOutputPort* vtkSMSourceProxy::GetOutputPort ( unsigned int idx )

virtual

Return an output port.

◆ GetOutputPort() [2/2]

virtual vtkSMOutputPort* vtkSMSourceProxy::GetOutputPort ( const char * portname )

virtual

Return an output port, given the name for the port.

Each output port is assigned a unique name (either using the xml configuration or automatically). The automatically assigned names are of the type Output0, Output1 etc.

◆ GetOutputPortIndex()

virtual unsigned int vtkSMSourceProxy::GetOutputPortIndex ( const char * portname )

virtual

Returns the port index, given the name of an output port.

Each output port is assigned a unique name (either using the xml configuration or automatically). The automatically assigned names are of the type Output0, Output1 etc. Returns VTK_UNSIGNED_INT_MAX (i.e. ~0u) when a port with given port name does not exist.

◆ GetOutputPortName()

virtual const char* vtkSMSourceProxy::GetOutputPortName ( unsigned int index )

virtual

Returns the output port name given its index.

Each output port is assigned an unique name (either using the xml configuration or automatically). The automatically assigned names are of the type Output-0, Output-1 etc.

◆ GetOutputPortDocumentation() [1/2]

vtkSMDocumentation* vtkSMSourceProxy::GetOutputPortDocumentation ( unsigned int index )

It is possible to provide some documentation for each output port in the configuration xml.

These methods provide access to the port specific documentation, if any. If no documentation is present, these methods will return 0.

◆ GetOutputPortDocumentation() [2/2]

vtkSMDocumentation* vtkSMSourceProxy::GetOutputPortDocumentation ( const char * portname )

It is possible to provide some documentation for each output port in the configuration xml.

These methods provide access to the port specific documentation, if any. If no documentation is present, these methods will return 0.

◆ CreateOutputPorts()

virtual void vtkSMSourceProxy::CreateOutputPorts ( )

virtual

Creates the output port proxies for this filter.

Each output port proxy corresponds to an actual output port on the algorithm.

Reimplemented in vtkSMCompoundSourceProxy.

◆ GetDataInformation() [1/2]

vtkPVDataInformation* vtkSMSourceProxy::GetDataInformation ( )

inline

DataInformation is used by the source proxy to obtain information on the output(s) from the server.

If update is false the pipeline will not be updated before gathering the data information.

Definition at line 129 of file vtkSMSourceProxy.h.

◆ GetDataInformation() [2/2]

vtkPVDataInformation* vtkSMSourceProxy::GetDataInformation ( unsigned int outputIdx )

DataInformation is used by the source proxy to obtain information on the output(s) from the server.

If update is false the pipeline will not be updated before gathering the data information.

◆ GetSubsetDataInformation() [1/2]

vtkPVDataInformation* vtkSMSourceProxy::GetSubsetDataInformation	(	unsigned int	outputIdx,
		const char *	selector,
		const char *	assemblyName = `nullptr`
	)

For composite datasets, GetDataInformation returns summary data information for all blocks combined.

However, applications may require information about specific subset of blocks. In that case, one can use this API. Internally, the data information is cached per selector / assembly-name pair. That way, if the data information is not re-gathered unless changed.

selector the selector expression
assemblyName name of the assembly to use to apply the selector to to determine the subset. If none specified, then default data-assembly is used. For hierarchy, use vtkDataAssemblyUtilities::HierarchyName().

◆ GetSubsetDataInformation() [2/2]

vtkPVDataInformation* vtkSMSourceProxy::GetSubsetDataInformation	(	unsigned int	outputIdx,
		unsigned int	compositeIndex
	)

A GetSubsetDataInformation overload that uses composite index.

It is only supported for multiblock datasets.

◆ GetRankDataInformation() [1/2]

vtkPVDataInformation* vtkSMSourceProxy::GetRankDataInformation ( int rank )

inline

Get rank-specific data information.

Definition at line 162 of file vtkSMSourceProxy.h.

◆ GetRankDataInformation() [2/2]

vtkPVDataInformation* vtkSMSourceProxy::GetRankDataInformation	(	unsigned int	outputIdx,
		int	rank
	)

Get rank-specific data information.

◆ CreateSelectionProxies()

virtual void vtkSMSourceProxy::CreateSelectionProxies ( )

virtual

Creates extract selection proxies for each output port if not already created.

Reimplemented in vtkSMCompoundSourceProxy.

◆ SetSelectionInput()

void vtkSMSourceProxy::SetSelectionInput	(	unsigned int	portIndex,
		vtkSMSourceProxy *	input,
		unsigned int	outputPort
	)

Set/Get the selection input.

This is used to set the selection input to the extraction proxy for the output port identified by portIndex. If no extraction proxies are present, this method has no effect.

◆ GetSelectionInput()

vtkSMSourceProxy* vtkSMSourceProxy::GetSelectionInput ( unsigned int portIndex )

API to query selection input set using SetSelectionInput.

◆ GetSelectionInputPort()

unsigned int vtkSMSourceProxy::GetSelectionInputPort ( unsigned int portIndex )

API to query selection input set using SetSelectionInput.

◆ CleanSelectionInputs()

void vtkSMSourceProxy::CleanSelectionInputs ( unsigned int portIndex )

Clean all selection inputs for the given port.

◆ GetSelectionOutput()

vtkSMSourceProxy* vtkSMSourceProxy::GetSelectionOutput ( unsigned int portIndex )

Returns the source proxy which provides the selected data from the given output port.

◆ GetProcessSupport()

virtual int vtkSMSourceProxy::GetProcessSupport ( )

virtual

This returns information about whether the VTK algorithm supports multiple processes or not.

SINGLE_PROCESS means that this algorithm works only in serial, MULTIPLE_PROCESSES means that it will only useful in parallel (or it is useless in serial), BOTH means both :-) Default is BOTH. This ivar is filled from the xml configuration. This variable should not be used to determine if MPI is initialized. Instead use MPISupport for that.

◆ GetMPIRequired()

virtual bool vtkSMSourceProxy::GetMPIRequired ( )

virtual

This returns information about whether the VTK algorithm explicitly needs MPI to be initialized.

It still may only run with a single process. An example of this is a reader that uses MPI IO routines.

◆ GetNumberOfAlgorithmOutputPorts()

unsigned int vtkSMSourceProxy::GetNumberOfAlgorithmOutputPorts ( )

Returns the number of output ports provided by the algorithm.

◆ GetNumberOfAlgorithmRequiredInputPorts()

virtual unsigned int vtkSMSourceProxy::GetNumberOfAlgorithmRequiredInputPorts ( )

virtual

Returns the number of non-optional input ports required by the algorithm.

This value is cached after the first call.

◆ GetGlobalID()

vtkTypeUInt32 vtkSMSourceProxy::GetGlobalID ( )

overridevirtual

Overridden to reserve additional IDs for use by "ExtractSelection" proxies.

Reimplemented from vtkSMRemoteObject.

Reimplemented in vtkSMRepresentationProxy.

◆ MarkDirty()

void vtkSMSourceProxy::MarkDirty ( vtkSMProxy * modifiedProxy )

overridevirtual

Marks the selection proxies dirty as well as chain to superclass.

Reimplemented from vtkSMProxy.

Reimplemented in vtkSMRepresentationProxy.

◆ InvalidateDataInformation()

virtual void vtkSMSourceProxy::InvalidateDataInformation ( )

protectedvirtual

Mark the data information as invalid.

Reimplemented in vtkSMRepresentationProxy.

◆ CreateVTKObjects()

void vtkSMSourceProxy::CreateVTKObjects ( )

overrideprotectedvirtual

Call superclass' and then assigns a new executive (vtkCompositeDataPipeline)

Reimplemented from vtkSMProxy.

Reimplemented in vtkSMPVRepresentationProxy, and vtkSMRepresentationProxy.

◆ SetExecutiveName()

virtual void vtkSMSourceProxy::SetExecutiveName ( const char * )

protectedvirtual

◆ ReadXMLAttributes()

int vtkSMSourceProxy::ReadXMLAttributes	(	vtkSMSessionProxyManager *	pm,
		vtkPVXMLElement *	element
	)

overrideprotectedvirtual

Read attributes from an XML element.

Reimplemented from vtkSMProxy.

Reimplemented in vtkSMPVRepresentationProxy, vtkSMWriterProxy, and vtkSMChartRepresentationProxy.

◆ SetOutputPort()

void vtkSMSourceProxy::SetOutputPort	(	unsigned int	index,
		const char *	name,
		vtkSMOutputPort *	port,
		vtkSMDocumentation *	doc
	)

protected

Method to set an output port at the given index.

Provided for subclasses to add output ports. It replaces the output port at the given index, if any, The output ports will be resize to fit the specified index.

◆ RemoveAllOutputPorts()

void vtkSMSourceProxy::RemoveAllOutputPorts ( )

protected

Method to set an output port at the given index.

Provided for subclasses to add output ports. It replaces the output port at the given index, if any, The output ports will be resize to fit the specified index.

◆ SetExtractSelectionProxy()

void vtkSMSourceProxy::SetExtractSelectionProxy	(	unsigned int	index,
		vtkSMSourceProxy *	proxy
	)

protected

Method to set an output port at the given index.

Provided for subclasses to add output ports. It replaces the output port at the given index, if any, The output ports will be resize to fit the specified index.

◆ RemoveAllExtractSelectionProxies()

void vtkSMSourceProxy::RemoveAllExtractSelectionProxies ( )

protected

Method to set an output port at the given index.

Provided for subclasses to add output ports. It replaces the output port at the given index, if any, The output ports will be resize to fit the specified index.

◆ PostUpdateData()

void vtkSMSourceProxy::PostUpdateData ( bool )

overrideprotectedvirtual

Overwritten from superclass to invoke.

Reimplemented from vtkSMProxy.

Reimplemented in vtkSMRepresentationProxy.

◆ SetLogNameInternal()

void vtkSMSourceProxy::SetLogNameInternal	(	const char *	name,
		bool	propagate_to_subproxies,
		bool	propagate_to_proxylistdomains
	)

overrideprotectedvirtual

Overridden to pass the logname to the internal ExtractSelection proxies.

Reimplemented from vtkSMProxy.

Friends And Related Function Documentation

◆ vtkSMInputProperty

friend class vtkSMInputProperty

friend

Definition at line 255 of file vtkSMSourceProxy.h.

◆ vtkSMOutputPort

friend class vtkSMOutputPort

friend

Definition at line 256 of file vtkSMSourceProxy.h.

Member Data Documentation

◆ OutputPortsCreated

int vtkSMSourceProxy::OutputPortsCreated

protected

Definition at line 258 of file vtkSMSourceProxy.h.

◆ ProcessSupport

int vtkSMSourceProxy::ProcessSupport

protected

Definition at line 260 of file vtkSMSourceProxy.h.

◆ MPIRequired

bool vtkSMSourceProxy::MPIRequired

protected

Definition at line 261 of file vtkSMSourceProxy.h.

◆ ExecutiveName

char* vtkSMSourceProxy::ExecutiveName

protected

Definition at line 274 of file vtkSMSourceProxy.h.

◆ DisableSelectionProxies

bool vtkSMSourceProxy::DisableSelectionProxies

protected

Definition at line 308 of file vtkSMSourceProxy.h.

◆ SelectionProxiesCreated

bool vtkSMSourceProxy::SelectionProxiesCreated

protected

Definition at line 309 of file vtkSMSourceProxy.h.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ ProcessSupportType

Constructor & Destructor Documentation

◆ vtkSMSourceProxy()

◆ ~vtkSMSourceProxy()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ UpdatePipelineInformation()

◆ UpdatePipeline() [1/2]

◆ UpdatePipeline() [2/2]

◆ GetOutputPortsCreated()

◆ GetNumberOfOutputPorts()

◆ GetOutputPort() [1/2]

◆ GetOutputPort() [2/2]

◆ GetOutputPortIndex()

◆ GetOutputPortName()

◆ GetOutputPortDocumentation() [1/2]

◆ GetOutputPortDocumentation() [2/2]

◆ CreateOutputPorts()

◆ GetDataInformation() [1/2]

◆ GetDataInformation() [2/2]

◆ GetSubsetDataInformation() [1/2]

◆ GetSubsetDataInformation() [2/2]

◆ GetRankDataInformation() [1/2]

◆ GetRankDataInformation() [2/2]

◆ CreateSelectionProxies()

◆ SetSelectionInput()

◆ GetSelectionInput()

◆ GetSelectionInputPort()

◆ CleanSelectionInputs()

◆ GetSelectionOutput()

◆ GetProcessSupport()

◆ GetMPIRequired()

◆ GetNumberOfAlgorithmOutputPorts()

◆ GetNumberOfAlgorithmRequiredInputPorts()

◆ GetGlobalID()

◆ MarkDirty()

◆ InvalidateDataInformation()

◆ CreateVTKObjects()

◆ SetExecutiveName()

◆ ReadXMLAttributes()

◆ SetOutputPort()

◆ RemoveAllOutputPorts()

◆ SetExtractSelectionProxy()

◆ RemoveAllExtractSelectionProxies()

◆ PostUpdateData()

◆ SetLogNameInternal()

Friends And Related Function Documentation

◆ vtkSMInputProperty

◆ vtkSMOutputPort

Member Data Documentation

◆ OutputPortsCreated

◆ ProcessSupport

◆ MPIRequired

◆ ExecutiveName

◆ DisableSelectionProxies

◆ SelectionProxiesCreated