vtkPVServerInformation Class Reference

Gets features of the server. More...

#include <vtkPVServerInformation.h>

Inheritance diagram for vtkPVServerInformation:

Collaboration diagram for vtkPVServerInformation:

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
virtual bool	GetIsInTileDisplay ()
	Returns true if server is in tile-display mode. More...
virtual bool	GetIsInCave ()
	Returns true if server is in CAVE mode. More...
void	DeepCopy (vtkPVServerInformation *info)
void	CopyFromObject (vtkObject *) override
	Transfer information about a single object into this object. More...
void	AddInformation (vtkPVInformation *) override
	Merge another information object. More...
virtual void	SetNVPipeSupport (bool)
	if the server supports compressing images via NVPipe More...
virtual bool	GetNVPipeSupport ()
virtual int *	GetTileDimensions ()
	When in tile display mode, returns the tile dimensions. More...
virtual void	GetTileDimensions (int &, int &)
virtual void	GetTileDimensions (int [2])
virtual bool	IsMPIInitialized () const
	Return whether MPI is initialized or not. More...
virtual void	SetRemoteRendering (int)
	This flag indicates whether the server can render remotely. More...
virtual int	GetRemoteRendering ()
	This flag indicates whether the server can render remotely. 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 void	SetUseIceT (int)
	Returns 1 if IceT is available. More...
virtual int	GetUseIceT ()
	Returns 1 if IceT is available. More...
virtual void	SetTimeout (int)
	Get/Set the time after which the server timesout. More...
virtual int	GetTimeout ()
	Get/Set the time after which the server timesout. More...
const std::string &	GetTimeoutCommand () const
	Get the timeout command used by the server to retrieve remaining time. More...
virtual int	GetTimeoutCommandInterval ()
	Get the time interval in seconds between consecutive calls of TimeoutCommand. More...
virtual int	GetNumberOfProcesses ()
	Get the number of processes. More...
virtual int	GetMultiClientsEnable ()
	Return true if the server allow server client to connect to itself. More...
virtual int	GetClientId ()
	Get the id that correspond to the current client. More...
virtual void	SetIdTypeSize (int)
	Set/Get vtkIdType size, which can be 32 or 64. More...
virtual int	GetIdTypeSize ()
	Set/Get vtkIdType size, which can be 32 or 64. More...
virtual std::string	GetSMPBackendName ()
	Get the SMP Tools backend name of the server. More...
virtual int	GetSMPMaxNumberOfThreads ()
	Get the max number of threads of the server. More...
virtual int	GetAcceleratedFiltersOverrideAvailable ()
	Return true if VTK-m accelerated filters override is enabled in this build. 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 vtkPVServerInformation *	New ()
static int	IsTypeOf (const char *type)
static vtkPVServerInformation *	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
	vtkPVServerInformation ()
	~vtkPVServerInformation () override
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	NumberOfProcesses
bool	MPIInitialized
int	OGVSupport = 1
int	AVISupport = 0
bool	NVPipeSupport = false
int	RemoteRendering = 1
int	Timeout = 0
std::string	TimeoutCommand
int	TimeoutCommandInterval = 60
int	UseIceT
int	MultiClientsEnable = 0
int	ClientId = 0
int	IdTypeSize = 0
bool	IsInTileDisplay = false
bool	IsInCave = false
int	TileDimensions [2] = { 0, 0 }
std::string	SMPBackendName
int	SMPMaxNumberOfThreads
bool	AcceleratedFiltersOverrideAvailable
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 features of the server.

This objects is used by the client to get the features supported by the server. At the moment, server information is only on the root.

Definition at line 22 of file vtkPVServerInformation.h.

Member Typedef Documentation

Superclass

typedef vtkPVInformation vtkPVServerInformation::Superclass

Definition at line 26 of file vtkPVServerInformation.h.

Constructor & Destructor Documentation

vtkPVServerInformation()

vtkPVServerInformation::vtkPVServerInformation ( )

protected

~vtkPVServerInformation()

vtkPVServerInformation::~vtkPVServerInformation ( )

overrideprotected

Member Function Documentation

New()

