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

Similar to vtkCPAdaptorAPI provides the implementation for API exposed to typical adaptor, such as C, Fortran, except that is adds the ability to initialize the coprocessor with Python capabilities. More...

#include <vtkCPPythonAdaptorAPI.h>

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

Public Types

typedef vtkCPAdaptorAPI Superclass
 
- Public Types inherited from vtkCPAdaptorAPI
typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkCPPythonAdaptorAPISafeDownCast (vtkObject *o)
 
static void CoProcessorInitialize (const char *pythonFileName)
 Call at the start of the simulation. More...
 
- Static Public Member Functions inherited from vtkCPAdaptorAPI
static int IsTypeOf (const char *type)
 
static vtkCPAdaptorAPISafeDownCast (vtkObject *o)
 
static void CoProcessorInitialize ()
 call at the start of the simulation More...
 
static void CoProcessorFinalize ()
 call at the end of the simulation More...
 
static void RequestDataDescription (int *timeStep, double *time, int *coprocessThisTimeStep)
 this is the function that determines whether or not there is anything to coprocess this time step More...
 
static void NeedToCreateGrid (int *needGrid)
 this function sets needgrid to 1 if it does not have a copy of the grid it sets needgrid to 0 if it does have a copy of the grid but does not check if the grid is modified or needs to be updated More...
 
static void CoProcess ()
 do the actual coprocessing. More...
 
static vtkCPDataDescriptionGetCoProcessorData ()
 provides access to the vtkCPDataDescription instance. More...
 
static vtkCPProcessorGetCoProcessor ()
 provides access to the vtkCPProcessor instance. More...
 

Protected Member Functions

 vtkCPPythonAdaptorAPI ()
 
 ~vtkCPPythonAdaptorAPI ()
 

Additional Inherited Members

- Static Protected Attributes inherited from vtkCPAdaptorAPI
static vtkCPDataDescriptionCoProcessorData
 
static vtkCPProcessorCoProcessor
 
static bool IsTimeDataSet
 

Detailed Description

Similar to vtkCPAdaptorAPI provides the implementation for API exposed to typical adaptor, such as C, Fortran, except that is adds the ability to initialize the coprocessor with Python capabilities.

Definition at line 24 of file vtkCPPythonAdaptorAPI.h.

Member Typedef Documentation

◆ Superclass

Definition at line 27 of file vtkCPPythonAdaptorAPI.h.

Constructor & Destructor Documentation

◆ vtkCPPythonAdaptorAPI()

vtkCPPythonAdaptorAPI::vtkCPPythonAdaptorAPI ( )
protected

◆ ~vtkCPPythonAdaptorAPI()

vtkCPPythonAdaptorAPI::~vtkCPPythonAdaptorAPI ( )
protected

Member Function Documentation

◆ GetClassName()

virtual const char* vtkCPPythonAdaptorAPI::GetClassName ( )
virtual

Reimplemented from vtkCPAdaptorAPI.

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkCPAdaptorAPI.

◆ SafeDownCast()

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

◆ CoProcessorInitialize()

static void vtkCPPythonAdaptorAPI::CoProcessorInitialize ( const char *  pythonFileName)
static

Call at the start of the simulation.

Users can still call CoProcessorInitialize() without arguments, in which case Python interpretor will not be initialized and hence unavailable.


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