ParaView
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkPVPythonModule Class Reference

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

#include <vtkPVPythonModule.h>

Inheritance diagram for vtkPVPythonModule:
Inheritance graph
[legend]
Collaboration diagram for vtkPVPythonModule:
Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
virtual void PrintSelf (ostream &os, vtkIndent indent)
virtual char * GetSource ()
virtual void SetSource (const char *)
virtual char * GetFullName ()
virtual void SetFullName (const char *)
virtual int GetIsPackage ()
virtual void SetIsPackage (int)
virtual void IsPackageOn ()
virtual void IsPackageOff ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkPVPythonModuleSafeDownCast (vtkObject *o)
static vtkPVPythonModuleNew ()
static void RegisterModule (vtkPVPythonModule *module)
static vtkPVPythonModuleGetModule (const char *fullname)
static int HasModule (const char *fullname)

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


Constructor & Destructor Documentation

vtkPVPythonModule::vtkPVPythonModule ( ) [protected]
vtkPVPythonModule::~vtkPVPythonModule ( ) [protected]

Member Function Documentation

virtual const char* vtkPVPythonModule::GetClassName ( ) [virtual]

Reimplemented from vtkObject.

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

Reimplemented from vtkObject.

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

Reimplemented from vtkObject.

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

Reimplemented from vtkObject.

static vtkPVPythonModule* vtkPVPythonModule::New ( ) [static]

Reimplemented from vtkObject.

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

Reimplemented from vtkObject.

virtual char* vtkPVPythonModule::GetSource ( ) [virtual]

Set/get the full Python source for this module.

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

Set/get the full Python source for this module.

virtual char* vtkPVPythonModule::GetFullName ( ) [virtual]

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

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

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

virtual int vtkPVPythonModule::GetIsPackage ( ) [virtual]

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

virtual void vtkPVPythonModule::SetIsPackage ( int  ) [virtual]

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

virtual void vtkPVPythonModule::IsPackageOn ( ) [virtual]

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

virtual void vtkPVPythonModule::IsPackageOff ( ) [virtual]

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

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.

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.

static int vtkPVPythonModule::HasModule ( const char *  fullname) [inline, static]

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

Definition at line 77 of file vtkPVPythonModule.h.


Member Data Documentation

char* vtkPVPythonModule::Source [protected]

Definition at line 86 of file vtkPVPythonModule.h.

char* vtkPVPythonModule::FullName [protected]

Definition at line 87 of file vtkPVPythonModule.h.

Definition at line 88 of file vtkPVPythonModule.h.


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