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

vtkCPPipeline for Catalyst Python script / package version 2.0 More...

#include <vtkCPPythonScriptV2Pipeline.h>

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

Public Types

typedef vtkCPPythonPipeline Superclass
 
- Public Types inherited from vtkCPPythonPipeline
typedef vtkCPPipeline Superclass
 
- Public Types inherited from vtkCPPipeline
typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
bool Initialize (const char *filename)
 Initialize from a zip archive. More...
 
int RequestDataDescription (vtkCPDataDescription *dataDescription) override
 Implementation for vtkCPPipeline API. More...
 
int CoProcess (vtkCPDataDescription *dataDescription) override
 Implementation for vtkCPPipeline API. More...
 
int Finalize () override
 Implementation for vtkCPPipeline API. More...
 
- 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)
 
vtkCommandGetCommand (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)
 
vtkCommandGetCommand (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 vtkCPPythonScriptV2PipelineNew ()
 
static int IsTypeOf (const char *type)
 
static vtkCPPythonScriptV2PipelineSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkCPPythonPipeline
static int IsTypeOf (const char *type)
 
static vtkCPPythonPipelineSafeDownCast (vtkObject *o)
 
static int DetectScriptVersion (const char *fname)
 Starting with ParaView 5.9, there are two versions of Python scripts that ParaView supports. More...
 
static vtkSmartPointer< vtkCPPythonPipelineCreatePipeline (const char *fname, int default_version=1)
 Detects the script version, if possible and created appropriate subclass. More...
 
static vtkSmartPointer< vtkCPPythonPipelineCreateAndInitializePipeline (const char *fname, int default_version=1)
 Same as CreatePipeline, except that if the pipeline instance is successfully created also calls appropriate Initialize method on it. More...
 
static VTK_NEWINSTANCE vtkCPPythonPipelineNewPipeline (const char *fname, int default_version=1)
 These overloads are provided for Python wrapping since vtkSmartPointer doesn't seem to be wrapped correctly. More...
 
static VTK_NEWINSTANCE vtkCPPythonPipelineNewAndInitializePipeline (const char *fname, int default_version=1)
 These overloads are provided for Python wrapping since vtkSmartPointer doesn't seem to be wrapped correctly. More...
 
- Static Public Member Functions inherited from vtkCPPipeline
static int IsTypeOf (const char *type)
 
static vtkCPPipelineSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 
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 vtkObjectBaseNew ()
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkCPPythonScriptV2Pipeline ()
 
 ~vtkCPPythonScriptV2Pipeline ()
 
- Protected Member Functions inherited from vtkCPPythonPipeline
void FixEOL (std::string &)
 For things like programmable filters that have a '
' in their strings, we need to fix them to have \n so that everything works smoothly. More...
 
std::string GetPythonAddress (void *pointer)
 Return the address of Pointer for the python script. More...
 
 vtkCPPythonPipeline ()
 
 ~vtkCPPythonPipeline () override
 
- Protected Member Functions inherited from vtkCPPipeline
 vtkCPPipeline ()
 
virtual ~vtkCPPipeline ()
 
- 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 &)
 

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

vtkCPPipeline for Catalyst Python script / package version 2.0

vtkCPPythonScriptV2Pipeline is intended to use with ParaView Python scripts introduced in ParaView version 5.9. These Python scripts typically use extract generators to define the extracts to be generated. This class is used to use such packages in Catalyst.

For details on the supported Python scripts and how to use them to write in situ analysis, refer to 'Anatomy of Catalyst Python Module (Version 2.0)'.

Definition at line 38 of file vtkCPPythonScriptV2Pipeline.h.

Member Typedef Documentation

◆ Superclass

Definition at line 42 of file vtkCPPythonScriptV2Pipeline.h.

Constructor & Destructor Documentation

◆ vtkCPPythonScriptV2Pipeline()

vtkCPPythonScriptV2Pipeline::vtkCPPythonScriptV2Pipeline ( )
protected

◆ ~vtkCPPythonScriptV2Pipeline()

vtkCPPythonScriptV2Pipeline::~vtkCPPythonScriptV2Pipeline ( )
protected

Member Function Documentation

◆ New()

static vtkCPPythonScriptV2Pipeline* vtkCPPythonScriptV2Pipeline::New ( )
static

◆ GetClassName()

virtual const char* vtkCPPythonScriptV2Pipeline::GetClassName ( )
virtual

Reimplemented from vtkCPPythonPipeline.

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkCPPythonPipeline.

◆ SafeDownCast()

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

◆ PrintSelf()

void vtkCPPythonScriptV2Pipeline::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Reimplemented from vtkCPPipeline.

◆ Initialize()

bool vtkCPPythonScriptV2Pipeline::Initialize ( const char *  filename)

Initialize from a zip archive.

If the packagename is not specified, then the it is assumed to be the same as the filename for the zip archive without the extension.

For HPC use-cases, this is the preferred approach since we ensure that only the root node makes disk access thus avoid thrashing the IO subsystem and improving load times.

◆ RequestDataDescription()

int vtkCPPythonScriptV2Pipeline::RequestDataDescription ( vtkCPDataDescription dataDescription)
overridevirtual

Implementation for vtkCPPipeline API.

Implements vtkCPPipeline.

◆ CoProcess()

int vtkCPPythonScriptV2Pipeline::CoProcess ( vtkCPDataDescription dataDescription)
overridevirtual

Implementation for vtkCPPipeline API.

Implements vtkCPPipeline.

◆ Finalize()

int vtkCPPythonScriptV2Pipeline::Finalize ( )
overridevirtual

Implementation for vtkCPPipeline API.

Reimplemented from vtkCPPipeline.


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