help class for python modules More...

#include <vtkInitializationHelper.h>

Inheritance diagram for vtkInitializationHelper:

Collaboration diagram for vtkInitializationHelper:

[legend]

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

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 int	IsTypeOf (const char *type)

static vtkInitializationHelper *	SafeDownCast (vtkObject *o)

static bool	Initialize (int argc, char *argv, int processType, vtkCLIOptions options=nullptr, bool enableStandardArgs=true)
	Initializes ParaView engine. More...

static bool	Initialize (vtkStringList *argv, int processType)
	Overload primary intended for Python wrapping. More...

static bool	Initialize (const char *executable, int type)
	An overload that does not take argc/argv for convenience. More...

static bool	InitializeProcessModule (int argc, char **argv, int type)
	Initialize the vtkProcessModule used in ParaView. More...

static bool	InitializeGlobalOptions (int argc, char *argv, int processType, vtkCLIOptions options=nullptr, bool enableStandardArgs=true)
	Initialize only the global options (see vtkCLIOptions) of ParaView engine but do not check for options that cause early exit of the program. More...

static bool	InitializeOtherOptions (int argc, char *argv, int processType, vtkCLIOptions options=nullptr, bool enableStandardArgs=true)
	Initialize all options of ParaView engine but the global options, then check for options that cause early exit of the program. More...

static bool	InitializeOptions (int argc, char *argv, int processType, vtkCLIOptions options=nullptr, bool enableStandardArgs=true)
	Initialize the process module and options of ParaView engine. More...

static bool	InitializeSettings (int type, bool defaultCoreConfig)
	Initialize the setting by reading the settings file, unless coreConfig DisableRegistry is set to true. More...

static bool	InitializeOthers ()
	Initialize everything that is not initialized by specific methods, see Initialize method for more info. More...

static bool	InitializeMiscellaneous (int type)
	Initialize everything that needs to be initialized in the paraview engine after the options. More...

static void	InitializePythonVirtualEnvironment ()
	Initialize Python virtual environment from –venv command-line argument if any was provided. More...

static void	Finalize ()
	Finalizes the server manager. More...

static int	GetExitCode ()
	Returns the exit code after `Initialize`. More...

static std::string	GetUserSettingsDirectory ()
	Get directory for user settings file. More...

static std::string	GetUserSettingsFilePath ()
	Get file path for the user settings file. More...


static void	StandaloneInitialize ()
	Initialization for standalone executables linking against a PV library. More...

static void	StandaloneFinalize ()
	Initialization for standalone executables linking against a PV library. More...


static void	SetLoadSettingsFilesDuringInitialization (bool)
	During initialization, vtkInitializationHelper reads "settings" files for configuring vtkSMSettings. More...

static bool	GetLoadSettingsFilesDuringInitialization ()
	During initialization, vtkInitializationHelper reads "settings" files for configuring vtkSMSettings. More...


static void	SetOrganizationName (const std::string &organizationName)
	Sets the organization producing this application. More...

static const std::string &	GetOrganizationName ()
	Sets the organization producing this application. More...


static void	SetApplicationName (const std::string &appName)
	Sets the name of the application. More...

static const std::string &	GetApplicationName ()
	Sets the name of the application. 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
	vtkInitializationHelper ()=default

	~vtkInitializationHelper () override=default

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 &)

Static Protected Member Functions
static void	LoadSettings ()
	Load user and site settings. More...

Additional Inherited Members
Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

help class for python modules

This class is used by the python modules when they are loaded from python (as opposed to pvpython). It simply initializes the server manager so that it can be used.

Definition at line 28 of file vtkInitializationHelper.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkInitializationHelper::Superclass

Definition at line 31 of file vtkInitializationHelper.h.

Constructor & Destructor Documentation

◆ vtkInitializationHelper()

vtkInitializationHelper::vtkInitializationHelper ( )

protecteddefault

◆ ~vtkInitializationHelper()

vtkInitializationHelper::~vtkInitializationHelper ( )

overrideprotecteddefault

Member Function Documentation

◆ GetClassName()

virtual const char* vtkInitializationHelper::GetClassName ( )

virtual

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

◆ Initialize() [1/3]

static bool vtkInitializationHelper::Initialize	(	int	argc,
		char **	argv,
		int	processType,
		vtkCLIOptions *	options = `nullptr`,
		bool	enableStandardArgs = `true`
	)

