ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | List of all members
vtkInitializationHelper Class Reference

help class for python modules More...

#include <vtkInitializationHelper.h>

Inherits vtkObject.

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &, vtkIndent)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkInitializationHelperSafeDownCast (vtkObject *o)
 
static void Initialize (int argc, char **argv, int type, vtkPVOptions *options)
 Alternative API to initialize the server manager. More...
 
static void Finalize ()
 Finalizes the server manager. More...
 
static void Initialize (const char *executable, int type)
 Initializes the server manager. More...
 
static void Initialize (const char *executable, int type, vtkPVOptions *options)
 Initializes the server manager. 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...
 

Protected Member Functions

 vtkInitializationHelper ()
 
virtual ~vtkInitializationHelper ()
 

Static Protected Member Functions

static void LoadSettings ()
 Load user and site settings. 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...
 

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 33 of file vtkInitializationHelper.h.

Member Typedef Documentation

◆ Superclass

Definition at line 36 of file vtkInitializationHelper.h.

Constructor & Destructor Documentation

◆ vtkInitializationHelper()

vtkInitializationHelper::vtkInitializationHelper ( )
inlineprotected

Definition at line 101 of file vtkInitializationHelper.h.

◆ ~vtkInitializationHelper()

virtual vtkInitializationHelper::~vtkInitializationHelper ( )
inlineprotectedvirtual

Definition at line 102 of file vtkInitializationHelper.h.

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

◆ SafeDownCast()

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

◆ PrintSelf()

void vtkInitializationHelper::PrintSelf ( ostream &  ,
vtkIndent   
)

◆ Initialize() [1/3]

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

Initializes the server manager.

Do not use the server manager before calling this.

◆ Initialize() [2/3]

static void vtkInitializationHelper::Initialize ( const char *  executable,
int  type,
vtkPVOptions options 
)
static

Initializes the server manager.

Do not use the server manager before calling this.

◆ Initialize() [3/3]

static void vtkInitializationHelper::Initialize ( int  argc,
char **  argv,
int  type,
vtkPVOptions options 
)
static

Alternative API to initialize the server manager.

This takes in the command line arguments and the vtkPVOptions instance to use to process the command line options.

◆ Finalize()

static void vtkInitializationHelper::Finalize ( )
static

Finalizes the server manager.

Do not use the server manager after calling this.

◆ 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.

◆ LoadSettings()

static void vtkInitializationHelper::LoadSettings ( )
staticprotected

Load user and site settings.

◆ GetUserSettingsDirectory()

static std::string vtkInitializationHelper::GetUserSettingsDirectory ( )
staticprotected

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

Get file path for the user settings file.


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