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

class that manage the state of the processing pipeline More...

#include <vtkSMPipelineState.h>

Inheritance diagram for vtkSMPipelineState:
Inheritance graph
[legend]
Collaboration diagram for vtkSMPipelineState:
Collaboration graph
[legend]

Public Types

typedef vtkSMRemoteObject Superclass
 
- Public Types inherited from vtkSMRemoteObject
typedef vtkSMSessionObject Superclass
 
- Public Types inherited from vtkSMSessionObject
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 const vtkSMMessageGetFullState ()
 This method return the full object state that can be used to create that object from scratch. More...
 
virtual void LoadState (const vtkSMMessage *msg, vtkSMProxyLocator *locator)
 This method is used to initialise the object to the given state. More...
 
void ValidateState ()
 
- Public Member Functions inherited from vtkSMRemoteObject
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetSession (vtkSMSession *)
 Override the SetSession so if the object already have an ID we automatically register it to the associated session. More...
 
bool HasGlobalID ()
 Allow the user to test if the RemoteObject has already a GlobalID without assigning a new one to it. More...
 
virtual void EnableLocalPushOnly ()
 Allow to switch off any push of state change to the server for that particular object. More...
 
virtual void DisableLocalPushOnly ()
 Enable the given remote object to communicate its state normaly to the server location. More...
 
virtual bool IsLocalPushOnly ()
 Let the session be aware that even if the Location is client only, the message should not be send to the server for a general broadcast. More...
 
virtual void SetLocation (vtkTypeUInt32)
 Get/Set the location where the underlying VTK-objects are created. More...
 
virtual vtkTypeUInt32 GetLocation ()
 Get/Set the location where the underlying VTK-objects are created. More...
 
virtual vtkTypeUInt32 GetGlobalID ()
 Get the global unique id for this object. More...
 
const char * GetGlobalIDAsString ()
 Get the global unique id for this object. More...
 
virtual void PrototypeOn ()
 Allow user to set the remote object to be discard for Undo/Redo action. More...
 
virtual void PrototypeOff ()
 Allow user to set the remote object to be discard for Undo/Redo action. More...
 
bool IsPrototype ()
 Allow user to set the remote object to be discard for Undo/Redo action. More...
 
virtual void SetPrototype (bool)
 Allow user to set the remote object to be discard for Undo/Redo action. More...
 
- Public Member Functions inherited from vtkSMSessionObject
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual vtkSMSessionProxyManagerGetSessionProxyManager ()
 Return the corresponding ProxyManager if any. More...
 
virtual vtkSMSessionGetSession ()
 Get/Set the session on wihch this object exists. More...
 
- Public Member Functions inherited from vtkSMObject
void PrintSelf (ostream &os, vtkIndent indent)
 

Static Public Member Functions

static vtkSMPipelineStateNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMPipelineStateSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMRemoteObject
static int IsTypeOf (const char *type)
 
static vtkSMRemoteObjectSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMSessionObject
static vtkSMSessionObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMSessionObjectSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMObject
static vtkSMObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMObjectSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkSMPipelineState ()
 Default constructor. More...
 
virtual ~vtkSMPipelineState ()
 Destructor. More...
 
- Protected Member Functions inherited from vtkSMRemoteObject
 vtkSMRemoteObject ()
 Default constructor. More...
 
virtual ~vtkSMRemoteObject ()
 Destructor. More...
 
void PushState (vtkSMMessage *msg)
 Subclasses can call this method to send a message to its state object on the server processes specified. More...
 
bool PullState (vtkSMMessage *msg)
 Subclasses can call this method to pull the state from the state-object on the server processes specified. More...
 
void SetGlobalID (vtkTypeUInt32 guid)
 Set the GlobalUniqueId. More...
 
vtkTypeUInt32 GetFilteredLocation ()
 
- Protected Member Functions inherited from vtkSMSessionObject
 vtkSMSessionObject ()
 
 ~vtkSMSessionObject ()
 
- Protected Member Functions inherited from vtkSMObject
 vtkSMObject ()
 
 ~vtkSMObject ()
 

Friends

class vtkSMSessionProxyManager
 

Additional Inherited Members

- Protected Attributes inherited from vtkSMRemoteObject
vtkTypeUInt32 GlobalID
 
vtkTypeUInt32 Location
 
bool Prototype
 
bool ClientOnlyLocationFlag
 
- Protected Attributes inherited from vtkSMSessionObject
vtkWeakPointer< vtkSMSessionSession
 

Detailed Description

class that manage the state of the processing pipeline

This class is used to provide a RemoteObject API to the vtkSMProxyManager which allow Undo/Redo and state sharing across several ParaView clients. Basically, we expose the state management API of RemoteObject to handle registration and unregistration of proxies.

Definition at line 37 of file vtkSMPipelineState.h.

Member Typedef Documentation

§ Superclass

Definition at line 44 of file vtkSMPipelineState.h.

Constructor & Destructor Documentation

§ vtkSMPipelineState()

vtkSMPipelineState::vtkSMPipelineState ( )
protected

Default constructor.

§ ~vtkSMPipelineState()

virtual vtkSMPipelineState::~vtkSMPipelineState ( )
protectedvirtual

Destructor.

Member Function Documentation

§ New()

static vtkSMPipelineState* vtkSMPipelineState::New ( )
static

§ GetClassName()

virtual const char* vtkSMPipelineState::GetClassName ( )
virtual

Reimplemented from vtkSMRemoteObject.

§ IsTypeOf()

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

§ IsA()

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

Reimplemented from vtkSMRemoteObject.

§ SafeDownCast()

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

§ PrintSelf()

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

§ GetFullState()

virtual const vtkSMMessage* vtkSMPipelineState::GetFullState ( )
virtual

This method return the full object state that can be used to create that object from scratch.

This method will be used to fill the undo stack. If not overriden this will return NULL.

Reimplemented from vtkSMRemoteObject.

§ LoadState()

virtual void vtkSMPipelineState::LoadState ( const vtkSMMessage msg,
vtkSMProxyLocator locator 
)
virtual

This method is used to initialise the object to the given state.

Reimplemented from vtkSMRemoteObject.

§ ValidateState()

void vtkSMPipelineState::ValidateState ( )

Friends And Related Function Documentation

§ vtkSMSessionProxyManager

friend class vtkSMSessionProxyManager
friend

Definition at line 40 of file vtkSMPipelineState.h.


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