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

initialization helper for in situ environments. More...

#include <vtkInSituInitializationHelper.h>

Inheritance diagram for vtkInSituInitializationHelper:
Inheritance graph
[legend]
Collaboration diagram for vtkInSituInitializationHelper:
Collaboration graph
[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
 
- 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 int IsTypeOf (const char *type)
 
static vtkInSituInitializationHelperSafeDownCast (vtkObject *o)
 
static void Initialize (vtkTypeUInt64 comm)
 Initializes the engine. More...
 
static void Finalize ()
 Finalizes the engine. More...
 
static void AddPipeline (const std::string &path)
 Add Python analysis scripts or packages. More...
 
static void AddPipeline (vtkInSituPipeline *pipeline)
 Add a vtkInSituPipeline instance. More...
 
static void SetProducer (const std::string &channelName, vtkSMSourceProxy *producer)
 Specify the algorithm or data-producer proxy that produces the mesh for named catalyst channel. More...
 
static vtkSMSourceProxyGetProducer (const std::string &channelName)
 Provides access to the producer proxy for a given channel, if any. More...
 
static void UpdateAllProducers (double time)
 Convenience method to call Update/UpdatePipeline on all known producers. More...
 
static bool ExecutePipelines (int timestep, double time)
 Executes pipelines. More...
 
static bool IsInitialized ()
 Returns true if vtkInSituInitializationHelper has been initialized; which means that ParaView is operating in in situ mode. More...
 
static bool IsPythonSupported ()
 Returns true if ParaView is built with Python support enabled. More...
 
static void MarkProducerModified (const std::string &channelName)
 This is provided as a convenience to indicate a particular producer has been modified or has new data for current timestep. More...
 
static void MarkProducerModified (vtkSMSourceProxy *producer)
 This is provided as a convenience to indicate a particular producer has been modified or has new data for current timestep. More...
 
static int GetTimeStep ()
 Provides access to current time and timestep during ExecutePipelines call. More...
 
static double GetTime ()
 Provides access to current time and timestep during ExecutePipelines call. More...
 
- 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

 vtkInSituInitializationHelper ()
 
 ~vtkInSituInitializationHelper ()
 
- 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

initialization helper for in situ environments.

vtkInSituInitializationHelper used by ParaView-Catalyst to initialize the ParaView engine. It simply setups up defaults for suitable for in situ use-cases. Internally, it relies on vtkInitializationHelper to do the actual initialization.

vtkInSituInitializationHelper is also intended to be used by other in situ codes includes custom Catalyst API implementations or other in situ frameworks.

See also
vtkInitializationHelper

Definition at line 55 of file vtkInSituInitializationHelper.h.

Member Typedef Documentation

◆ Superclass

Definition at line 58 of file vtkInSituInitializationHelper.h.

Constructor & Destructor Documentation

◆ vtkInSituInitializationHelper()

vtkInSituInitializationHelper::vtkInSituInitializationHelper ( )
protected

◆ ~vtkInSituInitializationHelper()

vtkInSituInitializationHelper::~vtkInSituInitializationHelper ( )
protected

Member Function Documentation

◆ GetClassName()

virtual const char* vtkInSituInitializationHelper::GetClassName ( )
virtual

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

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

◆ PrintSelf()

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

Reimplemented from vtkObject.

◆ Initialize()

static void vtkInSituInitializationHelper::Initialize ( vtkTypeUInt64  comm)
static

Initializes the engine.

This can only be called once in the lifetime of the process. Calling this after the first call has no effect.

'comm' is used to determine the 'MPI_Comm' handle to be used for ParaView. In non-MPI builds of ParaView, this argument is simply ignored. In MPI-enabled builds of ParaView, this argument must be 'MPI_Fint' that represents the Fortran handle for MPI_Comm to use. The Fortran handle is an integer and hence we use 'vtkTypeUInt64' as a wide-enough container for the Fortran handle without having to include 'mpi.h' in this public header. The Fortran MPI communicator handle can be obtained from a MPI_Comm using MPI_Comm_c2f(). Refer to MPI specification for details.

◆ Finalize()

static void vtkInSituInitializationHelper::Finalize ( )
static

Finalizes the engine.

This can be called only once in the lifetime of the progress, and that too only after Initialize has been called.

◆ AddPipeline() [1/2]

static void vtkInSituInitializationHelper::AddPipeline ( const std::string path)
static

Add Python analysis scripts or packages.

This should be called after Initialize but before Finalize to add analysis pipelines. The path can point to a Python script, a directory containing a Python package or a zip-file which containing a Python package.

◆ AddPipeline() [2/2]

static void vtkInSituInitializationHelper::AddPipeline ( vtkInSituPipeline pipeline)
static

Add a vtkInSituPipeline instance.

◆ SetProducer()

static void vtkInSituInitializationHelper::SetProducer ( const std::string channelName,
vtkSMSourceProxy producer 
)
static

Specify the algorithm or data-producer proxy that produces the mesh for named catalyst channel.

This cannot be changed once specified.

On success, this registers the producer with the session proxy manager using the same name as the channelName.

◆ GetProducer()

static vtkSMSourceProxy* vtkInSituInitializationHelper::GetProducer ( const std::string channelName)
static

Provides access to the producer proxy for a given channel, if any.

◆ UpdateAllProducers()

static void vtkInSituInitializationHelper::UpdateAllProducers ( double  time)
static

Convenience method to call Update/UpdatePipeline on all known producers.

◆ MarkProducerModified() [1/2]

static void vtkInSituInitializationHelper::MarkProducerModified ( const std::string channelName)
static

This is provided as a convenience to indicate a particular producer has been modified or has new data for current timestep.

◆ MarkProducerModified() [2/2]

static void vtkInSituInitializationHelper::MarkProducerModified ( vtkSMSourceProxy producer)
static

This is provided as a convenience to indicate a particular producer has been modified or has new data for current timestep.

◆ ExecutePipelines()

static bool vtkInSituInitializationHelper::ExecutePipelines ( int  timestep,
double  time 
)
static

Executes pipelines.

◆ GetTimeStep()

static int vtkInSituInitializationHelper::GetTimeStep ( )
static

Provides access to current time and timestep during ExecutePipelines call.

The value is not valid outside ExecutePipelines.

◆ GetTime()

static double vtkInSituInitializationHelper::GetTime ( )
static

Provides access to current time and timestep during ExecutePipelines call.

The value is not valid outside ExecutePipelines.

◆ IsInitialized()

static bool vtkInSituInitializationHelper::IsInitialized ( )
inlinestatic

Returns true if vtkInSituInitializationHelper has been initialized; which means that ParaView is operating in in situ mode.

Definition at line 141 of file vtkInSituInitializationHelper.h.

◆ IsPythonSupported()

static bool vtkInSituInitializationHelper::IsPythonSupported ( )
static

Returns true if ParaView is built with Python support enabled.


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