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

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

#include <vtkSMProxyConfigurationWriter.h>

Inheritance diagram for vtkSMProxyConfigurationWriter:
Inheritance graph
[legend]
Collaboration diagram for vtkSMProxyConfigurationWriter:
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)
 
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 ()
 Return the writer version string. More...
 
virtual int WriteConfiguration (ostream &os)
 Write the proxy's state to a stream, in PV state format. More...
 
virtual void SetProxy (vtkSMProxy *proxy)
 Set the proxy to write out. More...
 
virtual vtkSMProxyGetProxy ()
 Set the proxy to write out. More...
 
virtual void SetPropertyIterator (vtkSMPropertyIterator *iter)
 Set the ieterator used to traverse properties during the write. More...
 
virtual vtkSMPropertyIteratorGetPropertyIterator ()
 Set the ieterator used to traverse properties during the write. More...
 
virtual void SetFileName (const char *)
 Set/Get the file name. More...
 
virtual char * GetFileName ()
 Set/Get the file name. More...
 
virtual void SetFileIdentifier (const char *)
 Set/get file meta data. More...
 
virtual char * GetFileIdentifier ()
 Set/get file meta data. More...
 
virtual int WriteConfiguration ()
 Write the proxy's state directly to an XML file, in PV state format. More...
 
virtual int WriteConfiguration (const char *fileName)
 Write the proxy's state directly to an XML file, in PV state format. More...
 
- Public Member Functions inherited from vtkSMObject
void PrintSelf (ostream &os, vtkIndent indent)
 

Static Public Member Functions

static vtkSMProxyConfigurationWriterNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMProxyConfigurationWriterSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMObject
static vtkSMObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMObjectSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkSMProxyConfigurationWriter ()
 
virtual ~vtkSMProxyConfigurationWriter ()
 
- Protected Member Functions inherited from vtkSMObject
 vtkSMObject ()
 
 ~vtkSMObject ()
 

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 48 of file vtkSMProxyConfigurationWriter.h.

Member Typedef Documentation

§ Superclass

Definition at line 52 of file vtkSMProxyConfigurationWriter.h.

Constructor & Destructor Documentation

§ vtkSMProxyConfigurationWriter()

vtkSMProxyConfigurationWriter::vtkSMProxyConfigurationWriter ( )
protected

§ ~vtkSMProxyConfigurationWriter()

virtual vtkSMProxyConfigurationWriter::~vtkSMProxyConfigurationWriter ( )
protectedvirtual

Member Function Documentation

§ New()

static vtkSMProxyConfigurationWriter* vtkSMProxyConfigurationWriter::New ( )
static

§ GetClassName()

virtual const char* vtkSMProxyConfigurationWriter::GetClassName ( )
virtual

Reimplemented from vtkSMObject.

Reimplemented in vtkSMCameraConfigurationWriter.

§ IsTypeOf()

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

§ IsA()

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

Reimplemented from vtkSMObject.

Reimplemented in vtkSMCameraConfigurationWriter.

§ SafeDownCast()

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

§ PrintSelf()

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

Reimplemented in vtkSMCameraConfigurationWriter.

§ SetProxy()

virtual void vtkSMProxyConfigurationWriter::SetProxy ( vtkSMProxy proxy)
virtual

Set the proxy to write out.

Reimplemented in vtkSMCameraConfigurationWriter.

§ GetProxy()

virtual vtkSMProxy* vtkSMProxyConfigurationWriter::GetProxy ( )
virtual

Set the proxy to write out.

§ SetPropertyIterator()

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.

§ GetPropertyIterator()

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.

§ SetFileName()

virtual void vtkSMProxyConfigurationWriter::SetFileName ( const char *  )
virtual

Set/Get the file name.

§ GetFileName()

virtual char* vtkSMProxyConfigurationWriter::GetFileName ( )
virtual

Set/Get the file name.

§ SetFileIdentifier()

virtual void vtkSMProxyConfigurationWriter::SetFileIdentifier ( const char *  )
virtual

Set/get file meta data.

§ GetFileIdentifier()

virtual char* vtkSMProxyConfigurationWriter::GetFileIdentifier ( )
virtual

Set/get file meta data.

§ SetFileDescription()

virtual void vtkSMProxyConfigurationWriter::SetFileDescription ( const char *  )
virtual

§ GetFileDescription()

virtual char* vtkSMProxyConfigurationWriter::GetFileDescription ( )
virtual

§ SetFileExtension()

virtual void vtkSMProxyConfigurationWriter::SetFileExtension ( const char *  )
virtual

§ GetFileExtension()

virtual char* vtkSMProxyConfigurationWriter::GetFileExtension ( )
virtual

§ GetWriterVersion()

virtual const char* vtkSMProxyConfigurationWriter::GetWriterVersion ( )
inlinevirtual

Return the writer version string.

Definition at line 97 of file vtkSMProxyConfigurationWriter.h.

§ WriteConfiguration() [1/3]

virtual int vtkSMProxyConfigurationWriter::WriteConfiguration ( )
virtual

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

§ WriteConfiguration() [2/3]

virtual int vtkSMProxyConfigurationWriter::WriteConfiguration ( const char *  fileName)
virtual

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

§ WriteConfiguration() [3/3]

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: