Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkSMCompoundSourceProxy Class Reference

a proxy excapsulation a pipeline of proxies. More...

#include <vtkSMCompoundSourceProxy.h>

Inheritance diagram for vtkSMCompoundSourceProxy:
Inheritance graph
[legend]
Collaboration diagram for vtkSMCompoundSourceProxy:
Collaboration graph
[legend]

Public Types

typedef vtkSMSourceProxy Superclass
 
- Public Types inherited from vtkSMSourceProxy
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 AddProxy (const char *name, vtkSMProxy *proxy)
 Add a proxy to be included in this compound proxy. More...
 
void ExposeProperty (const char *proxyName, const char *propertyName, const char *exposedName)
 Expose a property from the sub proxy (added using AddProxy). More...
 
void ExposeOutputPort (const char *proxyName, const char *portName, const char *exposedName)
 Expose an output port from a subproxy. More...
 
void ExposeOutputPort (const char *proxyName, unsigned int portIndex, const char *exposedName)
 Expose an output port from a subproxy. More...
 
unsigned int GetNumberOfProxies ()
 Returns the number of sub-proxies. More...
 
vtkSMProxyGetProxy (unsigned int cc)
 Returns the sub proxy at a given index. More...
 
vtkSMProxyGetProxy (const char *name)
 Returns the subproxy with the given name. More...
 
const char * GetProxyName (unsigned int index)
 Returns the name used to store sub-proxy. More...
 
void CreateOutputPorts () override
 Creates the output port proxiess for this filter. More...
 
void CreateSelectionProxies () override
 Creates extract selection proxies for each output port if not already created. More...
 
void UpdateVTKObjects () override
 Update the VTK object on the server by pushing the values of all modified properties (un-modified properties are ignored). More...
 
vtkPVXMLElementSaveDefinition (vtkPVXMLElement *root)
 This is the same as save state except it will remove all references to "outside" proxies. More...
 
- Public Member Functions inherited from vtkSMSourceProxy
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 vtkSMOutputPortGetOutputPort (unsigned int idx)
 Return an output port. More...
 
