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

Stores code and option for python modules. More...

#include <vtkPVPythonModule.h>

Inherits vtkObject.

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
virtual void PrintSelf (ostream &os, vtkIndent indent)
 
virtual char * GetSource ()
 Set/get the full Python source for this module. More...
 
virtual void SetSource (const char *)
 Set/get the full Python source for this module. More...
 
virtual char * GetFullName ()
 Set/get the full name for this module (e.g. More...
 
virtual void SetFullName (const char *)
 Set/get the full name for this module (e.g. More...
 
virtual int GetIsPackage ()
 Set/get a flag indicating whether this module is actually a package (which can have submodules). More...
 
virtual void SetIsPackage (int)
 Set/get a flag indicating whether this module is actually a package (which can have submodules). More...
 
virtual void IsPackageOn ()
 Set/get a flag indicating whether this module is actually a package (which can have submodules). More...
 
virtual void IsPackageOff ()
 Set/get a flag indicating whether this module is actually a package (which can have submodules). More...
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkPVPythonModuleSafeDownCast (vtkObject *o)
 
static vtkPVPythonModuleNew ()
 
static void RegisterModule (vtkPVPythonModule *module)
 Register the Python module. More...
 
static vtkPVPythonModuleGetModule (const char *fullname)
 Return the registered Python module with the given full module name. More...
 
static int HasModule (const char *fullname)
 Returns 1 if a Python module with the given full name has been registered, 0 otherwise. More...
 

Protected Member Functions

 vtkPVPythonModule ()
 
 ~vtkPVPythonModule ()
 

Protected Attributes

char * Source
 
char * FullName
 
int IsPackage
 

Detailed Description

Stores code and option for python modules.

vtkPVPythonModule is a simple class that stores some Python source code that makes up a Python module as well as some state variables about the module (such as its name).

Definition at line 39 of file vtkPVPythonModule.h.

Member Typedef Documentation

§ Superclass

typedef vtkObject vtkPVPythonModule::Superclass

Definition at line 42 of file vtkPVPythonModule.h.

Constructor & Destructor Documentation

§ vtkPVPythonModule()

vtkPVPythonModule::vtkPVPythonModule ( )
protected

§ ~vtkPVPythonModule()

vtkPVPythonModule::~vtkPVPythonModule ( )
protected

Member Function Documentation

§ GetClassName()

virtual const char* vtkPVPythonModule::GetClassName ( )
virtual

§ IsTypeOf()

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

§ IsA()

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

§ SafeDownCast()

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

§ New()

static vtkPVPythonModule* vtkPVPythonModule::New ( )
static

§ PrintSelf()

virtual void vtkPVPythonModule::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

§ GetSource()

virtual char* vtkPVPythonModule::GetSource ( )
virtual

Set/get the full Python source for this module.

§ SetSource()

virtual void vtkPVPythonModule::SetSource ( const char *  )
virtual

Set/get the full Python source for this module.

§ GetFullName()

virtual char* vtkPVPythonModule::GetFullName ( )
virtual

Set/get the full name for this module (e.g.

package.subpackage.module).

§ SetFullName()

virtual void vtkPVPythonModule::SetFullName ( const char *  )
virtual

Set/get the full name for this module (e.g.

package.subpackage.module).

§ GetIsPackage()

virtual int vtkPVPythonModule::GetIsPackage ( )
virtual

Set/get a flag indicating whether this module is actually a package (which can have submodules).

§ SetIsPackage()

virtual void vtkPVPythonModule::SetIsPackage ( int  )
virtual

Set/get a flag indicating whether this module is actually a package (which can have submodules).

§ IsPackageOn()

virtual void vtkPVPythonModule::IsPackageOn ( )
virtual

Set/get a flag indicating whether this module is actually a package (which can have submodules).

§ IsPackageOff()

virtual void vtkPVPythonModule::IsPackageOff ( )
virtual

Set/get a flag indicating whether this module is actually a package (which can have submodules).

§ RegisterModule()

static void vtkPVPythonModule::RegisterModule ( vtkPVPythonModule module)
static

Register the Python module.

Once registered, the module can be retrieved with GetModule and HaveModule. Python interpreters can query these global methods in a custom import mechanism.

§ GetModule()

static vtkPVPythonModule* vtkPVPythonModule::GetModule ( const char *  fullname)
static

Return the registered Python module with the given full module name.

If no such module has been registered, this returns NULL.

§ HasModule()

static int vtkPVPythonModule::HasModule ( const char *  fullname)
inlinestatic

Returns 1 if a Python module with the given full name has been registered, 0 otherwise.

Definition at line 89 of file vtkPVPythonModule.h.

Member Data Documentation

§ Source

char* vtkPVPythonModule::Source
protected

Definition at line 98 of file vtkPVPythonModule.h.

§ FullName

char* vtkPVPythonModule::FullName
protected

Definition at line 99 of file vtkPVPythonModule.h.

§ IsPackage

int vtkPVPythonModule::IsPackage
protected

Definition at line 100 of file vtkPVPythonModule.h.


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