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:

Collaboration diagram for vtkCPPythonAdaptorAPI:

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 vtkCPPythonAdaptorAPI *	SafeDownCast (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 vtkCPAdaptorAPI *	SafeDownCast (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 vtkCPDataDescription *	GetCoProcessorData ()
	provides access to the vtkCPDataDescription instance. More...
static vtkCPProcessor *	GetCoProcessor ()
	provides access to the vtkCPProcessor instance. More...

Protected Member Functions
	vtkCPPythonAdaptorAPI ()
	~vtkCPPythonAdaptorAPI ()

Additional Inherited Members
Static Protected Attributes inherited from vtkCPAdaptorAPI
static vtkCPDataDescription *	CoProcessorData
static vtkCPProcessor *	CoProcessor
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

typedef vtkCPAdaptorAPI vtkCPPythonAdaptorAPI::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:

• /builddir/build/BUILD/ParaView-v5.2.0/CoProcessing/PythonCatalyst/vtkCPPythonAdaptorAPI.h