static vtkPVServerInformation* vtkPVServerInformation::New ( )

static

GetClassName()

virtual const char* vtkPVServerInformation::GetClassName ( )

virtual

Reimplemented from vtkPVInformation.

IsTypeOf()

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

static

IsA()

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

virtual

Reimplemented from vtkPVInformation.

SafeDownCast()

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

static

PrintSelf()

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

overridevirtual

Reimplemented from vtkPVInformation.

SetRemoteRendering()

virtual void vtkPVServerInformation::SetRemoteRendering ( int  )

virtual

This flag indicates whether the server can render remotely.

If it is off, all rendering has to be on the client. This is only off when the user starts the server with the –disable-composite command line option.

GetRemoteRendering()

virtual int vtkPVServerInformation::GetRemoteRendering ( )

virtual

This flag indicates whether the server can render remotely.

If it is off, all rendering has to be on the client. This is only off when the user starts the server with the –disable-composite command line option.

GetIsInTileDisplay()

virtual bool vtkPVServerInformation::GetIsInTileDisplay ( )

virtual

Returns true if server is in tile-display mode.

GetIsInCave()

virtual bool vtkPVServerInformation::GetIsInCave ( )

virtual

Returns true if server is in CAVE mode.

DeepCopy()

void vtkPVServerInformation::DeepCopy

(

vtkPVServerInformation *

info

)

CopyFromObject()

void vtkPVServerInformation::CopyFromObject ( vtkObject *  )

overridevirtual

Transfer information about a single object into this object.

Reimplemented from vtkPVInformation.

AddInformation()

void vtkPVServerInformation::AddInformation ( vtkPVInformation *  )

overridevirtual

Merge another information object.

Reimplemented from vtkPVInformation.

CopyToStream()

void vtkPVServerInformation::CopyToStream ( vtkClientServerStream *  )

overridevirtual

Manage a serialized version of the information.

Implements vtkPVInformation.

CopyFromStream()

void vtkPVServerInformation::CopyFromStream ( const vtkClientServerStream *  )

overridevirtual

Manage a serialized version of the information.

Reimplemented from vtkPVInformation.

SetUseIceT()

virtual void vtkPVServerInformation::SetUseIceT ( int  )

virtual

Returns 1 if IceT is available.

GetUseIceT()

virtual int vtkPVServerInformation::GetUseIceT ( )

virtual

Returns 1 if IceT is available.

SetNVPipeSupport()

virtual void vtkPVServerInformation::SetNVPipeSupport ( bool  )

virtual

if the server supports compressing images via NVPipe

GetNVPipeSupport()

virtual bool vtkPVServerInformation::GetNVPipeSupport ( )

virtual

SetTimeout()

virtual void vtkPVServerInformation::SetTimeout ( int  )

virtual

Get/Set the time after which the server timesout.

GetTimeout()

virtual int vtkPVServerInformation::GetTimeout ( )

virtual

Get/Set the time after which the server timesout.

GetTimeoutCommand()

const std::string& vtkPVServerInformation::GetTimeoutCommand ( ) const

inline

Get the timeout command used by the server to retrieve remaining time.

Definition at line 98 of file vtkPVServerInformation.h.

GetTimeoutCommandInterval()

virtual int vtkPVServerInformation::GetTimeoutCommandInterval ( )

virtual

Get the time interval in seconds between consecutive calls of TimeoutCommand.

Defaults to 60.

GetTileDimensions() [1/3]

virtual int* vtkPVServerInformation::GetTileDimensions ( )

virtual

When in tile display mode, returns the tile dimensions.

GetTileDimensions() [2/3]

virtual void vtkPVServerInformation::GetTileDimensions ( int &  , int &    )

virtual

GetTileDimensions() [3/3]

virtual void vtkPVServerInformation::GetTileDimensions ( int  [2] )

virtual

GetNumberOfProcesses()

virtual int vtkPVServerInformation::GetNumberOfProcesses ( )

virtual

Get the number of processes.

IsMPIInitialized()

virtual bool vtkPVServerInformation::IsMPIInitialized ( ) const

virtual

Return whether MPI is initialized or not.

