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

used to build a vtkSMCompoundSourceProxy definition. More...

#include <vtkSMCompoundSourceProxyDefinitionBuilder.h>

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

Public Types

typedef vtkSMObject Superclass
 
- Public Types inherited from vtkSMObject
typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void Reset ()
 Resets the builder. More...
 
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...
 
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 vtkSMObject
void PrintSelf (ostream &os, vtkIndent indent) override
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual vtkMTimeType GetMTime ()
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
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 vtkSMCompoundSourceProxyDefinitionBuilderNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMCompoundSourceProxyDefinitionBuilderSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMObject
static vtkSMObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMObjectSafeDownCast (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 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

 vtkSMCompoundSourceProxyDefinitionBuilder ()
 
 ~vtkSMCompoundSourceProxyDefinitionBuilder () override
 
- Protected Member Functions inherited from vtkSMObject
 vtkSMObject ()
 
 ~vtkSMObject () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

used to build a vtkSMCompoundSourceProxy definition.

vtkSMCompoundSourceProxyDefinitionBuilder is used to create a XML definition for a compound-proxy consisting of other proxies. This class can only build one compound-proxy definition at a time. Use Reset() to start a new definition.

See also
vtkSMCompoundSourceProxy

Definition at line 25 of file vtkSMCompoundSourceProxyDefinitionBuilder.h.

Member Typedef Documentation

◆ Superclass

Definition at line 29 of file vtkSMCompoundSourceProxyDefinitionBuilder.h.

Constructor & Destructor Documentation

◆ vtkSMCompoundSourceProxyDefinitionBuilder()

vtkSMCompoundSourceProxyDefinitionBuilder::vtkSMCompoundSourceProxyDefinitionBuilder ( )
protected

◆ ~vtkSMCompoundSourceProxyDefinitionBuilder()

vtkSMCompoundSourceProxyDefinitionBuilder::~vtkSMCompoundSourceProxyDefinitionBuilder ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkSMCompoundSourceProxyDefinitionBuilder* vtkSMCompoundSourceProxyDefinitionBuilder::New ( )
static

◆ GetClassName()

virtual const char* vtkSMCompoundSourceProxyDefinitionBuilder::GetClassName ( )
virtual

Reimplemented from vtkSMObject.

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkSMObject.

◆ SafeDownCast()

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

◆ PrintSelf()

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

Reimplemented from vtkObject.

◆ Reset()

void vtkSMCompoundSourceProxyDefinitionBuilder::Reset ( )

Resets the builder.

This can be used when using the builder to create multiple definitions.

◆ AddProxy()

void vtkSMCompoundSourceProxyDefinitionBuilder::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 vtkSMCompoundSourceProxyDefinitionBuilder::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 vtkSMCompoundSourceProxyDefinitionBuilder::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 vtkSMCompoundSourceProxyDefinitionBuilder::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 vtkSMCompoundSourceProxyDefinitionBuilder::GetNumberOfProxies ( )

Returns the number of sub-proxies.

◆ GetProxy() [1/2]

vtkSMProxy* vtkSMCompoundSourceProxyDefinitionBuilder::GetProxy ( unsigned int  cc)

Returns the sub proxy at a given index.

◆ GetProxy() [2/2]

vtkSMProxy* vtkSMCompoundSourceProxyDefinitionBuilder::GetProxy ( const char *  name)

Returns the subproxy with the given name.

◆ GetProxyName()

const char* vtkSMCompoundSourceProxyDefinitionBuilder::GetProxyName ( unsigned int  index)

Returns the name used to store sub-proxy.

Returns 0 if sub-proxy does not exist.

◆ SaveDefinition()

vtkPVXMLElement* vtkSMCompoundSourceProxyDefinitionBuilder::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.


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