static

Initializes ParaView engine.

Returns true on success, false otherwise. When false, use GetExitCode to obtain the exit code. Note, for requests like --help, --version etc, this method returns false with exit-code set to 0.

If vtkCLIOptions is nullptr, then this method internally creates and uses an internal vtkCLIOptions instance. In that case, extra / unknown arguments are simply ignored.

Internally calls, in this order:

InitializeProcessModule
InitializeGlobalOptions
InitializeSettings
InitializeOtherOptions
InitializeOthers

◆ Initialize() [2/3]

static bool vtkInitializationHelper::Initialize	(	vtkStringList *	argv,
		int	processType
	)

static

Overload primary intended for Python wrapping.

◆ Initialize() [3/3]

static bool vtkInitializationHelper::Initialize	(	const char *	executable,
		int	type
	)

static

An overload that does not take argc/argv for convenience.

◆ InitializeProcessModule()

static bool vtkInitializationHelper::InitializeProcessModule	(	int	argc,
		char **	argv,
		int	type
	)

static

Initialize the vtkProcessModule used in ParaView.

This method should be called before any other initialization method Unless that method calls it.

This method should be called only once

Returns true on success, false otherwise.

This method is used by Initialize but can be used when separating options initialization from the rest of the initialization.

◆ InitializeGlobalOptions()

static bool vtkInitializationHelper::InitializeGlobalOptions	(	int	argc,
		char **	argv,
		int	processType,
		vtkCLIOptions *	options = `nullptr`,
		bool	enableStandardArgs = `true`
	)

static

Initialize only the global options (see vtkCLIOptions) of ParaView engine but do not check for options that cause early exit of the program.

Returns true on success, false otherwise. When false, use GetExitCode to obtain the exit code.

If options is nullptr, then this method internally creates and uses an internal vtkCLIOptions instance. In that case, extra / unknown arguments are simply ignored.

This method is used by Initialize but can be used when separating options initialization from the rest of the initialization, in combination with InitializeOtherOptions.

◆ InitializeOtherOptions()

static bool vtkInitializationHelper::InitializeOtherOptions	(	int	argc,
		char **	argv,
		int	processType,
		vtkCLIOptions *	options = `nullptr`,
		bool	enableStandardArgs = `true`
	)

static

Initialize all options of ParaView engine but the global options, then check for options that cause early exit of the program.

Returns true on success, false otherwise. When false, use GetExitCode to obtain the exit code. Note, for options that cause early exit of the program like --help, --version etc, this method returns false with exit-code set to 0.

If options is nullptr, then this method internally creates and uses an internal vtkCLIOptions instance. In that case, extra / unknown arguments are simply ignored.

This method is used by Initialize but can be used when separating options initialization from the rest of the initialization, in combination with InitializeGlobalOptions.

◆ InitializeOptions()

static bool vtkInitializationHelper::InitializeOptions	(	int	argc,
		char **	argv,
		int	processType,
		vtkCLIOptions *	options = `nullptr`,
		bool	enableStandardArgs = `true`
	)

static

Initialize the process module and options of ParaView engine.

Returns true on success, false otherwise. When false, use GetExitCode to obtain the exit code. Note, for options that cause early exit of the program like --help, --version etc, this method returns false with exit-code set to 0.

If options is nullptr, then this method internally creates and uses an internal vtkCLIOptions instance. In that case, extra / unknown arguments are simply ignored.

This method call InitializeProcessModule, then initialize all options.

◆ InitializeSettings()

static bool vtkInitializationHelper::InitializeSettings	(	int	type,
		bool	defaultCoreConfig
	)

static

Initialize the setting by reading the settings file, unless coreConfig DisableRegistry is set to true.

Assume that InitializeProcessModule has been called.

If defaultCoreConfig is set to true, this will use the setting to set default values on the vtkRemotingCoreConfiguration

This method always returns true.

This method is used by Initialize but can be used when separating options initialization from the rest of the initialization.

◆ InitializeOthers()

static bool vtkInitializationHelper::InitializeOthers ( )

static

Initialize everything that is not initialized by specific methods, see Initialize method for more info.

Assume that InitializeProcessModule has been called. Returns true on success, false otherwise.

This method is used by Initialize but can be used when separating options initialization from the rest of the initialization.

◆ InitializeMiscellaneous()

