vtkXMLPVDWriter Class Reference

Data writer for ParaView. More...

#include <vtkXMLPVDWriter.h>

Inheritance diagram for vtkXMLPVDWriter:

Public Types
typedef vtkXMLWriter	Superclass

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual const char *	GetDefaultFileExtension ()
	Get the default file extension for files written by this writer. More...
void	AddInputData (vtkDataObject *)
	Add an input of this algorithm. More...
int	ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int	GetPiece ()
	Get/Set the piece number to write. More...
virtual void	SetPiece (int)
	Get/Set the piece number to write. More...
virtual int	GetNumberOfPieces ()
	Get/Set the number of pieces into which the inputs are split. More...
virtual void	SetNumberOfPieces (int)
	Get/Set the number of pieces into which the inputs are split. More...
virtual int	GetGhostLevel ()
	Get/Set the number of ghost levels to be written for unstructured data. More...
virtual void	SetGhostLevel (int)
	Get/Set the number of ghost levels to be written for unstructured data. More...
virtual int	GetWriteCollectionFile ()
	Get/Set whether this instance will write the main collection file. More...
virtual void	SetWriteCollectionFile (int flag)
	Get/Set whether this instance will write the main collection file. More...

Static Public Member Functions
static vtkXMLPVDWriter *	New ()
static int	IsTypeOf (const char *type)
static vtkXMLPVDWriter *	SafeDownCast (vtkObject *o)

Protected Member Functions
	vtkXMLPVDWriter ()
	~vtkXMLPVDWriter ()
virtual int	FillInputPortInformation (int port, vtkInformation *info)
int	RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int	WriteData ()
virtual const char *	GetDataSetName ()
void	CreateWriters ()
vtkXMLWriter *	GetWriter (int index)
void	SplitFileName ()
const char *	GetFilePrefix ()
const char *	GetFilePath ()
void	AppendEntry (const char *entry)
void	DeleteAllEntries ()
int	WriteCollectionFileIfRequested ()
void	MakeDirectory (const char *name)
void	RemoveADirectory (const char *name)
virtual void	ProgressCallback (vtkAlgorithm *w)
virtual void	ReportReferences (vtkGarbageCollector *)

Static Protected Member Functions
static void	ProgressCallbackFunction (vtkObject *, unsigned long, void *, void *)

Protected Attributes
vtkXMLPVDWriterInternals *	Internal
int	Piece
int	NumberOfPieces
int	GhostLevel
int	WriteCollectionFile
int	WriteCollectionFileInitialized
vtkCallbackCommand *	ProgressObserver

Detailed Description

Data writer for ParaView.

vtkXMLPVDWriter is used to save all parts of a current source to a file with pieces spread across ther server processes.

Definition at line 32 of file vtkXMLPVDWriter.h.

Member Typedef Documentation

Superclass

typedef vtkXMLWriter vtkXMLPVDWriter::Superclass

Definition at line 36 of file vtkXMLPVDWriter.h.

Constructor & Destructor Documentation

vtkXMLPVDWriter()

vtkXMLPVDWriter::vtkXMLPVDWriter ( )

protected

~vtkXMLPVDWriter()

vtkXMLPVDWriter::~vtkXMLPVDWriter ( )

protected

Member Function Documentation

New()

static vtkXMLPVDWriter* vtkXMLPVDWriter::New ( )

static

GetClassName()

virtual const char* vtkXMLPVDWriter::GetClassName ( )

virtual

Reimplemented in vtkXMLPVAnimationWriter.

IsTypeOf()

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

static

IsA()

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

virtual

Reimplemented in vtkXMLPVAnimationWriter.

SafeDownCast()

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

static

PrintSelf()

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

GetDefaultFileExtension()

virtual const char* vtkXMLPVDWriter::GetDefaultFileExtension ( )

virtual

Get the default file extension for files written by this writer.

GetPiece()

virtual int vtkXMLPVDWriter::GetPiece ( )

virtual

Get/Set the piece number to write.

The same piece number is used for all inputs.

SetPiece()

virtual void vtkXMLPVDWriter::SetPiece ( int  )

virtual

Get/Set the piece number to write.

The same piece number is used for all inputs.

GetNumberOfPieces()

virtual int vtkXMLPVDWriter::GetNumberOfPieces ( )

virtual

Get/Set the number of pieces into which the inputs are split.

SetNumberOfPieces()

