vtkAbstractParticleWriter Class Reference

#include <vtkAbstractParticleWriter.h>

Inheritance diagram for vtkAbstractParticleWriter:

[legend]

Collaboration diagram for vtkAbstractParticleWriter:

[legend]

List of all members.

---

Detailed Description

abstract class to write particle data to file

vtkAbstractParticleWriter is an abstract class which is used by vtkTemporalStreamTracer to write particles out during simulations. This class is abstract and provides a TimeStep and FileName. Subclasses of this should provide the necessary IO.

Warning:

See vtkWriter

See also:

vtkTemporalStreamTracer

Definition at line 35 of file vtkAbstractParticleWriter.h.

Public Types
typedef vtkWriter	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	CloseFile ()=0
virtual void	SetTimeStep (int)
virtual int	GetTimeStep ()
virtual void	SetTimeValue (double)
virtual double	GetTimeValue ()
virtual void	SetFileName (const char *)
virtual char *	GetFileName ()
virtual void	SetCollectiveIO (int)
virtual int	GetCollectiveIO ()
void	SetWriteModeToCollective ()
void	SetWriteModeToIndependent ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkAbstractParticleWriter *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkAbstractParticleWriter ()
	~vtkAbstractParticleWriter ()
virtual void	WriteData ()=0
Protected Attributes
int	CollectiveIO
int	TimeStep
double	TimeValue
char *	FileName

---

Member Typedef Documentation

typedef vtkWriter vtkAbstractParticleWriter::Superclass

Reimplemented from vtkWriter.

Definition at line 38 of file vtkAbstractParticleWriter.h.

---

Constructor & Destructor Documentation

vtkAbstractParticleWriter::vtkAbstractParticleWriter

(

)

[protected]

vtkAbstractParticleWriter::~vtkAbstractParticleWriter

(

)

[protected]

---

Member Function Documentation

virtual const char* vtkAbstractParticleWriter::GetClassName

(

)

[virtual]

Reimplemented from vtkWriter.

static int vtkAbstractParticleWriter::IsTypeOf

(

const char *

name

)

[static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkWriter.

virtual int vtkAbstractParticleWriter::IsA

(

const char *

name

)

[virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkWriter.

static vtkAbstractParticleWriter* vtkAbstractParticleWriter::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkWriter.

void vtkAbstractParticleWriter::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			[virtual]

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkWriter.

virtual void vtkAbstractParticleWriter::SetTimeStep

(

int

)

[virtual]

Set/get the TimeStep that is being written

virtual int vtkAbstractParticleWriter::GetTimeStep

(

)

[virtual]

Set/get the TimeStep that is being written

virtual void vtkAbstractParticleWriter::SetTimeValue

(

double

)

[virtual]

Before writing the current data out, set the TimeValue (optional) The TimeValue is a float/double value that corresonds to the real time of the data, it may not be regular, whereas the TimeSteps are simple increments.

virtual double vtkAbstractParticleWriter::GetTimeValue

(

)

[virtual]

Before writing the current data out, set the TimeValue (optional) The TimeValue is a float/double value that corresonds to the real time of the data, it may not be regular, whereas the TimeSteps are simple increments.

virtual void vtkAbstractParticleWriter::SetFileName

(

const char *

)

[virtual]

Set/get the FileName that is being written to

virtual char* vtkAbstractParticleWriter::GetFileName

(

)

[virtual]

Set/get the FileName that is being written to

virtual void vtkAbstractParticleWriter::SetCollectiveIO

(

int

)

[virtual]

When running in parallel, this writer may be capable of Collective IO operations (HDF5). By default, this is off.

virtual int vtkAbstractParticleWriter::GetCollectiveIO

(

)

[virtual]

When running in parallel, this writer may be capable of Collective IO operations (HDF5). By default, this is off.

void vtkAbstractParticleWriter::SetWriteModeToCollective

(

)

When running in parallel, this writer may be capable of Collective IO operations (HDF5). By default, this is off.

void vtkAbstractParticleWriter::SetWriteModeToIndependent

(

)

When running in parallel, this writer may be capable of Collective IO operations (HDF5). By default, this is off.

virtual void vtkAbstractParticleWriter::CloseFile

(

)

[pure virtual]

Close the file after a write. This is optional but may protect against data loss in between steps

virtual void vtkAbstractParticleWriter::WriteData

(

)

[protected, pure virtual]

Implements vtkWriter.

---

Member Data Documentation

int vtkAbstractParticleWriter::CollectiveIO [protected]

Definition at line 80 of file vtkAbstractParticleWriter.h.

int vtkAbstractParticleWriter::TimeStep [protected]

Definition at line 81 of file vtkAbstractParticleWriter.h.

double vtkAbstractParticleWriter::TimeValue [protected]

Definition at line 82 of file vtkAbstractParticleWriter.h.

char* vtkAbstractParticleWriter::FileName [protected]

Definition at line 83 of file vtkAbstractParticleWriter.h.

---

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

• dox/IO/vtkAbstractParticleWriter.h