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

parallel meta-writer for serial formats More...

#include <vtkParallelSerialWriter.h>

Inherits vtkDataObjectAlgorithm.

Public Types

typedef vtkDataObjectAlgorithm Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual vtkMTimeType GetMTime ()
 Return the MTime also considering the internal writer. More...
 
int Write ()
 Invoke the writer. More...
 
void SetInterpreter (vtkClientServerInterpreter *interp)
 Get/Set the interpreter to use to call methods on the writer. More...
 
void SetWriter (vtkAlgorithm *)
 Set/get the internal writer. More...
 
virtual vtkAlgorithm * GetWriter ()
 Set/get the internal writer. More...
 
virtual void SetFileNameMethod (const char *)
 Name of the method used to set the file name of the internal writer. More...
 
virtual char * GetFileNameMethod ()
 Name of the method used to set the file name of the internal writer. More...
 
virtual void SetFileName (const char *)
 Get/Set the name of the output file. More...
 
virtual char * GetFileName ()
 Get/Set the name of the output file. More...
 
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. More...
 
virtual void SetGhostLevel (int)
 Get/Set the number of ghost levels to be written. More...
 
void SetPreGatherHelper (vtkAlgorithm *)
 Get/Set the pre-reduction helper. More...
 
virtual vtkAlgorithm * GetPreGatherHelper ()
 Get/Set the pre-reduction helper. More...
 
void SetPostGatherHelper (vtkAlgorithm *)
 Get/Set the reduction helper. More...
 
virtual vtkAlgorithm * GetPostGatherHelper ()
 Get/Set the reduction helper. More...
 
virtual int GetWriteAllTimeSteps ()
 Must be set to true to write all timesteps, otherwise only the current timestep will be written out. More...
 
virtual void SetWriteAllTimeSteps (int)
 Must be set to true to write all timesteps, otherwise only the current timestep will be written out. More...
 
virtual void WriteAllTimeStepsOn ()
 Must be set to true to write all timesteps, otherwise only the current timestep will be written out. More...
 
virtual void WriteAllTimeStepsOff ()
 Must be set to true to write all timesteps, otherwise only the current timestep will be written out. More...
 

Static Public Member Functions

static vtkParallelSerialWriterNew ()
 
static int IsTypeOf (const char *type)
 
static vtkParallelSerialWriterSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkParallelSerialWriter ()
 
 ~vtkParallelSerialWriter ()
 
