abstract base class for all in situ pipelines. More...

#include <vtkInSituPipeline.h>

Inheritance diagram for vtkInSituPipeline:

[legend]

Collaboration diagram for vtkInSituPipeline:

[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

virtual bool	Initialize ()
	Initialize is called once before the first call to 'Execute'. More...

virtual bool	Execute (int timestep, double time)=0

virtual bool	Results ()

virtual bool	Finalize ()
	Called once before the in situ analysis is finalized. More...

virtual char *	GetName ()
	Name is used to identify individual pipelines. More...

virtual void	SetName (const char *)

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 vtkInSituPipeline *	SafeDownCast (vtkObject *o)

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
	vtkInSituPipeline ()

	~vtkInSituPipeline () 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 &)

Protected Attributes
char *	Name

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

abstract base class for all in situ pipelines.

vtkInSituPipeline is an abstract base-class for all in situ analysis pipelines.

A pipeline has three stages: Initialize, Execute and Finalize.

Initialize is called exactly once before the first call to Execute. If Initialize returns false, the initialization is deemed failed and pipeline is skipped for rest of the execution i.e. either Execute nor Finalize will be called.

Execute is called on each cycle. If the method returns false, then the execution is deemed failed and the Execute method will not be called in subsequent cycles.

If Initialize succeeded, then Finalize is called as the end of the simulation execution. Finalize is called even if Execute returned failure. However, it will not be called if Initialize returned failure too.

See also: vtkInitializationHelper

Definition at line 35 of file vtkInSituPipeline.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkInSituPipeline::Superclass

Definition at line 38 of file vtkInSituPipeline.h.

Constructor & Destructor Documentation

◆ vtkInSituPipeline()

vtkInSituPipeline::vtkInSituPipeline ( )

protected

◆ ~vtkInSituPipeline()

vtkInSituPipeline::~vtkInSituPipeline ( )

overrideprotected

Member Function Documentation

◆ GetClassName()

virtual const char* vtkInSituPipeline::GetClassName ( )

virtual

Reimplemented in vtkInSituPipelineIO, and vtkInSituPipelinePython.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkObjectBase.

Reimplemented in vtkInSituPipelineIO, and vtkInSituPipelinePython.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

Reimplemented in vtkInSituPipelineIO, and vtkInSituPipelinePython.

◆ Initialize()

virtual bool vtkInSituPipeline::Initialize ( void )

inlinevirtual

Initialize is called once before the first call to 'Execute'.

Reimplemented in vtkInSituPipelinePython, and vtkInSituPipelineIO.

Definition at line 44 of file vtkInSituPipeline.h.

◆ Execute()

virtual bool vtkInSituPipeline::Execute	(	int	timestep,
		double	time
	)

pure virtual

Implemented in vtkInSituPipelinePython, and vtkInSituPipelineIO.

◆ Results()

virtual bool vtkInSituPipeline::Results ( )

inlinevirtual

Reimplemented in vtkInSituPipelinePython.

Definition at line 54 of file vtkInSituPipeline.h.

◆ Finalize()

virtual bool vtkInSituPipeline::Finalize ( void )

inlinevirtual

Called once before the in situ analysis is finalized.

Reimplemented in vtkInSituPipelinePython, and vtkInSituPipelineIO.

Definition at line 59 of file vtkInSituPipeline.h.

◆ GetName()

virtual char* vtkInSituPipeline::GetName ( )

virtual

Name is used to identify individual pipelines.

◆ SetName()

virtual void vtkInSituPipeline::SetName ( const char * )

virtual

Member Data Documentation

◆ Name

char* vtkInSituPipeline::Name

protected

Definition at line 71 of file vtkInSituPipeline.h.

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

/builds/gitlab-kitware-sciviz-ci/Clients/InSitu/vtkInSituPipeline.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkInSituPipeline()

◆ ~vtkInSituPipeline()

Member Function Documentation

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ Initialize()

◆ Execute()

◆ Results()

◆ Finalize()

◆ GetName()

◆ SetName()

Member Data Documentation

◆ Name