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>

Inheritance diagram for vtkInitializationHelper:
Inheritance graph
[legend]
Collaboration diagram for vtkInitializationHelper:
Collaboration graph
[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)
 
vtkCommandGetCommand (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)
 
vtkCommandGetCommand (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 vtkInitializationHelperSafeDownCast (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 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 Initialize (const char *executable, int type, vtkPVOptions *options)
 
static void Initialize (int argc, char **argv, int type, vtkPVOptions *options)
 
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::stringGetOrganizationName ()
 Sets the organization producing this application. More...
 
static void SetApplicationName (const std::string &appName)
 Sets the name of the application. More...
 
static const std::stringGetApplicationName ()
 Sets the name of the application. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 
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 vtkObjectBaseNew ()
 
static vtkObjectBaseNew ()
 

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

Member Typedef Documentation

◆ Superclass

Definition at line 40 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/5]

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.

◆ Initialize() [2/5]

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

Overload primary intended for Python wrapping.

◆ Initialize() [3/5]

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

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

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

◆ Initialize() [4/5]

static void vtkInitializationHelper::Initialize ( const char *  executable,
int  type,
vtkPVOptions options 
)
static
Deprecated:
in ParaView 5.10.

vtkPVOptions is deprecated in ParaView 5.10 and hence these functions are also deprecated.

◆ Initialize() [5/5]

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

◆ LoadSettings()

static void vtkInitializationHelper::LoadSettings ( )
staticprotected

Load user and site settings.


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