Gets Multi-clients information from the server. More...

#include <vtkPVMultiClientsInformation.h>

Inheritance diagram for vtkPVMultiClientsInformation:

Collaboration diagram for vtkPVMultiClientsInformation:

[legend]

Public Types
typedef vtkPVInformation	Superclass

Public Types inherited from vtkPVInformation
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

void	DeepCopy (vtkPVMultiClientsInformation *info)

void	CopyFromObject (vtkObject *) override
	Transfer information about a single object into this object. More...

void	AddInformation (vtkPVInformation *) override
	Merge another information object. More...

int	GetClientId (int idx)
	Return the client id of the nth connected client. More...


void	CopyToStream (vtkClientServerStream *) override
	Manage a serialized version of the information. More...

void	CopyFromStream (const vtkClientServerStream *) override
	Manage a serialized version of the information. More...


virtual int	GetClientId ()
	Get the id that correspond to the current client. More...


virtual int	GetNumberOfClients ()
	Return the number of connected clients. More...


virtual int	GetMultiClientEnable ()
	Return 1 if the server allow server client to connect to itself. More...


virtual int	GetMasterId ()
	Return the Id of the client that has been elected as master. More...

Public Member Functions inherited from vtkPVInformation
virtual void	CopyParametersToStream (vtkMultiProcessStream &)
	Serialize/Deserialize the parameters that control how/what information is gathered. More...

virtual void	CopyParametersFromStream (vtkMultiProcessStream &)
	Serialize/Deserialize the parameters that control how/what information is gathered. More...

virtual int	GetRootOnly ()
	Set/get whether to gather information only from the root. 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 vtkPVMultiClientsInformation *	New ()

static int	IsTypeOf (const char *type)

static vtkPVMultiClientsInformation *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkPVInformation
static int	IsTypeOf (const char *type)

static vtkPVInformation *	SafeDownCast (vtkObject *o)

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
	vtkPVMultiClientsInformation ()

	~vtkPVMultiClientsInformation () override

	vtkPVMultiClientsInformation (const vtkPVMultiClientsInformation &)=delete

void	operator= (const vtkPVMultiClientsInformation &)=delete

Protected Member Functions inherited from vtkPVInformation
	vtkPVInformation ()

	~vtkPVInformation () override

virtual void	SetRootOnly (int)

	vtkPVInformation (const vtkPVInformation &)=delete

void	operator= (const vtkPVInformation &)=delete

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
int	ClientId

int *	ClientIds

int	NumberOfClients

int	MultiClientEnable

int	MasterId

Protected Attributes inherited from vtkPVInformation
int	RootOnly

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

Gets Multi-clients information from the server.

This objects is used by the client to get the number of multi-clients server as well as their ids.

Definition at line 31 of file vtkPVMultiClientsInformation.h.

Member Typedef Documentation

◆ Superclass

typedef vtkPVInformation vtkPVMultiClientsInformation::Superclass

Definition at line 35 of file vtkPVMultiClientsInformation.h.

Constructor & Destructor Documentation

◆ vtkPVMultiClientsInformation() [1/2]

vtkPVMultiClientsInformation::vtkPVMultiClientsInformation ( )

protected

◆ ~vtkPVMultiClientsInformation()

vtkPVMultiClientsInformation::~vtkPVMultiClientsInformation ( )

overrideprotected

◆ vtkPVMultiClientsInformation() [2/2]

vtkPVMultiClientsInformation::vtkPVMultiClientsInformation ( const vtkPVMultiClientsInformation & )

protecteddelete

Member Function Documentation

◆ New()

static vtkPVMultiClientsInformation* vtkPVMultiClientsInformation::New ( )

static

◆ GetClassName()

virtual const char* vtkPVMultiClientsInformation::GetClassName ( )

virtual

Reimplemented from vtkPVInformation.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkPVInformation.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkPVInformation.

◆ DeepCopy()

void vtkPVMultiClientsInformation::DeepCopy ( vtkPVMultiClientsInformation * info )

◆ CopyFromObject()

void vtkPVMultiClientsInformation::CopyFromObject ( vtkObject * )

overridevirtual

Transfer information about a single object into this object.

Reimplemented from vtkPVInformation.

◆ AddInformation()

void vtkPVMultiClientsInformation::AddInformation ( vtkPVInformation * )

overridevirtual

Merge another information object.

Reimplemented from vtkPVInformation.

◆ CopyToStream()

void vtkPVMultiClientsInformation::CopyToStream ( vtkClientServerStream * )

overridevirtual

Manage a serialized version of the information.

Implements vtkPVInformation.

◆ CopyFromStream()

void vtkPVMultiClientsInformation::CopyFromStream ( const vtkClientServerStream * )

overridevirtual

Manage a serialized version of the information.

Reimplemented from vtkPVInformation.

◆ GetClientId() [1/2]

virtual int vtkPVMultiClientsInformation::GetClientId ( )

virtual

Get the id that correspond to the current client.

◆ GetClientId() [2/2]

int vtkPVMultiClientsInformation::GetClientId ( int idx )

Return the client id of the nth connected client.

idx < NumberOfClients

◆ GetNumberOfClients()

virtual int vtkPVMultiClientsInformation::GetNumberOfClients ( )

virtual

Return the number of connected clients.

◆ GetMultiClientEnable()

virtual int vtkPVMultiClientsInformation::GetMultiClientEnable ( )

virtual

Return 1 if the server allow server client to connect to itself.

◆ GetMasterId()

virtual int vtkPVMultiClientsInformation::GetMasterId ( )

virtual

Return the Id of the client that has been elected as master.

◆ operator=()

void vtkPVMultiClientsInformation::operator= ( const vtkPVMultiClientsInformation & )

protecteddelete

Member Data Documentation

◆ ClientId

int vtkPVMultiClientsInformation::ClientId

protected

Definition at line 96 of file vtkPVMultiClientsInformation.h.

◆ ClientIds

int* vtkPVMultiClientsInformation::ClientIds

protected

Definition at line 97 of file vtkPVMultiClientsInformation.h.

◆ NumberOfClients

int vtkPVMultiClientsInformation::NumberOfClients

protected

Definition at line 98 of file vtkPVMultiClientsInformation.h.

◆ MultiClientEnable

int vtkPVMultiClientsInformation::MultiClientEnable

protected

Definition at line 99 of file vtkPVMultiClientsInformation.h.

◆ MasterId

int vtkPVMultiClientsInformation::MasterId

protected

Definition at line 100 of file vtkPVMultiClientsInformation.h.

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

/builds/gitlab-kitware-sciviz-ci/Remoting/Core/vtkPVMultiClientsInformation.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkPVMultiClientsInformation() [1/2]

◆ ~vtkPVMultiClientsInformation()

◆ vtkPVMultiClientsInformation() [2/2]

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ DeepCopy()

◆ CopyFromObject()

◆ AddInformation()

◆ CopyToStream()

◆ CopyFromStream()

◆ GetClientId() [1/2]

◆ GetClientId() [2/2]

◆ GetNumberOfClients()

◆ GetMultiClientEnable()

◆ GetMasterId()

◆ operator=()

Member Data Documentation

◆ ClientId

◆ ClientIds

◆ NumberOfClients

◆ MultiClientEnable

◆ MasterId