vtkSMProxyConfigurationWriter Class Reference

Base readers of a vtkSMProxy's vtkSMProperty's. More...

#include <vtkSMProxyConfigurationWriter.h>

Inheritance diagram for vtkSMProxyConfigurationWriter:

Collaboration diagram for vtkSMProxyConfigurationWriter:

List of all members.

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
virtual void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetFileDescription (const char *)
virtual char *	GetFileDescription ()
virtual void	SetFileExtension (const char *)
virtual char *	GetFileExtension ()
virtual const char *	GetWriterVersion ()
virtual int	WriteConfiguration (ostream &os)
virtual void	SetProxy (vtkSMProxy *proxy)
virtual vtkSMProxy *	GetProxy ()
virtual void	SetPropertyIterator (vtkSMPropertyIterator *iter)
virtual vtkSMPropertyIterator *	GetPropertyIterator ()
virtual void	SetFileName (const char *)
virtual char *	GetFileName ()
virtual void	SetFileIdentifier (const char *)
virtual char *	GetFileIdentifier ()
virtual int	WriteConfiguration ()
virtual int	WriteConfiguration (const char *fileName)
Static Public Member Functions
static vtkSMProxyConfigurationWriter *	New ()
static int	IsTypeOf (const char *type)
static vtkSMProxyConfigurationWriter *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkSMProxyConfigurationWriter ()
virtual	~vtkSMProxyConfigurationWriter ()

---

Detailed Description

Base readers of a vtkSMProxy's vtkSMProperty's.

vtkSMProxyConfigurationWriter writes state for properties for a single proxy. Internally the ParaView state machinery is employed.

The notion of proxy configuration is similar to state but lighter as the proxy its domains and and its server side objects are assumed to already exist. Configuration also provides subseting mechanism so that properties may be excluded if needed.

Subsetting is achieved through a specialized iterator derived from vtkSMPropertyIterator.

See also:

vtkSMProxyConfigurationReader, vtkSMPropertyIterator, vtkSMNamedPropertyIterator

Thanks:

This class was contribued by SciberQuest Inc.

Definition at line 46 of file vtkSMProxyConfigurationWriter.h.

---

Constructor & Destructor Documentation

vtkSMProxyConfigurationWriter::vtkSMProxyConfigurationWriter

(

)

[protected]

virtual vtkSMProxyConfigurationWriter::~vtkSMProxyConfigurationWriter

(

)

[protected, virtual]

---

Member Function Documentation

static vtkSMProxyConfigurationWriter* vtkSMProxyConfigurationWriter::New

(

)

[static]

Reimplemented from vtkSMObject.

Reimplemented in vtkSMCameraConfigurationWriter.

virtual const char* vtkSMProxyConfigurationWriter::GetClassName

(

)

[virtual]

Reimplemented from vtkSMObject.

Reimplemented in vtkSMCameraConfigurationWriter.

static int vtkSMProxyConfigurationWriter::IsTypeOf

(

const char *

type

)

[static]

Reimplemented from vtkSMObject.

Reimplemented in vtkSMCameraConfigurationWriter.

virtual int vtkSMProxyConfigurationWriter::IsA

(

const char *

type

)

[virtual]

Reimplemented from vtkSMObject.

Reimplemented in vtkSMCameraConfigurationWriter.

static vtkSMProxyConfigurationWriter* vtkSMProxyConfigurationWriter::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkSMObject.

Reimplemented in vtkSMCameraConfigurationWriter.

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

Reimplemented from vtkSMObject.

Reimplemented in vtkSMCameraConfigurationWriter.

virtual void vtkSMProxyConfigurationWriter::SetProxy

(

vtkSMProxy *

proxy

)

[virtual]

Set the proxy to write out.

Reimplemented in vtkSMCameraConfigurationWriter.

virtual vtkSMProxy* vtkSMProxyConfigurationWriter::GetProxy

(

)

[virtual]

Set the proxy to write out.

virtual void vtkSMProxyConfigurationWriter::SetPropertyIterator

(

vtkSMPropertyIterator *

iter

)

[virtual]

Set the ieterator used to traverse properties during the write. If no iterator is set then all properties are written.

virtual vtkSMPropertyIterator* vtkSMProxyConfigurationWriter::GetPropertyIterator

(

)

[virtual]

Set the ieterator used to traverse properties during the write. If no iterator is set then all properties are written.

virtual void vtkSMProxyConfigurationWriter::SetFileName

(

const char *

)

[virtual]

Set/Get the file name.

virtual char* vtkSMProxyConfigurationWriter::GetFileName

(

)

[virtual]

Set/Get the file name.

virtual void vtkSMProxyConfigurationWriter::SetFileIdentifier

(

const char *

)

[virtual]

Set/get file meta data.

virtual char* vtkSMProxyConfigurationWriter::GetFileIdentifier

(

)

[virtual]

Set/get file meta data.

virtual void vtkSMProxyConfigurationWriter::SetFileDescription

(

const char *

)

[virtual]

virtual char* vtkSMProxyConfigurationWriter::GetFileDescription

(

)

[virtual]

virtual void vtkSMProxyConfigurationWriter::SetFileExtension

(

const char *

)

[virtual]

virtual char* vtkSMProxyConfigurationWriter::GetFileExtension

(

)

[virtual]

virtual const char* vtkSMProxyConfigurationWriter::GetWriterVersion

(

)

[inline, virtual]

Return the writer version string.

Definition at line 85 of file vtkSMProxyConfigurationWriter.h.

virtual int vtkSMProxyConfigurationWriter::WriteConfiguration

(

)

[virtual]

Write the proxy's state directly to an XML file, in PV state format.

virtual int vtkSMProxyConfigurationWriter::WriteConfiguration

(

const char *

fileName

)

[virtual]

Write the proxy's state directly to an XML file, in PV state format.

virtual int vtkSMProxyConfigurationWriter::WriteConfiguration

(

ostream &

os

)

[virtual]

Write the proxy's state to a stream, in PV state format.

---

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

• dox/ParaViewCore/ServerManager/vtkSMProxyConfigurationWriter.h