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

#include <vtkCPAdaptorAPI.h>

Inheritance diagram for vtkCPAdaptorAPI:

Collaboration diagram for vtkCPAdaptorAPI:

[legend]

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

	vtkCPAdaptorAPI (const vtkCPAdaptorAPI &)=delete

void	operator= (const vtkCPAdaptorAPI &)=delete

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual vtkMTimeType	GetMTime ()

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

Static Public Member Functions
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...

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Protected Member Functions
	vtkCPAdaptorAPI ()

	~vtkCPAdaptorAPI () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Static Protected Attributes
static vtkCPDataDescription *	CoProcessorData

static vtkCPProcessor *	CoProcessor

static bool	IsTimeDataSet

Additional Inherited Members
Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

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

Definition at line 15 of file vtkCPAdaptorAPI.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkCPAdaptorAPI::Superclass

Definition at line 18 of file vtkCPAdaptorAPI.h.

Constructor & Destructor Documentation

◆ vtkCPAdaptorAPI() [1/2]

vtkCPAdaptorAPI::vtkCPAdaptorAPI ( const vtkCPAdaptorAPI & )

delete

◆ vtkCPAdaptorAPI() [2/2]

vtkCPAdaptorAPI::vtkCPAdaptorAPI ( )

protected

◆ ~vtkCPAdaptorAPI()

vtkCPAdaptorAPI::~vtkCPAdaptorAPI ( )

overrideprotected

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

Reimplemented in vtkCPPythonAdaptorAPI.

◆ SafeDownCast()

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

static

◆ PrintSelf()

void vtkCPAdaptorAPI::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

Reimplemented from vtkObject.

Reimplemented in vtkCPPythonAdaptorAPI.

◆ 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 41 of file vtkCPAdaptorAPI.h.

◆ GetCoProcessor()

static vtkCPProcessor* vtkCPAdaptorAPI::GetCoProcessor ( )

inlinestatic

provides access to the vtkCPProcessor instance.

Definition at line 44 of file vtkCPAdaptorAPI.h.

◆ operator=()

void vtkCPAdaptorAPI::operator= ( const vtkCPAdaptorAPI & )

delete

Member Data Documentation

◆ CoProcessorData

vtkCPDataDescription* vtkCPAdaptorAPI::CoProcessorData

staticprotected

Definition at line 53 of file vtkCPAdaptorAPI.h.

◆ CoProcessor

vtkCPProcessor* vtkCPAdaptorAPI::CoProcessor

staticprotected

Definition at line 54 of file vtkCPAdaptorAPI.h.

◆ IsTimeDataSet

bool vtkCPAdaptorAPI::IsTimeDataSet

staticprotected

Definition at line 61 of file vtkCPAdaptorAPI.h.

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

/builds/gitlab-kitware-sciviz-ci/Clients/Catalyst/vtkCPAdaptorAPI.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkCPAdaptorAPI() [1/2]

◆ vtkCPAdaptorAPI() [2/2]

◆ ~vtkCPAdaptorAPI()

Member Function Documentation

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ CoProcessorInitialize()

◆ CoProcessorFinalize()

◆ RequestDataDescription()

◆ NeedToCreateGrid()

◆ CoProcess()

◆ GetCoProcessorData()

◆ GetCoProcessor()

◆ operator=()

Member Data Documentation

◆ CoProcessorData

◆ CoProcessor

◆ IsTimeDataSet