int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
int RequestUpdateExtent (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 

Detailed Description

parallel meta-writer for serial formats

vtkParallelSerialWriter is a meta-writer that enables serial writers to work in parallel. It gathers data to the 1st node and invokes the internal writer. The reduction is controlled defined by the PreGatherHelper and PostGatherHelper. This also makes it possible to write time-series for temporal datasets using simple non-time-aware writers.

Definition at line 35 of file vtkParallelSerialWriter.h.

Member Typedef Documentation

§ Superclass

typedef vtkDataObjectAlgorithm vtkParallelSerialWriter::Superclass

Definition at line 39 of file vtkParallelSerialWriter.h.

Constructor & Destructor Documentation

§ vtkParallelSerialWriter()

vtkParallelSerialWriter::vtkParallelSerialWriter ( )
protected

§ ~vtkParallelSerialWriter()

vtkParallelSerialWriter::~vtkParallelSerialWriter ( )
protected

Member Function Documentation

§ New()

static vtkParallelSerialWriter* vtkParallelSerialWriter::New ( )
static

§ GetClassName()

virtual const char* vtkParallelSerialWriter::GetClassName ( )
virtual

§ IsTypeOf()

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

§ IsA()

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

§ SafeDownCast()

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

§ PrintSelf()

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

§ SetWriter()

void vtkParallelSerialWriter::SetWriter ( vtkAlgorithm *  )

Set/get the internal writer.

§ GetWriter()

virtual vtkAlgorithm* vtkParallelSerialWriter::GetWriter ( )
virtual

Set/get the internal writer.

§ GetMTime()

virtual vtkMTimeType vtkParallelSerialWriter::GetMTime ( )
virtual

Return the MTime also considering the internal writer.

§ SetFileNameMethod()

virtual void vtkParallelSerialWriter::SetFileNameMethod ( const char *  )
virtual

Name of the method used to set the file name of the internal writer.

By default, this is SetFileName.

§ GetFileNameMethod()

virtual char* vtkParallelSerialWriter::GetFileNameMethod ( )
virtual

Name of the method used to set the file name of the internal writer.

By default, this is SetFileName.

§ SetFileName()

virtual void vtkParallelSerialWriter::SetFileName ( const char *  )
virtual

Get/Set the name of the output file.

§ GetFileName()

virtual char* vtkParallelSerialWriter::GetFileName ( )
virtual

Get/Set the name of the output file.

§ Write()

int vtkParallelSerialWriter::Write ( )

Invoke the writer.

Returns 1 for success, 0 for failure.

§ GetPiece()

virtual int vtkParallelSerialWriter::GetPiece ( )
virtual

Get/Set the piece number to write.

The same piece number is used for all inputs.

§ SetPiece()

virtual void vtkParallelSerialWriter::SetPiece ( int  )
virtual

Get/Set the piece number to write.

The same piece number is used for all inputs.

§ GetNumberOfPieces()

virtual int vtkParallelSerialWriter::GetNumberOfPieces ( )
virtual

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

§ SetNumberOfPieces()

virtual void vtkParallelSerialWriter::SetNumberOfPieces ( int  )
virtual

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

§ GetGhostLevel()

virtual int vtkParallelSerialWriter::GetGhostLevel ( )
virtual

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

§ SetGhostLevel()

virtual void vtkParallelSerialWriter::SetGhostLevel ( int  )
virtual

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

§ SetPreGatherHelper()

void vtkParallelSerialWriter::SetPreGatherHelper ( vtkAlgorithm *  )

Get/Set the pre-reduction helper.

Pre-Reduction helper is an algorithm that runs on each node's data before it is sent to the root.

§ GetPreGatherHelper()

virtual vtkAlgorithm* vtkParallelSerialWriter::GetPreGatherHelper ( )
virtual

Get/Set the pre-reduction helper.

Pre-Reduction helper is an algorithm that runs on each node's data before it is sent to the root.

§ SetPostGatherHelper()

void vtkParallelSerialWriter::SetPostGatherHelper ( vtkAlgorithm *  )

Get/Set the reduction helper.

Reduction helper is an algorithm with multiple input connections, that produces a single output as the reduced output. This is run on the root node to produce a result from the gathered results of each node.

§ GetPostGatherHelper()

virtual vtkAlgorithm* vtkParallelSerialWriter::GetPostGatherHelper ( )
virtual

Get/Set the reduction helper.

Reduction helper is an algorithm with multiple input connections, that produces a single output as the reduced output. This is run on the root node to produce a result from the gathered results of each node.

§ GetWriteAllTimeSteps()

virtual int vtkParallelSerialWriter::GetWriteAllTimeSteps ( )
virtual

Must be set to true to write all timesteps, otherwise only the current timestep will be written out.

Off by default.

§ SetWriteAllTimeSteps()

virtual void vtkParallelSerialWriter::SetWriteAllTimeSteps ( int  )
virtual

Must be set to true to write all timesteps, otherwise only the current timestep will be written out.

Off by default.

§ WriteAllTimeStepsOn()

virtual void vtkParallelSerialWriter::WriteAllTimeStepsOn ( )
virtual

Must be set to true to write all timesteps, otherwise only the current timestep will be written out.

Off by default.

§ WriteAllTimeStepsOff()

virtual void vtkParallelSerialWriter::WriteAllTimeStepsOff ( )
virtual

Must be set to true to write all timesteps, otherwise only the current timestep will be written out.

Off by default.

§ SetInterpreter()

void vtkParallelSerialWriter::SetInterpreter ( vtkClientServerInterpreter interp)
inline

Get/Set the interpreter to use to call methods on the writer.

Definition at line 135 of file vtkParallelSerialWriter.h.

§ RequestInformation()

int vtkParallelSerialWriter::RequestInformation ( vtkInformation *  request,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
protected

§ RequestUpdateExtent()

int vtkParallelSerialWriter::RequestUpdateExtent ( vtkInformation *  request,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
protected

§ RequestData()

int vtkParallelSerialWriter::RequestData ( vtkInformation *  request,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
protected

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