Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkSMSessionObject Class Reference

superclass for any server manager classes that are related to a session More...

#include <vtkSMSessionObject.h>

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

Classes

class  vtkScopedMonitorProgress
 Helper class designed to call session->PrepareProgress() in constructor and session->CleanupPendingProgress() in destructor. More...
 

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 vtkSMSessionProxyManagerGetSessionProxyManager ()
 Return the corresponding ProxyManager if any. More...
 
virtual void SetSession (vtkSMSession *)
 Get/Set the session on wihch this object exists. More...
 
virtual vtkSMSessionGetSession ()
 Get/Set the session on wihch this object exists. 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 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)
 
- 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

 vtkSMSessionObject ()
 
 ~vtkSMSessionObject () 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 &)
 

Protected Attributes

vtkWeakPointer< vtkSMSessionSession
 Identifies the session id to which this object is related. More...
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

superclass for any server manager classes that are related to a session

vtkSMSessionObject provides methods to set and get the relative session

Definition at line 33 of file vtkSMSessionObject.h.

Member Typedef Documentation

◆ Superclass

Definition at line 37 of file vtkSMSessionObject.h.

Constructor & Destructor Documentation

◆ vtkSMSessionObject()

vtkSMSessionObject::vtkSMSessionObject ( )
protected

◆ ~vtkSMSessionObject()

vtkSMSessionObject::~vtkSMSessionObject ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkSMSessionObject* vtkSMSessionObject::New ( )
static

◆ GetClassName()

virtual const char* vtkSMSessionObject::GetClassName ( )
virtual

Reimplemented from vtkSMObject.

Reimplemented in vtkSMProxy, vtkSMSessionProxyManager, vtkSMMultiplexerSourceProxy, vtkSMRepresentationProxy, vtkSMCompositeTreeDomain, vtkSMArrayListDomain, vtkSMSubsetInclusionLatticeDomain, vtkSMEnumerationDomain, vtkSMInputArrayDomain, vtkSMBoundsDomain, vtkSMSettingsProxy, vtkSMDataTypeDomain, vtkSMDataAssemblyDomain, vtkSMFieldDataDomain, vtkSMViewProxy, vtkSMCollaborationManager, vtkSMChartSeriesSelectionDomain, vtkSMProxyListDomain, vtkSMViewLayoutProxy, vtkSMDomain, vtkSMSourceProxy, vtkSMSILDomain, vtkSMOutputPort, vtkSMChartSeriesListDomain, vtkSMLoadStateOptionsProxy, vtkSMPVMoleculeRepresentationProxy, vtkSMCompoundSourceProxy, vtkSMSelfGeneratingSourceProxy, vtkSMStringListDomain, vtkSMDoubleRangeDomain, vtkSMFileUtilities, vtkSMRangedTransferFunctionDomain, vtkSMDimensionsDomain, vtkSMIntRangeDomain, vtkSMSaveScreenshotProxy, vtkSMDataDeliveryManagerProxy, vtkSMPVRepresentationProxy, vtkSMPipelineState, vtkSMProxyGroupDomain, vtkSMProxySelectionModel, vtkSMRemoteObject, vtkSMNewWidgetRepresentationProxy, vtkSMArraySelectionDomain, vtkSMRenderViewProxy, vtkSMRepresentationTypeDomain, vtkSMSaveAnimationProxy, vtkSMDiscreteDoubleDomain, vtkSMChartUseIndexForAxisDomain, vtkSMContextViewProxy, vtkSMRepresentedArrayListDomain, vtkSMSaveAnimationExtractsProxy, vtkSMLiveInsituLinkProxy, vtkSMNumberOfComponentsDomain, vtkSMAMRLevelsDomain, vtkSMFixedTypeDomain, vtkSMProxyDefinitionManager, vtkSMComparativeViewProxy, vtkSMMaterialDomain, vtkSMArrayRangeDomain, vtkSMExtentDomain, vtkSMLink, vtkSMTransferFunctionProxy, vtkSMPythonViewProxy, vtkSMAnimationSceneGeometryWriter, vtkSMInputFileNameDomain, vtkSMProxyLink, vtkSMTimeStepIndexDomain, vtkSMComparativeAnimationCueProxy, vtkPVRepresentationAnimationHelper, vtkSMCSVExporterProxy, vtkSMExporterProxy, vtkSMBooleanDomain, vtkSMDataSourceProxy, vtkSMPropertyLink, vtkSMImageExtractWriterProxy, vtkSMScalarBarWidgetRepresentationProxy, vtkSMSelectionLink, vtkSMAnimationSceneWriter, vtkSMMultiServerSourceProxy, vtkSMExtractTriggerProxy, vtkSMWriterProxy, vtkSMBoxRepresentationProxy, vtkSMCameraLink, vtkSMCinemaVolumetricImageExtractWriterProxy, vtkSMDirectoryProxy, vtkSMPWriterProxy, vtkSMSpreadSheetViewProxy, vtkSMWidgetRepresentationProxy, vtkSMAnimationFrameWindowDomain, vtkSMRenderViewExporterProxy, vtkSMExtractWriterProxy, vtkSMMultiplexerInputDomain, vtkSMPluginLoaderProxy, vtkSMPSWriterProxy, vtkSMImplicitPlaneRepresentationProxy, vtkSMLightProxy, vtkSMMaterialLibraryProxy, vtkSMMultiSliceViewProxy, vtkSMViewResolutionDomain, vtkSMAnimationSceneProxy, vtkSMDataExtractWriterProxy, vtkSMIndexSelectionDomain, vtkSMCameraProxy, vtkSMChartRepresentationProxy, vtkSMPlotMatrixViewProxy, vtkSMSpreadSheetRepresentationProxy, vtkSMTextWidgetRepresentationProxy, vtkSMGL2PSExporterProxy, vtkSMEnsembleDataReaderProxy, vtkSMFileListDomain, vtkSMNullProxy, vtkSMTimeKeeperProxy, vtkSMRendererDomain, and vtkSMOrthographicSliceViewProxy.

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkSMObject.

