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

vtkPVCatalystSessionCore is used by vtkSMSession. More...

#include <vtkPVCatalystSessionCore.h>

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

Public Types

typedef vtkPVSessionCore Superclass
 
- Public Types inherited from vtkPVSessionCore
enum  MessageTypes {
  PUSH_STATE = 12, PULL_STATE = 13, EXECUTE_STREAM = 14, GATHER_INFORMATION = 15,
  REGISTER_SI = 16, UNREGISTER_SI = 17
}
 
typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
bool GatherInformation (vtkTypeUInt32 location, vtkPVInformation *information, vtkTypeUInt32 globalid) override
 Gather information about an object referred by the globalid. More...
 
vtkTypeUInt32 RegisterDataInformation (vtkTypeUInt32 globalid, unsigned int port, vtkPVInformation *information)
 Update the data information for a given proxy with the given globalid. More...
 
void UpdateIdMap (vtkTypeUInt32 *idMapArray, int size)
 
void ResetIdMap ()
 
- Public Member Functions inherited from vtkPVSessionCore
void PrintSelf (ostream &os, vtkIndent indent) override
 
virtual void PushState (vtkSMMessage *message)
 Push the state message. More...
 
virtual void PullState (vtkSMMessage *message)
 Pull the state message from the local SI object instances. More...
 
virtual void ExecuteStream (vtkTypeUInt32 location, const vtkClientServerStream &stream, bool ignore_errors=false)
 Execute a command on the given processes. More...
 
virtual const vtkClientServerStreamGetLastResult ()
 Returns the response of the ExecuteStream() call from the location. More...
 
virtual void UnRegisterSIObject (vtkSMMessage *message)
 Notify that the given SIObject is not used anymore . More...
 
virtual void RegisterSIObject (vtkSMMessage *message)
 Notify that the given SIObject is used. More...
 
vtkSIObjectGetSIObject (vtkTypeUInt32 globalid)
 Returns a vtkSIObject or subclass given its global id, if any otherwise return nullptr;. More...
 
vtkObjectGetRemoteObject (vtkTypeUInt32 globalid)
 Return a vtkObject given its global id if any otherwise return nullptr;. More...
 
void RegisterRemoteObject (vtkTypeUInt32 globalid, vtkObject *obj)
 Register a remote object. More...
 
void UnRegisterRemoteObject (vtkTypeUInt32 globalid)
 Unregister a remote object. More...
 
int GetNumberOfProcesses ()
 Returns the number of processes. More...
 
virtual vtkTypeUInt32 GetNextGlobalUniqueIdentifier ()
 Provides the next available identifier. More...
 
virtual vtkTypeUInt32 GetNextChunkGlobalUniqueIdentifier (vtkTypeUInt32 chunkSize)
 Return the first Id of the requested chunk. More...
 
void PushStateSatelliteCallback ()
 
void ExecuteStreamSatelliteCallback ()
 
void GatherInformationStatelliteCallback ()
 
void RegisterSIObjectSatelliteCallback ()
 
void UnRegisterSIObjectSatelliteCallback ()
 
virtual void GetAllRemoteObjects (vtkCollection *collection)
 Allow the user to fill a vtkCollection with all RemoteObjects This is useful when you want to hold a reference to them to prevent any deletion across several method call. More...
 
void GarbageCollectSIObject (int *clientIds, int nbClients)
 Delete SIObject that are held by clients that disappeared from the given list. More...
 
virtual vtkClientServerInterpreterGetInterpreter ()
 Provides access to the interpreter. More...
 
virtual vtkSIProxyDefinitionManagerGetProxyDefinitionManager ()
 Provides access to the proxy definition manager. More...
 
void SetMPIMToNSocketConnection (vtkMPIMToNSocketConnection *)
 Get/Set the socket connection used to communicate between data=server and render-server processes. More...
 
virtual vtkMPIMToNSocketConnectionGetMPIMToNSocketConnection ()
 Get/Set the socket connection used to communicate between data=server and render-server processes. More...
 
- 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)
 
vtkCommandGetCommand (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)
 