virtual vtkSMOutputPortGetOutputPort (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...
 
vtkPVDataInformationGetSubsetDataInformation (unsigned int outputIdx, unsigned int compositeIndex)
 A GetSubsetDataInformation overload that uses composite index. 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...
 
vtkSMSourceProxyGetSelectionOutput (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...
 
vtkSMDocumentationGetOutputPortDocumentation (unsigned int index)
 It is possible to provide some documentation for each output port in the configuration xml. More...
 
vtkSMDocumentationGetOutputPortDocumentation (const char *portname)
 It is possible to provide some documentation for each output port in the configuration xml. More...
 
vtkPVDataInformationGetDataInformation ()
 DataInformation is used by the source proxy to obtain information on the output(s) from the server. More...
 
vtkPVDataInformationGetDataInformation (unsigned int outputIdx)
 DataInformation is used by the source proxy to obtain information on the output(s) from the server. More...
 
vtkPVDataInformationGetSubsetDataInformation (unsigned int outputIdx, const char *selector, const char *assemblyName=nullptr)
 For composite datasets, GetDataInformation returns summary data information for all blocks combined. More...
 
vtkPVDataInformationGetRankDataInformation (int rank)
 Get rank-specific data information. More...
 
vtkPVDataInformationGetRankDataInformation (unsigned int outputIdx, int rank)
 Get rank-specific data information. More...
 
vtkSMSourceProxyGetSelectionInput (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 vtkSMPropertyGetProperty (const char *name)
 Return the property with the given name. More...
 
virtual vtkSMPropertyGetProperty (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 RecreateVTKObjects ()
 Recreate the VTK object for this proxy. More...
 
void InvokeCommand (const char *name)
 Convenience method equivalent to UpdateProperty(name, 1). More...
 
virtual vtkSMPropertyIteratorNewPropertyIterator ()
 Returns a new (initialized) iterator of the properties. More...
 
unsigned int GetNumberOfConsumers ()
 Returns the number of consumers. More...
 
vtkSMProxyGetConsumerProxy (unsigned int idx)
 Returns the consumer of given index. More...
 
vtkSMPropertyGetConsumerProperty (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...
 
vtkSMProxyGetProducerProxy (unsigned int idx)
 Returns a proxy this proxy depends on, given index. More...
 
vtkSMPropertyGetProducerProperty (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...
 
void InitializeAndCopyFromProxy (vtkSMProxy *source)
 Given a source proxy, makes this proxy point to the same server-side object (with a new id). More...
 
vtkObjectBaseGetClientSideObject ()
 Returns the client side object associated with the VTKObjectID (if any). More...
 
virtual vtkPVXMLElementSaveXMLState (vtkPVXMLElement *root)
 Saves the state of the proxy. More...
 
virtual vtkPVXMLElementSaveXMLState (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...
 
vtkSMProxyGetParentProxy ()
 If this instance is a sub-proxy, this method will return the proxy of which this instance is an immediate sub-proxy. More...
 
vtkSMProxyGetTrueParentProxy ()
 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 vtkSMMessageGetFullState () 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...
 
vtkSMPropertyGroupGetPropertyGroup (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 ()
 
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 vtkSMDocumentationGetDocumentation ()
 Returns the documentation for this proxy. More...
 
virtual vtkPVXMLElementGetHints ()
 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 vtkSMSessionProxyManagerGetSessionProxyManager ()
 Return the corresponding ProxyManager if any. More...
 
virtual vtkSMSessionGetSession ()
 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)
 
vtkCommandGetCommand (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)
 
vtkCommandGetCommand (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 vtkSMCompoundSourceProxyNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMCompoundSourceProxySafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMSourceProxy
static vtkSMSourceProxyNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMSourceProxySafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMProxy
static vtkSMProxyNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMProxySafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMRemoteObject
static int IsTypeOf (const char *type)
 
static vtkSMRemoteObjectSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMSessionObject
static vtkSMSessionObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMSessionObjectSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMObject
static vtkSMObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMObjectSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 
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 vtkObjectBaseNew ()
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkSMCompoundSourceProxy ()
 
 ~vtkSMCompoundSourceProxy () override
 
int ReadXMLAttributes (vtkSMSessionProxyManager *pm, vtkPVXMLElement *element) override
 Read attributes from an XML element. More...
 
void CreateVTKObjects () override
 Call superclass' and then assigns a new executive (vtkCompositeDataPipeline) More...
 
int ShouldWriteValue (vtkPVXMLElement *valueElem)
 
void TraverseForProperties (vtkPVXMLElement *root)
 
void StripValues (vtkPVXMLElement *propertyElem)
 
- Protected Member Functions inherited from vtkSMSourceProxy
 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...
 
vtkSMProxyGetSubProxy (const char *name)
 Returns a sub-proxy. More...
 
vtkSMProxyGetSubProxy (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...
 
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...
 
vtkSMPropertyGroupNewPropertyGroup (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 SetXMLElement (vtkPVXMLElement *element)
 
 vtkSMProxy (const vtkSMProxy &)=delete
 
void operator= (const vtkSMProxy &)=delete
 
virtual const vtkClientServerStreamGetLastResult ()
 Get the last result. More...
 
virtual const vtkClientServerStreamGetLastResult (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...
 
vtkSMPropertyNewProperty (const char *name)
 Creates a new property and initializes it by calling ReadXMLAttributes() with the right XML element. More...
 
vtkSMPropertyNewProperty (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 &)
 

Additional Inherited Members

- Protected Attributes inherited from vtkSMSourceProxy
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...
 
vtkPVXMLElementXMLElement
 
vtkSMDocumentationDocumentation
 
vtkPVXMLElementHints
 
vtkPVXMLElementDeprecated
 
vtkSMMessageState
 
int InMarkModified
 
vtkWeakPointer< vtkSMProxyParentProxy
 
vtkSMProxyInternalsInternals
 
vtkSMProxyObserverSubProxyObserver
 
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< vtkSMSessionSession
 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

a proxy excapsulation a pipeline of proxies.

vtkSMCompoundSourceProxy is a proxy that allows grouping of multiple proxies. vtkSMProxy has also this capability since a proxy can have sub-proxies. However, vtkSMProxy does not allow public access to these proxies. The only access is through exposed properties. The main reason behind this is consistency. There are proxies that will not work if the program accesses the sub-proxies directly. The main purpose of vtkSMCompoundSourceProxy is to provide an interface to access the sub-proxies. The compound proxy also maintains the connections between subproxies. This makes it possible to encapsulate a pipeline into a single proxy. Since vtkSMCompoundSourceProxy is a vtkSMSourceProxy, it can be directly used to input to other filters, representations etc. vtkSMCompoundSourceProxy provides API to exposed properties from sub proxies as well as output ports of the subproxies.

Definition at line 44 of file vtkSMCompoundSourceProxy.h.

Member Typedef Documentation

◆ Superclass

Definition at line 48 of file vtkSMCompoundSourceProxy.h.

Constructor & Destructor Documentation

◆ vtkSMCompoundSourceProxy()

vtkSMCompoundSourceProxy::vtkSMCompoundSourceProxy ( )
protected

◆ ~vtkSMCompoundSourceProxy()

vtkSMCompoundSourceProxy::~vtkSMCompoundSourceProxy ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkSMCompoundSourceProxy* vtkSMCompoundSourceProxy::New ( )
static

◆ GetClassName()

virtual const char* vtkSMCompoundSourceProxy::GetClassName ( )
virtual

Reimplemented from vtkSMSourceProxy.

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkSMSourceProxy.

◆ SafeDownCast()

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

◆ PrintSelf()

void vtkSMCompoundSourceProxy::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Reimplemented from vtkObject.

◆ AddProxy()

void vtkSMCompoundSourceProxy::AddProxy ( const char *  name,
vtkSMProxy proxy 
)

Add a proxy to be included in this compound proxy.

The name must be unique to each proxy added, otherwise the previously added proxy will be replaced.

◆ ExposeProperty()

void vtkSMCompoundSourceProxy::ExposeProperty ( const char *  proxyName,
const char *  propertyName,
const char *  exposedName 
)

Expose a property from the sub proxy (added using AddProxy).

Only exposed properties are accessible externally. Note that the sub proxy whose property is being exposed must have been already added using AddProxy().

◆ ExposeOutputPort() [1/2]

void vtkSMCompoundSourceProxy::ExposeOutputPort ( const char *  proxyName,
const char *  portName,
const char *  exposedName 
)

Expose an output port from a subproxy.

Exposed output ports are treated as output ports of the vtkSMCompoundSourceProxy itself. This method does not may the output port available. One must call CreateOutputPorts().

◆ ExposeOutputPort() [2/2]

void vtkSMCompoundSourceProxy::ExposeOutputPort ( const char *  proxyName,
unsigned int  portIndex,
const char *  exposedName 
)

Expose an output port from a subproxy.

Exposed output ports are treated as output ports of the vtkSMCompoundSourceProxy itself. This method does not may the output port available. One must call CreateOutputPorts().

◆ GetNumberOfProxies()

unsigned int vtkSMCompoundSourceProxy::GetNumberOfProxies ( )
inline

Returns the number of sub-proxies.

Definition at line 85 of file vtkSMCompoundSourceProxy.h.

◆ GetProxy() [1/2]

vtkSMProxy* vtkSMCompoundSourceProxy::GetProxy ( unsigned int  cc)
inline

Returns the sub proxy at a given index.

Definition at line 90 of file vtkSMCompoundSourceProxy.h.

◆ GetProxy() [2/2]

vtkSMProxy* vtkSMCompoundSourceProxy::GetProxy ( const char *  name)
inline

Returns the subproxy with the given name.

Definition at line 95 of file vtkSMCompoundSourceProxy.h.

◆ GetProxyName()

const char* vtkSMCompoundSourceProxy::GetProxyName ( unsigned int  index)
inline

Returns the name used to store sub-proxy.

Returns 0 if sub-proxy does not exist.

Definition at line 101 of file vtkSMCompoundSourceProxy.h.

◆ CreateOutputPorts()

void vtkSMCompoundSourceProxy::CreateOutputPorts ( )
overridevirtual

Creates the output port proxiess for this filter.

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

Reimplemented from vtkSMSourceProxy.

◆ CreateSelectionProxies()

void vtkSMCompoundSourceProxy::CreateSelectionProxies ( )
overridevirtual

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

Overridden to update the selection proxies.

Reimplemented from vtkSMSourceProxy.

◆ UpdateVTKObjects()

void vtkSMCompoundSourceProxy::UpdateVTKObjects ( )
overridevirtual

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

If the object has not been created, it will be created first.

Reimplemented from vtkSMProxy.

◆ SaveDefinition()

vtkPVXMLElement* vtkSMCompoundSourceProxy::SaveDefinition ( vtkPVXMLElement root)

This is the same as save state except it will remove all references to "outside" proxies.

Outside proxies are proxies that are not contained in the compound proxy. As a result, the saved state will be self contained. Returns the top element created. It is the caller's responsibility to delete the returned element. If root is nullptr, the returned element will be a top level element.

◆ ReadXMLAttributes()

int vtkSMCompoundSourceProxy::ReadXMLAttributes ( vtkSMSessionProxyManager pm,
vtkPVXMLElement element 
)
overrideprotectedvirtual

Read attributes from an XML element.

Reimplemented from vtkSMProxy.

◆ CreateVTKObjects()

void vtkSMCompoundSourceProxy::CreateVTKObjects ( )
overrideprotectedvirtual

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

Reimplemented from vtkSMProxy.

◆ ShouldWriteValue()

int vtkSMCompoundSourceProxy::ShouldWriteValue ( vtkPVXMLElement valueElem)
protected

◆ TraverseForProperties()

void vtkSMCompoundSourceProxy::TraverseForProperties ( vtkPVXMLElement root)
protected

◆ StripValues()

void vtkSMCompoundSourceProxy::StripValues ( vtkPVXMLElement propertyElem)
protected

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