GetMultiClientsEnable()

virtual int vtkPVServerInformation::GetMultiClientsEnable ( )

virtual

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

GetClientId()

virtual int vtkPVServerInformation::GetClientId ( )

virtual

Get the id that correspond to the current client.

SetIdTypeSize()

virtual void vtkPVServerInformation::SetIdTypeSize ( int  )

virtual

Set/Get vtkIdType size, which can be 32 or 64.

GetIdTypeSize()

virtual int vtkPVServerInformation::GetIdTypeSize ( )

virtual

Set/Get vtkIdType size, which can be 32 or 64.

GetSMPBackendName()

virtual std::string vtkPVServerInformation::GetSMPBackendName ( )

virtual

Get the SMP Tools backend name of the server.

GetSMPMaxNumberOfThreads()

virtual int vtkPVServerInformation::GetSMPMaxNumberOfThreads ( )

virtual

Get the max number of threads of the server.

GetAcceleratedFiltersOverrideAvailable()

virtual int vtkPVServerInformation::GetAcceleratedFiltersOverrideAvailable ( )

virtual

Return true if VTK-m accelerated filters override is enabled in this build.

Member Data Documentation

NumberOfProcesses

int vtkPVServerInformation::NumberOfProcesses

protected

Definition at line 173 of file vtkPVServerInformation.h.

MPIInitialized

bool vtkPVServerInformation::MPIInitialized

protected

Definition at line 174 of file vtkPVServerInformation.h.

OGVSupport

int vtkPVServerInformation::OGVSupport = 1

protected

Definition at line 175 of file vtkPVServerInformation.h.

AVISupport

int vtkPVServerInformation::AVISupport = 0

protected

Definition at line 176 of file vtkPVServerInformation.h.

NVPipeSupport

bool vtkPVServerInformation::NVPipeSupport = false

protected

Definition at line 177 of file vtkPVServerInformation.h.

RemoteRendering

int vtkPVServerInformation::RemoteRendering = 1

protected

Definition at line 178 of file vtkPVServerInformation.h.

Timeout

int vtkPVServerInformation::Timeout = 0

protected

Definition at line 179 of file vtkPVServerInformation.h.

TimeoutCommand

std::string vtkPVServerInformation::TimeoutCommand

protected

Definition at line 180 of file vtkPVServerInformation.h.

TimeoutCommandInterval

int vtkPVServerInformation::TimeoutCommandInterval = 60

protected

Definition at line 181 of file vtkPVServerInformation.h.

UseIceT

int vtkPVServerInformation::UseIceT

protected

Definition at line 182 of file vtkPVServerInformation.h.

MultiClientsEnable

int vtkPVServerInformation::MultiClientsEnable = 0

protected

Definition at line 183 of file vtkPVServerInformation.h.

ClientId

int vtkPVServerInformation::ClientId = 0

protected

Definition at line 184 of file vtkPVServerInformation.h.

IdTypeSize

int vtkPVServerInformation::IdTypeSize = 0

protected

Definition at line 185 of file vtkPVServerInformation.h.

IsInTileDisplay

bool vtkPVServerInformation::IsInTileDisplay = false

protected

Definition at line 186 of file vtkPVServerInformation.h.

IsInCave

bool vtkPVServerInformation::IsInCave = false

protected

Definition at line 187 of file vtkPVServerInformation.h.

TileDimensions

int vtkPVServerInformation::TileDimensions[2] = { 0, 0 }

protected

Definition at line 188 of file vtkPVServerInformation.h.

SMPBackendName

std::string vtkPVServerInformation::SMPBackendName

protected

Definition at line 189 of file vtkPVServerInformation.h.

SMPMaxNumberOfThreads

int vtkPVServerInformation::SMPMaxNumberOfThreads

protected

Definition at line 190 of file vtkPVServerInformation.h.

AcceleratedFiltersOverrideAvailable

bool vtkPVServerInformation::AcceleratedFiltersOverrideAvailable

protected

Definition at line 191 of file vtkPVServerInformation.h.

---

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

• /builds/gitlab-kitware-sciviz-ci/Remoting/Core/vtkPVServerInformation.h