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

vtkCPAdaptorAPI provides the implementation for API exposed to typical adaptor, such as C, Fortran. More...

#include <vtkCPAdaptorAPI.h>

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

Public Types

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

Static Protected Attributes

static vtkCPDataDescriptionCoProcessorData
 
static vtkCPProcessorCoProcessor
 
static bool IsTimeDataSet
 

Detailed Description

vtkCPAdaptorAPI provides the implementation for API exposed to typical adaptor, such as C, Fortran.

Definition at line 27 of file vtkCPAdaptorAPI.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkCPAdaptorAPI::Superclass

Definition at line 30 of file vtkCPAdaptorAPI.h.

Member Function Documentation

◆ GetClassName()

virtual const char* vtkCPAdaptorAPI::GetClassName ( )
virtual

Reimplemented in vtkCPPythonAdaptorAPI.

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented in vtkCPPythonAdaptorAPI.

◆ SafeDownCast()

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

◆ CoProcessorInitialize()

static void vtkCPAdaptorAPI::CoProcessorInitialize ( )
static

call at the start of the simulation

◆ CoProcessorFinalize()

static void vtkCPAdaptorAPI::CoProcessorFinalize ( )
static

call at the end of the simulation

◆ RequestDataDescription()

static void vtkCPAdaptorAPI::RequestDataDescription ( int *  timeStep,
double *  time,
int *  coprocessThisTimeStep 
)
static

this is the function that determines whether or not there is anything to coprocess this time step

◆ NeedToCreateGrid()

static void vtkCPAdaptorAPI::NeedToCreateGrid ( int *  needGrid)
static

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

◆ CoProcess()

static void vtkCPAdaptorAPI::CoProcess ( )
static

do the actual coprocessing.

it is assumed that the vtkCPDataDescription has been filled in elsewhere.

◆ GetCoProcessorData()

static vtkCPDataDescription* vtkCPAdaptorAPI::GetCoProcessorData ( )
inlinestatic

provides access to the vtkCPDataDescription instance.

Definition at line 52 of file vtkCPAdaptorAPI.h.

◆ GetCoProcessor()

static vtkCPProcessor* vtkCPAdaptorAPI::GetCoProcessor ( )
inlinestatic

provides access to the vtkCPProcessor instance.

Definition at line 55 of file vtkCPAdaptorAPI.h.

Member Data Documentation

◆ CoProcessorData

vtkCPDataDescription* vtkCPAdaptorAPI::CoProcessorData
staticprotected

Definition at line 58 of file vtkCPAdaptorAPI.h.

◆ CoProcessor

vtkCPProcessor* vtkCPAdaptorAPI::CoProcessor
staticprotected

Definition at line 59 of file vtkCPAdaptorAPI.h.

◆ IsTimeDataSet

bool vtkCPAdaptorAPI::IsTimeDataSet
staticprotected

Definition at line 66 of file vtkCPAdaptorAPI.h.


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