vtkSMSessionObject Class Reference

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

#include <vtkSMSessionObject.h>

Inheritance diagram for vtkSMSessionObject:

Collaboration diagram for vtkSMSessionObject:

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 vtkSMSessionProxyManager *	GetSessionProxyManager ()
	Return the corresponding ProxyManager if any. More...
virtual void	SetSession (vtkSMSession *)
	Get/Set the session on wihch this object exists. More...
virtual vtkSMSession *	GetSession ()
	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)
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 vtkSMSessionObject *	New ()
static int	IsTypeOf (const char *type)
static vtkSMSessionObject *	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
	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< vtkSMSession >	Session
	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 21 of file vtkSMSessionObject.h.

Member Typedef Documentation

Superclass

typedef vtkSMObject vtkSMSessionObject::Superclass

Definition at line 25 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, vtkSMDataAssemblyDomain, vtkSMArrayListDomain, vtkSMCompositeTreeDomain, vtkSMRepresentationProxy, vtkSMEnumerationDomain, vtkSMInputArrayDomain, vtkSMBoundsDomain, vtkSMSettingsProxy, vtkSMFieldDataDomain, vtkSMDataTypeDomain, vtkSMRangeDomainTemplate< T >, vtkSMRegistrationNamesDomain, vtkSMViewProxy, vtkSMCollaborationManager, vtkSMChartSeriesSelectionDomain, vtkSMProxyListDomain, vtkSMDataTypeQueryDomain, vtkSMViewLayoutProxy, vtkSMDomain, vtkSMSourceProxy, vtkSMLoadStateOptionsProxy, vtkSMOutputPort, vtkSMPVRepresentationProxy, vtkSMChartSeriesListDomain, vtkSMDataAssemblyListDomain, vtkSMPVMoleculeRepresentationProxy, vtkSMCompoundSourceProxy, vtkSMSelfGeneratingSourceProxy, vtkSMStringListDomain, vtkSMSaveScreenshotProxy, vtkSMTransferFunction2DProxy, vtkSMDoubleRangeDomain, vtkSMFileUtilities, vtkSMRangedTransferFunctionDomain, vtkSMDimensionsDomain, vtkSMIntRangeDomain, vtkSMDataDeliveryManagerProxy, vtkSMPipelineState, vtkSMProxyGroupDomain, vtkSMProxySelectionModel, vtkSMRemoteObject, vtkSMArraySelectionDomain, vtkSMRenderViewProxy, vtkSMRepresentationTypeDomain, vtkSMSaveAnimationProxy, vtkSMImporterProxy, vtkSMDiscreteDoubleDomain, vtkSMChartUseIndexForAxisDomain, vtkSMContextViewProxy, vtkSMNewWidgetRepresentationProxy, vtkSMRepresentedArrayListDomain, vtkSMScalarBarWidgetRepresentationProxy, vtkSMSaveAnimationExtractsProxy, vtkSMLiveInsituLinkProxy, vtkSMNumberOfComponentsDomain, vtkSMNewWidgetRepresentationProxyAbstract, vtkSMTransferFunctionProxy, vtkSMAMRLevelsDomain, vtkSMFixedTypeDomain, vtkSMProxyDefinitionManager, vtkSMProxyLink, vtkSMComparativeViewProxy, vtkSMMaterialDomain, vtkSMArrayRangeDomain, vtkSMExtentDomain, vtkSMLink, vtkSMPlotlyJsonExtractWriterProxy, vtkSMRecolorableImageExtractWriterProxy, vtkSMViewLink, vtkSMPythonViewProxy, vtkSMVRInteractorStyleProxy, vtkSMVRStylusStyleProxy, vtkSMAnimationSceneGeometryWriter, vtkSMAnimationSceneWebWriter, vtkSMExtractTriggerProxy, vtkSMInputFileNameDomain, vtkSMTimeStepIndexDomain, vtkSMCameraLink, vtkSMComparativeAnimationCueProxy, vtkSMVRPythonInteractorStyleProxy, vtkPVRepresentationAnimationHelper, vtkSMCSVExporterProxy, vtkSMExporterProxy, vtkSMBooleanDomain, vtkSMDataSourceProxy, vtkSMPropertyLink, vtkSMImageExtractWriterProxy, vtkSMNew2DWidgetRepresentationProxy, vtkSMSelectionLink, vtkSMVRMovePointStyleProxy, vtkSMAnimationSceneWriter, vtkSMMultiServerSourceProxy, vtkSMTimeStepsDomain, vtkSMWriterProxy, vtkSMBoxRepresentationProxy, vtkSMCinemaVolumetricImageExtractWriterProxy, vtkSMVRGrabPointStyleProxy, vtkSMVRGrabTransformStyleProxy, vtkSMVRGrabWorldStyleProxy, vtkSMVRResetTransformStyleProxy, vtkSMVRSkeletonStyleProxy, vtkSMVRSpaceNavigatorGrabWorldStyleProxy, vtkSMVRTrackStyleProxy, vtkSMVRVirtualHandStyleProxy, vtkSMDirectoryProxy, vtkSMPWriterProxy, vtkSMContextItemWidgetProxy, vtkSMMaterialLibraryProxy, vtkSMSpreadSheetViewProxy, vtkSMWidgetRepresentationProxy, vtkSMAnimationFrameWindowDomain, vtkSMRenderViewExporterProxy, vtkSMExtractWriterProxy, vtkSMMultiplexerInputDomain, vtkSMPluginLoaderProxy, vtkSMPSWriterProxy, vtkSMDisplaySizedImplicitPlaneRepresentationProxy, vtkSMImplicitPlaneRepresentationProxy, vtkSMLightProxy, vtkSMMultiSliceViewProxy, vtkSMViewResolutionDomain, vtkSMAnimationSceneProxy, vtkSMEnsembleDataReaderProxy, vtkSMDataExtractWriterProxy, vtkSMIndexSelectionDomain, vtkSMSelectionQueryDomain, vtkSMCameraProxy, vtkSMChartRepresentationProxy, vtkSMPlotMatrixViewProxy, vtkSMSpreadSheetRepresentationProxy, vtkSMTextWidgetRepresentationProxy, vtkSMGL2PSExporterProxy, vtkSMFileListDomain, vtkSMNullProxy, vtkSMTimeKeeperProxy, vtkSMRendererDomain, vtkSMVRControlSlicePositionStyleProxy, vtkSMOrthographicSliceViewProxy, and vtkSMVRControlSliceOrientationStyleProxy.

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, vtkSMDataAssemblyDomain, vtkSMArrayListDomain, vtkSMCompositeTreeDomain, vtkSMRepresentationProxy, vtkSMEnumerationDomain, vtkSMInputArrayDomain, vtkSMBoundsDomain, vtkSMSettingsProxy, vtkSMFieldDataDomain, vtkSMDataTypeDomain, vtkSMRangeDomainTemplate< T >, vtkSMRegistrationNamesDomain, vtkSMViewProxy, vtkSMCollaborationManager, vtkSMChartSeriesSelectionDomain, vtkSMProxyListDomain, vtkSMDataTypeQueryDomain, vtkSMViewLayoutProxy, vtkSMDomain, vtkSMSourceProxy, vtkSMLoadStateOptionsProxy, vtkSMOutputPort, vtkSMPVRepresentationProxy, vtkSMChartSeriesListDomain, vtkSMDataAssemblyListDomain, vtkSMPVMoleculeRepresentationProxy, vtkSMCompoundSourceProxy, vtkSMSelfGeneratingSourceProxy, vtkSMStringListDomain, vtkSMSaveScreenshotProxy, vtkSMTransferFunction2DProxy, vtkSMDoubleRangeDomain, vtkSMFileUtilities, vtkSMRangedTransferFunctionDomain, vtkSMDimensionsDomain, vtkSMIntRangeDomain, vtkSMDataDeliveryManagerProxy, vtkSMPipelineState, vtkSMProxyGroupDomain, vtkSMProxySelectionModel, vtkSMRemoteObject, vtkSMArraySelectionDomain, vtkSMRenderViewProxy, vtkSMRepresentationTypeDomain, vtkSMSaveAnimationProxy, vtkSMImporterProxy, vtkSMDiscreteDoubleDomain, vtkSMChartUseIndexForAxisDomain, vtkSMContextViewProxy, vtkSMNewWidgetRepresentationProxy, vtkSMRepresentedArrayListDomain, vtkSMScalarBarWidgetRepresentationProxy, vtkSMSaveAnimationExtractsProxy, vtkSMLiveInsituLinkProxy, vtkSMNumberOfComponentsDomain, vtkSMNewWidgetRepresentationProxyAbstract, vtkSMTransferFunctionProxy, vtkSMAMRLevelsDomain, vtkSMFixedTypeDomain, vtkSMProxyDefinitionManager, vtkSMProxyLink, vtkSMComparativeViewProxy, vtkSMMaterialDomain, vtkSMArrayRangeDomain, vtkSMExtentDomain, vtkSMLink, vtkSMPlotlyJsonExtractWriterProxy, vtkSMRecolorableImageExtractWriterProxy, vtkSMViewLink, vtkSMPythonViewProxy, vtkSMVRInteractorStyleProxy, vtkSMVRStylusStyleProxy, vtkSMAnimationSceneGeometryWriter, vtkSMAnimationSceneWebWriter, vtkSMExtractTriggerProxy, vtkSMInputFileNameDomain, vtkSMTimeStepIndexDomain, vtkSMCameraLink, vtkSMComparativeAnimationCueProxy, vtkSMVRPythonInteractorStyleProxy, vtkPVRepresentationAnimationHelper, vtkSMCSVExporterProxy, vtkSMExporterProxy, vtkSMBooleanDomain, vtkSMDataSourceProxy, vtkSMPropertyLink, vtkSMImageExtractWriterProxy, vtkSMNew2DWidgetRepresentationProxy, vtkSMSelectionLink, vtkSMVRMovePointStyleProxy, vtkSMAnimationSceneWriter, vtkSMMultiServerSourceProxy, vtkSMTimeStepsDomain, vtkSMWriterProxy, vtkSMBoxRepresentationProxy, vtkSMCinemaVolumetricImageExtractWriterProxy, vtkSMVRGrabPointStyleProxy, vtkSMVRGrabTransformStyleProxy, vtkSMVRGrabWorldStyleProxy, vtkSMVRResetTransformStyleProxy, vtkSMVRSkeletonStyleProxy, vtkSMVRSpaceNavigatorGrabWorldStyleProxy, vtkSMVRTrackStyleProxy, vtkSMVRVirtualHandStyleProxy, vtkSMDirectoryProxy, vtkSMPWriterProxy, vtkSMContextItemWidgetProxy, vtkSMMaterialLibraryProxy, vtkSMSpreadSheetViewProxy, vtkSMWidgetRepresentationProxy, vtkSMAnimationFrameWindowDomain, vtkSMRenderViewExporterProxy, vtkSMExtractWriterProxy, vtkSMMultiplexerInputDomain, vtkSMPluginLoaderProxy, vtkSMPSWriterProxy, vtkSMDisplaySizedImplicitPlaneRepresentationProxy, vtkSMImplicitPlaneRepresentationProxy, vtkSMLightProxy, vtkSMMultiSliceViewProxy, vtkSMViewResolutionDomain, vtkSMAnimationSceneProxy, vtkSMEnsembleDataReaderProxy, vtkSMDataExtractWriterProxy, vtkSMIndexSelectionDomain, vtkSMSelectionQueryDomain, vtkSMCameraProxy, vtkSMChartRepresentationProxy, vtkSMPlotMatrixViewProxy, vtkSMSpreadSheetRepresentationProxy, vtkSMTextWidgetRepresentationProxy, vtkSMGL2PSExporterProxy, vtkSMFileListDomain, vtkSMNullProxy, vtkSMTimeKeeperProxy, vtkSMRendererDomain, vtkSMVRControlSlicePositionStyleProxy, vtkSMOrthographicSliceViewProxy, and vtkSMVRControlSliceOrientationStyleProxy.