virtual void vtkXMLPVDWriter::SetNumberOfPieces ( int  )

virtual

Get/Set the number of pieces into which the inputs are split.

GetGhostLevel()

virtual int vtkXMLPVDWriter::GetGhostLevel ( )

virtual

Get/Set the number of ghost levels to be written for unstructured data.

SetGhostLevel()

virtual void vtkXMLPVDWriter::SetGhostLevel ( int  )

virtual

Get/Set the number of ghost levels to be written for unstructured data.

AddInputData()

void vtkXMLPVDWriter::AddInputData

(

vtkDataObject *

)

Add an input of this algorithm.

GetWriteCollectionFile()

virtual int vtkXMLPVDWriter::GetWriteCollectionFile ( )

virtual

Get/Set whether this instance will write the main collection file.

SetWriteCollectionFile()

virtual void vtkXMLPVDWriter::SetWriteCollectionFile ( int  flag )

virtual

Get/Set whether this instance will write the main collection file.

ProcessRequest()

int vtkXMLPVDWriter::ProcessRequest	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)

FillInputPortInformation()

virtual int vtkXMLPVDWriter::FillInputPortInformation ( int  port, vtkInformation *  info  )

protectedvirtual

RequestData()

int vtkXMLPVDWriter::RequestData ( vtkInformation *  , vtkInformationVector **  , vtkInformationVector *    )

protected

WriteData()

virtual int vtkXMLPVDWriter::WriteData ( )

protectedvirtual

GetDataSetName()

virtual const char* vtkXMLPVDWriter::GetDataSetName ( )

protectedvirtual

CreateWriters()

void vtkXMLPVDWriter::CreateWriters ( )

protected

GetWriter()

vtkXMLWriter* vtkXMLPVDWriter::GetWriter ( int  index )

protected

SplitFileName()

void vtkXMLPVDWriter::SplitFileName ( )

protected

GetFilePrefix()

const char* vtkXMLPVDWriter::GetFilePrefix ( )

protected

GetFilePath()

const char* vtkXMLPVDWriter::GetFilePath ( )

protected

AppendEntry()

void vtkXMLPVDWriter::AppendEntry ( const char *  entry )

protected

DeleteAllEntries()

void vtkXMLPVDWriter::DeleteAllEntries ( )

protected

WriteCollectionFileIfRequested()

int vtkXMLPVDWriter::WriteCollectionFileIfRequested ( )

protected

MakeDirectory()

void vtkXMLPVDWriter::MakeDirectory ( const char *  name )

protected

RemoveADirectory()

void vtkXMLPVDWriter::RemoveADirectory ( const char *  name )

protected

ProgressCallbackFunction()

static void vtkXMLPVDWriter::ProgressCallbackFunction ( vtkObject *  , unsigned  long, void *  , void *    )

staticprotected

ProgressCallback()

virtual void vtkXMLPVDWriter::ProgressCallback ( vtkAlgorithm *  w )

protectedvirtual

ReportReferences()

virtual void vtkXMLPVDWriter::ReportReferences ( vtkGarbageCollector *  )

protectedvirtual

Member Data Documentation

Internal

vtkXMLPVDWriterInternals* vtkXMLPVDWriter::Internal

protected

Definition at line 122 of file vtkXMLPVDWriter.h.

Piece

int vtkXMLPVDWriter::Piece

protected

Definition at line 125 of file vtkXMLPVDWriter.h.

NumberOfPieces

int vtkXMLPVDWriter::NumberOfPieces

protected

Definition at line 128 of file vtkXMLPVDWriter.h.

GhostLevel

int vtkXMLPVDWriter::GhostLevel

protected

Definition at line 131 of file vtkXMLPVDWriter.h.

WriteCollectionFile

int vtkXMLPVDWriter::WriteCollectionFile

protected

Definition at line 134 of file vtkXMLPVDWriter.h.

WriteCollectionFileInitialized

int vtkXMLPVDWriter::WriteCollectionFileInitialized

protected

Definition at line 135 of file vtkXMLPVDWriter.h.

ProgressObserver

vtkCallbackCommand* vtkXMLPVDWriter::ProgressObserver

protected

Definition at line 143 of file vtkXMLPVDWriter.h.

---

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

• /builddir/build/BUILD/ParaView-v5.2.0/ParaViewCore/VTKExtensions/Default/vtkXMLPVDWriter.h