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

is used to locate proxies referred to in state xmls while loading state files. More...

#include <vtkSMProxyLocator.h>

Inheritance diagram for vtkSMProxyLocator:
Inheritance graph
[legend]
Collaboration diagram for vtkSMProxyLocator:
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)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual vtkSMProxyLocateProxy (vtkTypeUInt32 globalID)
 Locate a proxy with the given "name". More...
 
virtual void Clear ()
 Clear the locator. More...
 
virtual void GetLocatedProxies (vtkCollection *collectionToFill)
 Copy all the Located proxy into the collection. More...
 
virtual void UseSessionToLocateProxy (bool useSessionToo)
 
virtual void AssignProxy (vtkTypeUInt32 id, vtkSMProxy *proxy)
 For custom applications managing custom state loading, one can use this method to register proxies with locator to use when LocateProxy() before attempting the standard route i.e. More...
 
void SetDeserializer (vtkSMDeserializer *)
 Get/Set the de-serializer to used to locate XMLs/Protobuf for unknown proxies requested to be located using LocateProxy(). More...
 
virtual vtkSMDeserializerGetDeserializer ()
 Get/Set the de-serializer to used to locate XMLs/Protobuf for unknown proxies requested to be located using LocateProxy(). More...
 
virtual vtkSMSessionGetSession ()
 Get/Set the session. More...
 
virtual void SetSession (vtkSMSession *s)
 Get/Set the session. More...
 
- Public Member Functions inherited from vtkSMObject
void PrintSelf (ostream &os, vtkIndent indent)
 

Static Public Member Functions

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

Protected Member Functions

 vtkSMProxyLocator ()
 
 ~vtkSMProxyLocator ()
 
virtual vtkSMProxyNewProxy (vtkTypeUInt32 globalID)
 Create new proxy with the given id. More...
 
- Protected Member Functions inherited from vtkSMObject
 vtkSMObject ()
 
 ~vtkSMObject ()
 

Protected Attributes

vtkSMDeserializerDeserializer
 
vtkWeakPointer< vtkSMSessionSession
 
bool LocateProxyWithSessionToo
 

Detailed Description

is used to locate proxies referred to in state xmls while loading state files.

vtkSMProxyLocator is used to locate proxies referred to in state xmls (and otherwise) when loading state files.

Definition at line 36 of file vtkSMProxyLocator.h.

Member Typedef Documentation

◆ Superclass

Definition at line 40 of file vtkSMProxyLocator.h.

Constructor & Destructor Documentation

◆ vtkSMProxyLocator()

vtkSMProxyLocator::vtkSMProxyLocator ( )
protected

◆ ~vtkSMProxyLocator()

vtkSMProxyLocator::~vtkSMProxyLocator ( )
protected

Member Function Documentation

◆ New()

static vtkSMProxyLocator* vtkSMProxyLocator::New ( )
static

◆ GetClassName()

virtual const char* vtkSMProxyLocator::GetClassName ( )
virtual

Reimplemented from vtkSMObject.

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkSMObject.

◆ SafeDownCast()

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

◆ PrintSelf()

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

◆ LocateProxy()

virtual vtkSMProxy* vtkSMProxyLocator::LocateProxy ( vtkTypeUInt32  globalID)
virtual

Locate a proxy with the given "name".

If none can be found returns NULL. If a proxy with the name was not previously located, it will ask the Deserializer (if any) to create a new proxy is possible.

◆ SetDeserializer()

void vtkSMProxyLocator::SetDeserializer ( vtkSMDeserializer )

Get/Set the de-serializer to used to locate XMLs/Protobuf for unknown proxies requested to be located using LocateProxy().

◆ GetDeserializer()

virtual vtkSMDeserializer* vtkSMProxyLocator::GetDeserializer ( )
virtual

Get/Set the de-serializer to used to locate XMLs/Protobuf for unknown proxies requested to be located using LocateProxy().

◆ GetSession()

virtual vtkSMSession* vtkSMProxyLocator::GetSession ( )
virtual

Get/Set the session.

◆ SetSession()

virtual void vtkSMProxyLocator::SetSession ( vtkSMSession s)
virtual

Get/Set the session.

◆ Clear()

virtual void vtkSMProxyLocator::Clear ( )
virtual

Clear the locator.

◆ GetLocatedProxies()

virtual void vtkSMProxyLocator::GetLocatedProxies ( vtkCollection *  collectionToFill)
virtual

Copy all the Located proxy into the collection.

This allow to keep a reference to them outside of the current locator. This is needed if we don't want to delete those proxy and if we want to Clear() the current ProxyLocator.

◆ UseSessionToLocateProxy()

virtual void vtkSMProxyLocator::UseSessionToLocateProxy ( bool  useSessionToo)
inlinevirtual

Definition at line 80 of file vtkSMProxyLocator.h.

◆ AssignProxy()

virtual void vtkSMProxyLocator::AssignProxy ( vtkTypeUInt32  id,
vtkSMProxy proxy 
)
virtual

For custom applications managing custom state loading, one can use this method to register proxies with locator to use when LocateProxy() before attempting the standard route i.e.

using the deserializer or session.

◆ NewProxy()

virtual vtkSMProxy* vtkSMProxyLocator::NewProxy ( vtkTypeUInt32  globalID)
protectedvirtual

Create new proxy with the given id.

Default implementation asks the Deserializer, if any, to create a new proxy.

Member Data Documentation

◆ Deserializer

vtkSMDeserializer* vtkSMProxyLocator::Deserializer
protected

Definition at line 103 of file vtkSMProxyLocator.h.

◆ Session

vtkWeakPointer<vtkSMSession> vtkSMProxyLocator::Session
protected

Definition at line 104 of file vtkSMProxyLocator.h.

◆ LocateProxyWithSessionToo

bool vtkSMProxyLocator::LocateProxyWithSessionToo
protected

Definition at line 105 of file vtkSMProxyLocator.h.


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