SafeDownCast()

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

static

PrintSelf()

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

overridevirtual

Reimplemented from vtkSMObject.

Reimplemented in vtkSMSessionProxyManager, vtkSMRepresentationProxy, vtkSMSettingsProxy, vtkSMViewProxy, vtkSMChartSeriesSelectionDomain, vtkSMViewLayoutProxy, vtkSMSourceProxy, vtkSMPVRepresentationProxy, vtkSMChartSeriesListDomain, vtkSMPVMoleculeRepresentationProxy, vtkSMStringListDomain, vtkSMSaveScreenshotProxy, vtkSMTransferFunction2DProxy, vtkSMRangedTransferFunctionDomain, vtkSMDataDeliveryManagerProxy, vtkSMRenderViewProxy, vtkSMRepresentationTypeDomain, vtkSMChartUseIndexForAxisDomain, vtkSMContextViewProxy, vtkSMNewWidgetRepresentationProxy, vtkSMRepresentedArrayListDomain, vtkSMScalarBarWidgetRepresentationProxy, vtkSMNewWidgetRepresentationProxyAbstract, vtkSMTransferFunctionProxy, vtkSMComparativeViewProxy, vtkSMMaterialDomain, vtkSMPlotlyJsonExtractWriterProxy, vtkSMRecolorableImageExtractWriterProxy, vtkSMViewLink, vtkSMPythonViewProxy, vtkSMTimeStepIndexDomain, vtkSMCameraLink, vtkSMComparativeAnimationCueProxy, vtkSMImageExtractWriterProxy, vtkSMNew2DWidgetRepresentationProxy, vtkSMSelectionLink, vtkSMWriterProxy, vtkSMBoxRepresentationProxy, vtkSMCinemaVolumetricImageExtractWriterProxy, vtkSMContextItemWidgetProxy, vtkSMSpreadSheetViewProxy, vtkSMWidgetRepresentationProxy, vtkSMDisplaySizedImplicitPlaneRepresentationProxy, vtkSMImplicitPlaneRepresentationProxy, vtkSMLightProxy, vtkSMMultiSliceViewProxy, vtkSMViewResolutionDomain, vtkSMCameraProxy, vtkSMChartRepresentationProxy, vtkSMPlotMatrixViewProxy, vtkSMSpreadSheetRepresentationProxy, vtkSMTextWidgetRepresentationProxy, vtkSMTimeKeeperProxy, vtkSMRendererDomain, and vtkSMOrthographicSliceViewProxy.

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 49 of file vtkSMSessionObject.h.

---

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

• /builds/gitlab-kitware-sciviz-ci/Remoting/ServerManager/vtkSMSessionObject.h