static bool vtkInitializationHelper::InitializeMiscellaneous ( int type )

static

Initialize everything that needs to be initialized in the paraview engine after the options.

Returns true on success, false otherwise.

◆ InitializePythonVirtualEnvironment()

static void vtkInitializationHelper::InitializePythonVirtualEnvironment ( )

static

Initialize Python virtual environment from –venv command-line argument if any was provided.

Make sure that the vtkPythonInterpreter has been initialized before calling this function.

◆ Finalize()

static void vtkInitializationHelper::Finalize ( )

static

Finalizes the server manager.

Do not use the server manager after calling this.

◆ GetExitCode()

static int vtkInitializationHelper::GetExitCode ( )

inlinestatic

Returns the exit code after Initialize.

Definition at line 182 of file vtkInitializationHelper.h.

◆ StandaloneInitialize()

static void vtkInitializationHelper::StandaloneInitialize ( )

static

Initialization for standalone executables linking against a PV library.

This is needed to insure that linker does not remove object factories' auto init during static linking. It also cleans up after protobuf.

◆ StandaloneFinalize()

static void vtkInitializationHelper::StandaloneFinalize ( )

static

Initialization for standalone executables linking against a PV library.

This is needed to insure that linker does not remove object factories' auto init during static linking. It also cleans up after protobuf.

◆ SetLoadSettingsFilesDuringInitialization()

static void vtkInitializationHelper::SetLoadSettingsFilesDuringInitialization ( bool )

static

During initialization, vtkInitializationHelper reads "settings" files for configuring vtkSMSettings.

To disable this processing of the settings file for an application (e.g. in Catalyst), turn this off. On by default.

◆ GetLoadSettingsFilesDuringInitialization()

static bool vtkInitializationHelper::GetLoadSettingsFilesDuringInitialization ( )

static

During initialization, vtkInitializationHelper reads "settings" files for configuring vtkSMSettings.

To disable this processing of the settings file for an application (e.g. in Catalyst), turn this off. On by default.

◆ SetOrganizationName()

static void vtkInitializationHelper::SetOrganizationName ( const std::string & organizationName )

static

Sets the organization producing this application.

This is "ParaView" by default, but can be different for branded applications.

◆ GetOrganizationName()

static const std::string& vtkInitializationHelper::GetOrganizationName ( )

static

Sets the organization producing this application.

This is "ParaView" by default, but can be different for branded applications.

◆ SetApplicationName()

static void vtkInitializationHelper::SetApplicationName ( const std::string & appName )

static

Sets the name of the application.

This is "ParaView" by default, but can be different for branded applications.

◆ GetApplicationName()

static const std::string& vtkInitializationHelper::GetApplicationName ( )

static

Sets the name of the application.

This is "ParaView" by default, but can be different for branded applications.

◆ GetUserSettingsDirectory()

static std::string vtkInitializationHelper::GetUserSettingsDirectory ( )

static

Get directory for user settings file.

The last character is always the file path separator appropriate for the system.

◆ GetUserSettingsFilePath()

static std::string vtkInitializationHelper::GetUserSettingsFilePath ( )

static

Get file path for the user settings file.

◆ LoadSettings()

static void vtkInitializationHelper::LoadSettings ( )

staticprotected

Load user and site settings.

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

/builds/gitlab-kitware-sciviz-ci/Remoting/Application/vtkInitializationHelper.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkInitializationHelper()

◆ ~vtkInitializationHelper()

Member Function Documentation

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ Initialize() [1/3]

◆ Initialize() [2/3]

◆ Initialize() [3/3]

◆ InitializeProcessModule()

◆ InitializeGlobalOptions()

◆ InitializeOtherOptions()

◆ InitializeOptions()

◆ InitializeSettings()

◆ InitializeOthers()

◆ InitializeMiscellaneous()

◆ InitializePythonVirtualEnvironment()

◆ Finalize()

◆ GetExitCode()

◆ StandaloneInitialize()

◆ StandaloneFinalize()

◆ SetLoadSettingsFilesDuringInitialization()

◆ GetLoadSettingsFilesDuringInitialization()

◆ SetOrganizationName()

◆ GetOrganizationName()

◆ SetApplicationName()

◆ GetApplicationName()

◆ GetUserSettingsDirectory()

◆ GetUserSettingsFilePath()

◆ LoadSettings()