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

#include <vtkSMProxyConfigurationReader.h>

Inheritance diagram for vtkSMProxyConfigurationReader:

[legend]

Collaboration diagram for vtkSMProxyConfigurationReader:

[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 *	GetReaderVersion ()
	Return the reader version. More...

virtual bool	CanReadVersion (const char *version)
	Return true if the reader can read the specified version. More...

virtual int	ReadConfiguration (vtkPVXMLElement *xmlStream)
	Read the configuration from the stream. More...


virtual void	SetFileName (const char *)
	Set/Get the file name. More...

virtual char *	GetFileName ()
	Set/Get the file name. 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	SetFileIdentifier (const char *)
	Set/get file meta data. More...

virtual char *	GetFileIdentifier ()
	Set/get file meta data. More...


virtual void	SetValidateProxyType (int)
	Turns on/off proxy type validation. More...

virtual int	GetValidateProxyType ()
	Turns on/off proxy type validation. More...


virtual int	ReadConfiguration ()
	Read the configuration from the file. More...

virtual int	ReadConfiguration (const char *filename)
	Read the configuration from the file. 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 vtkSMProxyConfigurationReader *	New ()

static int	IsTypeOf (const char *type)

static vtkSMProxyConfigurationReader *	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
	vtkSMProxyConfigurationReader ()

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

vtkSMProxyConfigurationReader reads 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.

The subsetting mechanism is implemented in the writer, the reader simply reads which ever properties are found.

See also: vtkSMProxyConfigurationWriter

Thanks:: This class was contribued by SciberQuest Inc.

Definition at line 36 of file vtkSMProxyConfigurationReader.h.

Member Typedef Documentation

◆ Superclass

typedef vtkSMObject vtkSMProxyConfigurationReader::Superclass

Definition at line 40 of file vtkSMProxyConfigurationReader.h.

Constructor & Destructor Documentation

◆ vtkSMProxyConfigurationReader()

vtkSMProxyConfigurationReader::vtkSMProxyConfigurationReader ( )

protected

◆ ~vtkSMProxyConfigurationReader()

vtkSMProxyConfigurationReader::~vtkSMProxyConfigurationReader ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkSMProxyConfigurationReader* vtkSMProxyConfigurationReader::New ( )

static

◆ GetClassName()

virtual const char* vtkSMProxyConfigurationReader::GetClassName ( )

virtual

Reimplemented from vtkSMObject.

Reimplemented in vtkSMCameraConfigurationReader.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkSMObject.

Reimplemented in vtkSMCameraConfigurationReader.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

◆ SetFileName()

virtual void vtkSMProxyConfigurationReader::SetFileName ( const char * )

virtual

Set/Get the file name.

◆ GetFileName()

virtual char* vtkSMProxyConfigurationReader::GetFileName ( )

virtual

Set/Get the file name.

◆ SetProxy()

virtual void vtkSMProxyConfigurationReader::SetProxy ( vtkSMProxy * proxy )

virtual

Set the proxy to write out.

Reimplemented in vtkSMCameraConfigurationReader.

◆ GetProxy()

virtual vtkSMProxy* vtkSMProxyConfigurationReader::GetProxy ( )

virtual

Set the proxy to write out.

◆ SetFileIdentifier()

virtual void vtkSMProxyConfigurationReader::SetFileIdentifier ( const char * )

virtual

Set/get file meta data.

◆ GetFileIdentifier()

virtual char* vtkSMProxyConfigurationReader::GetFileIdentifier ( )

virtual

Set/get file meta data.

◆ SetFileDescription()

virtual void vtkSMProxyConfigurationReader::SetFileDescription ( const char * )

virtual

◆ GetFileDescription()

virtual char* vtkSMProxyConfigurationReader::GetFileDescription ( )

virtual

◆ SetFileExtension()

virtual void vtkSMProxyConfigurationReader::SetFileExtension ( const char * )

virtual

◆ GetFileExtension()

virtual char* vtkSMProxyConfigurationReader::GetFileExtension ( )

virtual

◆ SetValidateProxyType()

virtual void vtkSMProxyConfigurationReader::SetValidateProxyType ( int )

virtual

Turns on/off proxy type validation.

If on then the proxy's type is compared with that found in the configuration file. The read fails if they do not match. The feature is on by default.

◆ GetValidateProxyType()

virtual int vtkSMProxyConfigurationReader::GetValidateProxyType ( )

virtual

Turns on/off proxy type validation.

If on then the proxy's type is compared with that found in the configuration file. The read fails if they do not match. The feature is on by default.

◆ GetReaderVersion()

virtual const char* vtkSMProxyConfigurationReader::GetReaderVersion ( )

inlinevirtual

Return the reader version.

Definition at line 87 of file vtkSMProxyConfigurationReader.h.

◆ CanReadVersion()

virtual bool vtkSMProxyConfigurationReader::CanReadVersion ( const char * version )

virtual

Return true if the reader can read the specified version.

◆ ReadConfiguration() [1/3]

virtual int vtkSMProxyConfigurationReader::ReadConfiguration ( )

virtual

Read the configuration from the file.

UpdateVTKObjects is intentionally not called so that caller may have full control as to when the push from client to server takes place.

Reimplemented in vtkSMCameraConfigurationReader.

◆ ReadConfiguration() [2/3]

virtual int vtkSMProxyConfigurationReader::ReadConfiguration ( const char * filename )

virtual

Read the configuration from the file.

UpdateVTKObjects is intentionally not called so that caller may have full control as to when the push from client to server takes place.

Reimplemented in vtkSMCameraConfigurationReader.

◆ ReadConfiguration() [3/3]

virtual int vtkSMProxyConfigurationReader::ReadConfiguration ( vtkPVXMLElement * xmlStream )

virtual

Read the configuration from the stream.

PV state machinery is employed.

Reimplemented in vtkSMCameraConfigurationReader.

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

/builds/gitlab-kitware-sciviz-ci/Remoting/Misc/vtkSMProxyConfigurationReader.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

◆ vtkSMProxyConfigurationReader()

◆ ~vtkSMProxyConfigurationReader()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ SetFileName()

◆ GetFileName()

◆ SetProxy()

◆ GetProxy()

◆ SetFileIdentifier()

◆ GetFileIdentifier()

◆ SetFileDescription()

◆ GetFileDescription()

◆ SetFileExtension()

◆ GetFileExtension()

◆ SetValidateProxyType()

◆ GetValidateProxyType()

◆ GetReaderVersion()

◆ CanReadVersion()

◆ ReadConfiguration() [1/3]

◆ ReadConfiguration() [2/3]

◆ ReadConfiguration() [3/3]