Generic PXML writer pipeline to write out the full Catalyst input datasets. More...

#include <vtkCPXMLPWriterPipeline.h>

Inheritance diagram for vtkCPXMLPWriterPipeline:

Collaboration diagram for vtkCPXMLPWriterPipeline:

[legend]

Public Types
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

int	RequestDataDescription (vtkCPDataDescription *dataDescription) override
	Configuration Step: The coprocessor first determines if any coprocessing needs to be done at this TimeStep/Time combination returning 1 if it does and 0 otherwise. More...

int	CoProcess (vtkCPDataDescription *dataDescription) override
	Execute the pipeline. Returns 1 for success and 0 for failure. More...

virtual void	SetOutputFrequency (int)
	Set the output frequency for this pipeline. The default is 1. More...

virtual int	GetOutputFrequency ()

virtual void	SetPaddingAmount (int)
	Set the padding amount for the time index portion of the generated files. More...

virtual int	GetPaddingAmount ()

virtual void	SetPath (std::string)
	Set the path to the generated files. More...

virtual std::string	GetPath ()

Public Member Functions inherited from vtkCPPipeline
virtual int	Finalize ()
	Finalize the pipeline before deleting it. 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)

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 vtkCPXMLPWriterPipeline *	New ()

static int	IsTypeOf (const char *type)

static vtkCPXMLPWriterPipeline *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkCPPipeline
static int	IsTypeOf (const char *type)

static vtkCPPipeline *	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
	vtkCPXMLPWriterPipeline ()

	~vtkCPXMLPWriterPipeline () override

Protected Member Functions inherited from vtkCPPipeline
	vtkCPPipeline ()

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

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

Generic PXML writer pipeline to write out the full Catalyst input datasets.

The filename will correspond to the input name/channel identifier with time step and file extension (e.g. "input_0.pvtu" for an unstructured dataset with no padding).

Definition at line 16 of file vtkCPXMLPWriterPipeline.h.

Member Typedef Documentation

◆ Superclass

typedef vtkCPPipeline vtkCPXMLPWriterPipeline::Superclass

Definition at line 20 of file vtkCPXMLPWriterPipeline.h.

Constructor & Destructor Documentation

◆ vtkCPXMLPWriterPipeline()

vtkCPXMLPWriterPipeline::vtkCPXMLPWriterPipeline ( )

protected

◆ ~vtkCPXMLPWriterPipeline()

vtkCPXMLPWriterPipeline::~vtkCPXMLPWriterPipeline ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkCPXMLPWriterPipeline* vtkCPXMLPWriterPipeline::New ( )

static

◆ GetClassName()

virtual const char* vtkCPXMLPWriterPipeline::GetClassName ( )

virtual

Reimplemented from vtkCPPipeline.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkCPPipeline.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkCPPipeline.

◆ RequestDataDescription()

int vtkCPXMLPWriterPipeline::RequestDataDescription ( vtkCPDataDescription * dataDescription )

overridevirtual

Configuration Step: The coprocessor first determines if any coprocessing needs to be done at this TimeStep/Time combination returning 1 if it does and 0 otherwise.

If coprocessing does need to be performed this time step it fills in the FieldNames array that the coprocessor requires in order to fulfill all the coprocessing requests for this TimeStep/Time combination.

Implements vtkCPPipeline.

◆ CoProcess()

int vtkCPXMLPWriterPipeline::CoProcess ( vtkCPDataDescription * dataDescription )

overridevirtual

Execute the pipeline. Returns 1 for success and 0 for failure.

Implements vtkCPPipeline.

◆ SetOutputFrequency()

virtual void vtkCPXMLPWriterPipeline::SetOutputFrequency ( int )

virtual

Set the output frequency for this pipeline. The default is 1.

◆ GetOutputFrequency()

virtual int vtkCPXMLPWriterPipeline::GetOutputFrequency ( )

virtual

◆ SetPaddingAmount()

virtual void vtkCPXMLPWriterPipeline::SetPaddingAmount ( int )

virtual

Set the padding amount for the time index portion of the generated files.

The default is 0.

◆ GetPaddingAmount()

virtual int vtkCPXMLPWriterPipeline::GetPaddingAmount ( )

virtual

◆ SetPath()

virtual void vtkCPXMLPWriterPipeline::SetPath ( std::string )

virtual

Set the path to the generated files.

◆ GetPath()

virtual std::string vtkCPXMLPWriterPipeline::GetPath ( )

virtual

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkCPXMLPWriterPipeline()

◆ ~vtkCPXMLPWriterPipeline()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ RequestDataDescription()

◆ CoProcess()

◆ SetOutputFrequency()

◆ GetOutputFrequency()

◆ SetPaddingAmount()

◆ GetPaddingAmount()

◆ SetPath()

◆ GetPath()