vtkSMCompoundSourceProxyDefinitionBuilder Class Reference

used to build a vtkSMCompoundSourceProxy definition. More...

#include <vtkSMCompoundSourceProxyDefinitionBuilder.h>

Inheritance diagram for vtkSMCompoundSourceProxyDefinitionBuilder:

Collaboration diagram for vtkSMCompoundSourceProxyDefinitionBuilder:

List of all members.

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	Reset ()
void	AddProxy (const char *name, vtkSMProxy *proxy)
unsigned int	GetNumberOfProxies ()
vtkSMProxy *	GetProxy (unsigned int cc)
vtkSMProxy *	GetProxy (const char *name)
const char *	GetProxyName (unsigned int index)
vtkPVXMLElement *	SaveDefinition (vtkPVXMLElement *root)
void	ExposeProperty (const char *proxyName, const char *propertyName, const char *exposedName)
void	ExposeOutputPort (const char *proxyName, const char *portName, const char *exposedName)
void	ExposeOutputPort (const char *proxyName, unsigned int portIndex, const char *exposedName)
Static Public Member Functions
static vtkSMCompoundSourceProxyDefinitionBuilder *	New ()
static int	IsTypeOf (const char *type)
static vtkSMCompoundSourceProxyDefinitionBuilder *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkSMCompoundSourceProxyDefinitionBuilder ()
	~vtkSMCompoundSourceProxyDefinitionBuilder ()

---

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 35 of file vtkSMCompoundSourceProxyDefinitionBuilder.h.

---

Constructor & Destructor Documentation

vtkSMCompoundSourceProxyDefinitionBuilder::vtkSMCompoundSourceProxyDefinitionBuilder

(

)

[protected]

vtkSMCompoundSourceProxyDefinitionBuilder::~vtkSMCompoundSourceProxyDefinitionBuilder

(

)

[protected]

---

Member Function Documentation

static vtkSMCompoundSourceProxyDefinitionBuilder* vtkSMCompoundSourceProxyDefinitionBuilder::New

(

)

[static]

Reimplemented from vtkSMObject.

virtual const char* vtkSMCompoundSourceProxyDefinitionBuilder::GetClassName

(

)

[virtual]

Reimplemented from vtkSMObject.

static int vtkSMCompoundSourceProxyDefinitionBuilder::IsTypeOf

(

const char *

type

)

[static]

Reimplemented from vtkSMObject.

virtual int vtkSMCompoundSourceProxyDefinitionBuilder::IsA

(

const char *

type

)

[virtual]

Reimplemented from vtkSMObject.

static vtkSMCompoundSourceProxyDefinitionBuilder* vtkSMCompoundSourceProxyDefinitionBuilder::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkSMObject.

void vtkSMCompoundSourceProxyDefinitionBuilder::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)		[virtual]

Reimplemented from vtkSMObject.

void vtkSMCompoundSourceProxyDefinitionBuilder::Reset

(

)

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

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.

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().

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().

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().

unsigned int vtkSMCompoundSourceProxyDefinitionBuilder::GetNumberOfProxies

(

)

Returns the number of sub-proxies.

vtkSMProxy* vtkSMCompoundSourceProxyDefinitionBuilder::GetProxy

(

unsigned int

cc

)

Returns the sub proxy at a given index.

vtkSMProxy* vtkSMCompoundSourceProxyDefinitionBuilder::GetProxy

(

const char *

name

)

Returns the subproxy with the given name.

const char* vtkSMCompoundSourceProxyDefinitionBuilder::GetProxyName

(

unsigned int

index

)

Returns the name used to store sub-proxy. Returns 0 if sub-proxy does not exist.

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 NULL, the returned element will be a top level element.

---

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

• dox/ParaViewCore/ServerManager/vtkSMCompoundSourceProxyDefinitionBuilder.h