Reimplemented in vtkSMProxy, vtkSMSessionProxyManager, vtkSMMultiplexerSourceProxy, vtkSMRepresentationProxy, vtkSMCompositeTreeDomain, vtkSMArrayListDomain, vtkSMSubsetInclusionLatticeDomain, vtkSMEnumerationDomain, vtkSMInputArrayDomain, vtkSMBoundsDomain, vtkSMSettingsProxy, vtkSMDataTypeDomain, vtkSMDataAssemblyDomain, vtkSMFieldDataDomain, vtkSMViewProxy, vtkSMCollaborationManager, vtkSMChartSeriesSelectionDomain, vtkSMProxyListDomain, vtkSMViewLayoutProxy, vtkSMDomain, vtkSMSourceProxy, vtkSMSILDomain, vtkSMOutputPort, vtkSMChartSeriesListDomain, vtkSMLoadStateOptionsProxy, vtkSMPVMoleculeRepresentationProxy, vtkSMCompoundSourceProxy, vtkSMSelfGeneratingSourceProxy, vtkSMStringListDomain, vtkSMDoubleRangeDomain, vtkSMFileUtilities, vtkSMRangedTransferFunctionDomain, vtkSMDimensionsDomain, vtkSMIntRangeDomain, vtkSMSaveScreenshotProxy, vtkSMDataDeliveryManagerProxy, vtkSMPVRepresentationProxy, vtkSMPipelineState, vtkSMProxyGroupDomain, vtkSMProxySelectionModel, vtkSMRemoteObject, vtkSMNewWidgetRepresentationProxy, vtkSMArraySelectionDomain, vtkSMRenderViewProxy, vtkSMRepresentationTypeDomain, vtkSMSaveAnimationProxy, vtkSMDiscreteDoubleDomain, vtkSMChartUseIndexForAxisDomain, vtkSMContextViewProxy, vtkSMRepresentedArrayListDomain, vtkSMSaveAnimationExtractsProxy, vtkSMLiveInsituLinkProxy, vtkSMNumberOfComponentsDomain, vtkSMAMRLevelsDomain, vtkSMFixedTypeDomain, vtkSMProxyDefinitionManager, vtkSMComparativeViewProxy, vtkSMMaterialDomain, vtkSMArrayRangeDomain, vtkSMExtentDomain, vtkSMLink, vtkSMTransferFunctionProxy, vtkSMPythonViewProxy, vtkSMAnimationSceneGeometryWriter, vtkSMInputFileNameDomain, vtkSMProxyLink, vtkSMTimeStepIndexDomain, vtkSMComparativeAnimationCueProxy, vtkPVRepresentationAnimationHelper, vtkSMCSVExporterProxy, vtkSMExporterProxy, vtkSMBooleanDomain, vtkSMDataSourceProxy, vtkSMPropertyLink, vtkSMImageExtractWriterProxy, vtkSMScalarBarWidgetRepresentationProxy, vtkSMSelectionLink, vtkSMAnimationSceneWriter, vtkSMMultiServerSourceProxy, vtkSMExtractTriggerProxy, vtkSMWriterProxy, vtkSMBoxRepresentationProxy, vtkSMCameraLink, vtkSMCinemaVolumetricImageExtractWriterProxy, vtkSMDirectoryProxy, vtkSMPWriterProxy, vtkSMSpreadSheetViewProxy, vtkSMWidgetRepresentationProxy, vtkSMAnimationFrameWindowDomain, vtkSMRenderViewExporterProxy, vtkSMExtractWriterProxy, vtkSMMultiplexerInputDomain, vtkSMPluginLoaderProxy, vtkSMPSWriterProxy, vtkSMImplicitPlaneRepresentationProxy, vtkSMLightProxy, vtkSMMaterialLibraryProxy, vtkSMMultiSliceViewProxy, vtkSMViewResolutionDomain, vtkSMAnimationSceneProxy, vtkSMDataExtractWriterProxy, vtkSMIndexSelectionDomain, vtkSMCameraProxy, vtkSMChartRepresentationProxy, vtkSMPlotMatrixViewProxy, vtkSMSpreadSheetRepresentationProxy, vtkSMTextWidgetRepresentationProxy, vtkSMGL2PSExporterProxy, vtkSMEnsembleDataReaderProxy, vtkSMFileListDomain, vtkSMNullProxy, vtkSMTimeKeeperProxy, vtkSMRendererDomain, and vtkSMOrthographicSliceViewProxy.

◆ SafeDownCast()

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

◆ PrintSelf()

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

◆ SetSession()

virtual void vtkSMSessionObject::SetSession ( vtkSMSession )
virtual

Get/Set the session on wihch this object exists.

Note that session is not reference counted.

Reimplemented in vtkSMCollaborationManager, vtkSMRemoteObject, vtkSMProxyDefinitionManager, and vtkSMProxySelectionModel.

◆ GetSession()

virtual vtkSMSession* vtkSMSessionObject::GetSession ( )
virtual

Get/Set the session on wihch this object exists.

Note that session is not reference counted.

Reimplemented in vtkSMOutputPort.

◆ GetSessionProxyManager()

virtual vtkSMSessionProxyManager* vtkSMSessionObject::GetSessionProxyManager ( )
virtual

Return the corresponding ProxyManager if any.

Reimplemented in vtkSMOutputPort.

Member Data Documentation

◆ Session

vtkWeakPointer<vtkSMSession> vtkSMSessionObject::Session
protected

Identifies the session id to which this object is related.

Definition at line 61 of file vtkSMSessionObject.h.


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