vtkCommandGetCommand (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 vtkPVCatalystSessionCoreNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPVCatalystSessionCoreSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkPVSessionCore
static vtkPVSessionCoreNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPVSessionCoreSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 
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 vtkObjectBaseNew ()
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkPVCatalystSessionCore ()
 
 ~vtkPVCatalystSessionCore () override
 
- Protected Member Functions inherited from vtkPVSessionCore
 vtkPVSessionCore ()
 
 ~vtkPVSessionCore () override
 
virtual void PushStateInternal (vtkSMMessage *)
 This will create a vtkSIObject and/or execute some update on the vtkObject that it own. More...
 
virtual void ExecuteStreamInternal (const vtkClientServerStream &stream, bool ignore_errors)
 This will execute localy the given vtkClientServerStream either by calling method on the vtkSIObject or its internal vtkObject. More...
 
bool GatherInformationInternal (vtkPVInformation *information, vtkTypeUInt32 globalid)
 This will gather information on the local vtkObjects through the local vtkSIObjects. More...
 
bool CollectInformation (vtkPVInformation *)
 Gather information across MPI satellites. More...
 
virtual void RegisterSIObjectInternal (vtkSMMessage *message)
 Increment reference count of a local vtkSIObject. More...
 
virtual void UnRegisterSIObjectInternal (vtkSMMessage *message)
 Decrement reference count of a local vtkSIObject. More...
 
void OnInterpreterError (vtkObject *, unsigned long, void *calldata)
 Callback for reporting interpreter errors. More...
 
- 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 Types inherited from vtkPVSessionCore
enum  { ROOT_SATELLITE_RMI_TAG = 887822, ROOT_SATELLITE_INFO_TAG = 887823 }
 
- Protected Attributes inherited from vtkPVSessionCore
vtkSIProxyDefinitionManagerProxyDefinitionManager
 
vtkWeakPointer< vtkMultiProcessControllerParallelController
 
vtkClientServerInterpreterInterpreter
 
vtkMPIMToNSocketConnectionMPIMToNSocketConnection
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

vtkPVCatalystSessionCore is used by vtkSMSession.

vtkPVCatalystSessionCore handle catalyst based proxy which don't contains any real data and therefore are not allowed to execute the VTK pipeline.

Definition at line 22 of file vtkPVCatalystSessionCore.h.

Member Typedef Documentation

◆ Superclass

Definition at line 26 of file vtkPVCatalystSessionCore.h.

Constructor & Destructor Documentation

◆ vtkPVCatalystSessionCore()

vtkPVCatalystSessionCore::vtkPVCatalystSessionCore ( )
protected

◆ ~vtkPVCatalystSessionCore()

vtkPVCatalystSessionCore::~vtkPVCatalystSessionCore ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkPVCatalystSessionCore* vtkPVCatalystSessionCore::New ( )
static

◆ GetClassName()

virtual const char* vtkPVCatalystSessionCore::GetClassName ( )
virtual

Reimplemented from vtkPVSessionCore.

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkPVSessionCore.

◆ SafeDownCast()

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

◆ PrintSelf()

void vtkPVCatalystSessionCore::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Reimplemented from vtkObject.

◆ GatherInformation()

bool vtkPVCatalystSessionCore::GatherInformation ( vtkTypeUInt32  location,
vtkPVInformation information,
vtkTypeUInt32  globalid 
)
overridevirtual

Gather information about an object referred by the globalid.

location identifies the processes to gather the information from.

Reimplemented from vtkPVSessionCore.

◆ RegisterDataInformation()

vtkTypeUInt32 vtkPVCatalystSessionCore::RegisterDataInformation ( vtkTypeUInt32  globalid,
unsigned int  port,
vtkPVInformation information 
)

Update the data information for a given proxy with the given globalid.

This will allow the GatherInformation to work with "fake" VTK pipeline. Return the real corresponding proxy id

◆ UpdateIdMap()

void vtkPVCatalystSessionCore::UpdateIdMap ( vtkTypeUInt32 *  idMapArray,
int  size 
)

◆ ResetIdMap()

void vtkPVCatalystSessionCore::ResetIdMap ( )

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