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

#include <vtkSMProxyConfigurationWriter.h>

Inheritance diagram for vtkSMProxyConfigurationWriter:

[legend]

Collaboration diagram for vtkSMProxyConfigurationWriter:

[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

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 vtkSMProxy *	GetProxy ()
	Set the proxy to write out. More...


virtual void	SetPropertyIterator (vtkSMPropertyIterator *iter)
	Set the ieterator used to traverse properties during the write. More...

virtual vtkSMPropertyIterator *	GetPropertyIterator ()
	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) 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)

vtkCommand *	GetCommand (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)

vtkCommand *	GetCommand (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 vtkSMProxyConfigurationWriter *	New ()

static int	IsTypeOf (const char *type)

static vtkSMProxyConfigurationWriter *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkSMObject
static vtkSMObject *	New ()

static int	IsTypeOf (const char *type)

static vtkSMObject *	SafeDownCast (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 vtkObject *	New ()

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 vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Protected Member Functions
	vtkSMProxyConfigurationWriter ()

	~vtkSMProxyConfigurationWriter () 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

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

Member Typedef Documentation

◆ Superclass

typedef vtkSMObject vtkSMProxyConfigurationWriter::Superclass

Definition at line 40 of file vtkSMProxyConfigurationWriter.h.

Constructor & Destructor Documentation

◆ vtkSMProxyConfigurationWriter()

vtkSMProxyConfigurationWriter::vtkSMProxyConfigurationWriter ( )

protected

◆ ~vtkSMProxyConfigurationWriter()

vtkSMProxyConfigurationWriter::~vtkSMProxyConfigurationWriter ( )

overrideprotected

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

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

overridevirtual

Reimplemented from vtkObject.

◆ 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 85 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:

/builds/gitlab-kitware-sciviz-ci/Remoting/Misc/vtkSMProxyConfigurationWriter.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkSMProxyConfigurationWriter()

◆ ~vtkSMProxyConfigurationWriter()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ SetProxy()

◆ GetProxy()

◆ SetPropertyIterator()

◆ GetPropertyIterator()

◆ SetFileName()

◆ GetFileName()

◆ SetFileIdentifier()

◆ GetFileIdentifier()

◆ SetFileDescription()

◆ GetFileDescription()

◆ SetFileExtension()

◆ GetFileExtension()

◆ GetWriterVersion()

◆ WriteConfiguration() [1/3]

◆ WriteConfiguration() [2/3]

◆ WriteConfiguration() [3/3]